Ad Variant
Updated
PaidApiAdVariant Schema
Field Name | Field Type | Description | Supported Update | Change Type |
channelId | String | Identifier for the ad channel | N | |
id | String | Unique identifier for the ad variant | N | |
name | String | Name of the ad variant | Y | NAME |
status | AdVariantStatus Enum | Status of the ad variant ACTIVE, PAUSED, DRAFT | Y | STATUS |
creativeType | String | Type of creative used | Y | CREATIVE |
creativeObject | CreativeObject | The creative associated with the ad | Y | CREATIVE |
viewTags | List<String> | Tags for tracking ad views | Y | VIEW_TAGS |
clickTags | List<String> | Tags for tracking ad clicks | Y | CLICK_TAGS |
CreativeObject Schema
Field Name | Field Type | Description |
name | String | Name of the creative |
creativeId | String | Unique identifier for the creative |
postType | String | Supported Values LINK, PHOTO, VIDEO, STATUS, OFFER, TEMPLATE_DATA, DOCUMENT, TEXT |
isDarkPost | Boolean | Whether it is a dark post |
pageId | String | ID of the associated page |
secondaryPageId | String | ID of the secondary page/Instagram Page |
postChannelId | String | ID of the post channel |
title | String | Title of the creative |
description | String | Description of the creative |
linkUrl | String | URL link in the creative |
linkDescription | String | Description for the link |
displayLink | String | Display link |
appLink | String | Deep Link Url |
imageUrl | String | URL of the image |
videoUrl | String | URL of the video |
callToAction | String | |
leadFormId | String | Lead form ID |
previewPageCount | Integer | Number of preview pages |
sponsoredPageId | String | Sponsored page ID |
instagramSponsoredPageId | String | Instagram-sponsored page ID |
dynamicAdVoice | String | Dynamic ad voice values: DYNAMIC, STORY_OWNER |
destinationObject | ApiDestinationObject | Destination details |
deepLinkDetails | DeepLinkDetails | Deep linking information |
carouselObjects | List<AdChildMedia> | List of carousel media objects |
DeepLinkDetails Schema
Field Name | Field Type | Description |
deepLinkType | DeepLinkType | Type of deep link · ANDROID · WEB · IOS · IPHONE · IPAD · APP · WINDOW |
packageName | String | Android package name |
url | String | Deep link URL |
appName | String | Name of the application |
webUrl | String | Web URL |
webFallBack | String | Fallback URL for web |
appId | String | Application ID |
appStoreId | String | Application store ID |
configAppId | String | Configuration App ID |
ApiDestinationObject Schema
Field Name | Field Type | Description |
type | String | Type of the destination |
url | String | URL of the destination |
storeUrl | String | Store URL if applicable |
appId | String | Application ID if relevant |
AdChildMedia
Field Name | Field Type | Description |
title | String | Card/Media Title |
description | String | Card/Media Description |
linkUrl | String | Card/Media Link URL |
appLink | String | Application-specific link (if applicable) |
imageUrl | String | Card/Media Image URL |
videoUrl | String | Card/Media Video URL. Pass Thumbnail URL in field imageUrl |
callToAction | String | Call-to-action text or identifier |
destinationObject | ApiDestinationObject | Destination object containing navigation details |
Supported CTA
Enum | Label |
WATCH_NOW | Watch Now |
VISIT_SITE | Visit Site |
GO_TO | Go To |
SEE_MORE | See More |
SHOP | Shop |