Skip to main content

Module models

Module models 

Source
Expand description

Domain models for the mkt marketing CLI.

All models are provider-agnostic. Each provider crate contains a mapping module that converts between API-specific representations and these unified models.

Structs§

Ad
A unified ad representation across all providers.
AdId
Opaque ad identifier.
AdSet
A unified ad set representation across all providers.
AdSetId
Opaque ad set identifier.
Audience
A unified audience representation across all providers.
AudienceId
Opaque audience identifier.
AudienceUpdateResult
Result returned after adding or removing users from an audience.
AudienceUser
A single user record for audience membership operations.
Budget
A monetary budget.
Campaign
A unified campaign representation across all providers.
CampaignFilters
Filters for listing campaigns.
CampaignId
Opaque campaign identifier.
CreateAdSetInput
Input for creating a new ad set.
CreateAudienceInput
Input for creating a new audience.
CreateCampaignInput
Input for creating a new campaign.
CreateCreativeInput
Input for creating a new creative.
CreateDarkPostInput
Input for creating a dark post (unpublished page post).
Creative
A unified creative representation across all providers.
CreativeId
Opaque creative identifier.
DateRange
A date range for filtering or reporting.
InsightsQuery
Query parameters for fetching insights.
InsightsReport
A complete insights report returned by a provider.
InsightsRow
A single row in an insights report.
MediaAsset
A unified media asset representation across all providers.
MediaAssetId
Opaque media asset identifier.
MetricValue
A single metric value, optionally with a pre-formatted string.
Paginated
A paginated response wrapper.
Post
A unified post representation across all providers.
PostId
Opaque post identifier.
PromotePostInput
Input for promoting an existing post as a paid ad.
ProviderHealth
Health check result from a provider.
PublishPostInput
Input for publishing a new post.
UpdateCampaignInput
Input for updating an existing campaign.
UploadImageInput
Input for uploading an image asset.
UploadVideoInput
Input for uploading a video asset.

Enums§

AdSetStatus
The lifecycle status of an ad set.
AdStatus
The lifecycle status of an ad.
AudienceType
The classification of an audience.
BudgetKind
The type of budget allocation.
CampaignStatus
The lifecycle status of a campaign.
HttpMethod
HTTP methods for the raw escape hatch.
InsightsLevel
The aggregation level for an insights report.
MediaType
The media format of an asset.