Field Name

Field Type

Description

Update Supported

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 

(Note : Complete creative object need to be passed)

CREATIVE

creativeObject

CreativeObject

The creative associated with the ad

Y 

(Note : Complete creative object need to be passed)

CREATIVE

viewTags

List<String>

Tags for tracking ad views

Y

VIEW_TAGS

clickTags

List<String>

Tags for tracking ad clicks

Y

CLICK_TAGS

trackingPixelChannelIds

List<String>

Tracking pixel channel identifiers

Y

TRACKING_PIXEL

conversionDomain

String

Conversion tracking domain

Y

CONVERSION_DOMAIN

Field Name

Field Type

Description

name

String

Name of the creative

postType

Enum

Supported Values

LINK, PHOTO, VIDEO,TEMPLATE_DATA

isDarkPost

Boolean

Whether it is a dark post

Default true

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

Call to action text

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4798677351/Advariant+Facebook#Call-to-Action

leadFormId

String

Lead form ID

sponsoredPageId

String

Sponsored page ID

instagramSponsoredPageId

String

Instagram-sponsored page ID

dynamicAdVoice

ENUM

Dynamic ad voice values:

DYNAMIC, STORY_OWNER

isStoreVisitCreative

Boolean

Whether it is a store visit creative

destinationObject

ApiDestinationObject

Destination details

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4798677351/Advariant+Facebook#ApiDestinationObject-Schema

deepLinkDetails

DeepLinkDetails

Deep linking information

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4798677351/Advariant+Facebook#DeepLinkDetails-Schema

forceSingleLink

Boolean

Force single link usage

carouselObjects

List<AdChildMedia>

List of carousel media objects

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4798677351/Advariant+Facebook#AdChildMedia 

When creating carousel post

setPostType to LINK.

dynamicObject

DynamicCreativeObject

Dynamic creative object details.


This is Used for creating PAC Ads

adContext

String

Context of the ad

multiAdvertiserAd

Boolean

Multi Advertiser Ad

usePageAsActor

Boolean

Use Page as Actor

appLinkDestination

Enum

DEEPLINK_WITH_WEB_FALLBACK,

DEEPLINK_WITH_APPSTORE_FALLBACK,

AUTOMATIC,

WEB_ONLY

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

Field Name

Field Type

Description

type

Enum

Type of the destination


APP_STORE, CANVAS, MESSENGER, ON_EVENT, PHONE_CALL, WEBSITE, WHATSAPP

url

String

URL of the destination

Destination Types Values

pageWelcomeMessage

String

Welcome message for the page

phoneNumber

String

Contact phone number

storeUrl

String

Store URL if applicable

appId

String

Application ID if relevant

Ad Objective

Post Type

Supported Destination Types

OUTCOME_AWARENESS

LINK

WEBSITE, APP_STORE

PHOTO

(None)

VIDEO

WEBSITE, ON_EVENT, APP_STORE

TEMPLATE_DATA

WEBSITE

OUTCOME_ENGAGEMENT

VIDEO

WEBSITE, APP_STORE

TEMPLATE_DATA

WEBSITE

LINK

WEBSITE, WHATSAPP, APP_STORE, MESSENGER

PHOTO

(None)

OUTCOME_TRAFFIC

LINK

APP_STORE, WEBSITE, WHATSAPP, MESSENGER, ON_EVENT

VIDEO

WEBSITE, APP_STORE, ON_EVENT

TEMPLATE_DATA

WEBSITE

PHOTO

(None)

OUTCOME_APP_PROMOTION

LINK

APP_STORE, WEBSITE

TEMPLATE_DATA

APP_STORE, WEBSITE

VIDEO

APP_STORE

PHOTO

APP_STORE

OUTCOME_SALES

LINK

WEBSITE, APP_STORE, MESSENGER, PHONE_CALL, WHATSAPP

VIDEO

WEBSITE

TEMPLATE_DATA

WEBSITE, ON_EVENT

PHOTO

(None)

OUTCOME_LEADS

LINK

WEBSITE, APP_STORE, CANVAS, MESSENGER

PHOTO

APP_STORE

VIDEO

WEBSITE

TEMPLATE_DATA

WEBSITE

Field Name

Field Type

Description

title

String

Card/Media Title

description

Stri

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

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4798677351/Advariant+Facebook#ApiDestinationObject-Schema

Destination object containing navigation details

isStaticCard

Boolean

Static Card Carousel

placeData

Object

{"locationSourceId":"105538155871626","type":"REALTIME"}

Map Card

Ad Objective

CTA Values

OUTCOME_AWARENESS

SHOP_NOW, APPLY_NOW, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, LEARN_MORE, REQUEST_TIME, SEE_MENU, SIGN_UP, WATCH_MORE, GET_SHOWTIMES, LISTEN_NOW, SUBSCRIBE, MESSAGE_PAGE, GET_QUOTE, WHATSAPP_MESSAGE, CALL_NOW, ORDER_NOW, SAVE, GET_DIRECTIONS, NO_BUTTON

OUTCOME_ENGAGEMENT

SHOP_NOW, APPLY_NOW, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, LEARN_MORE, REQUEST_TIME, SEE_MENU, SIGN_UP, WATCH_MORE, GET_SHOWTIMES, LISTEN_NOW, SUBSCRIBE, MESSAGE_PAGE, GET_QUOTE, WHATSAPP_MESSAGE, CALL_NOW, ORDER_NOW, BUY_NOW, GET_OFFER, PLAY_GAME, INQUIRE_NOW

OUTCOME_LEADS

SHOP_NOW, APPLY_NOW, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, LEARN_MORE, REQUEST_TIME, SEE_MENU, SIGN_UP, WATCH_MORE, GET_SHOWTIMES, LISTEN_NOW, SUBSCRIBE, MESSAGE_PAGE, GET_QUOTE, WHATSAPP_MESSAGE, ORDER_NOW, GET_PROMOTIONS, SEND_UPDATES, GET_OFFER, BUY_NOW

OUTCOME_SALES

SHOP_NOW, APPLY_NOW, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, LEARN_MORE, REQUEST_TIME, SEE_MENU, SIGN_UP, WATCH_MORE, GET_SHOWTIMES, LISTEN_NOW, SUBSCRIBE, MESSAGE_PAGE, GET_QUOTE, WHATSAPP_MESSAGE, ORDER_NOW, NO_BUTTON, DONATE_NOW, PLAY_GAME, INSTAGRAM_MESSAGE, OPEN_LINK, USE_APP

OUTCOME_TRAFFIC

SHOP_NOW, APPLY_NOW, BOOK_TRAVEL, CONTACT_US, DOWNLOAD, LEARN_MORE, REQUEST_TIME, SEE_MENU, SIGN_UP, WATCH_MORE, GET_SHOWTIMES, LISTEN_NOW, SUBSCRIBE, MESSAGE_PAGE, GET_QUOTE, WHATSAPP_MESSAGE, ORDER_NOW, NO_BUTTON, GET_PROMOTIONS, SEND_UPDATES, DONATE_NOW, PAY_TO_ACCESS, VIEW_INSTAGRAM_PROFILE, INSTAGRAM_MESSAGE

OUTCOME_APP_PROMOTION

SHOP_NOW, BOOK_TRAVEL, DOWNLOAD, LEARN_MORE, SIGN_UP, WATCH_MORE, SUBSCRIBE, ORDER_NOW, USE_MOBILE_APP, INSTALL_MOBILE_APP, PLAY_GAME, LISTEN_NOW, USE_APP

MARKETING_MESSAGES

Field Name

Field Type

Description

optimizationType

String

Optimization strategy for the dynamic ad

ctaTypes

List<DynamicCtaSpec>

List of call-to-action variations

postTexts

List<DynamicBodySpec>

List of post text variations

linkDescriptions

List<DynamicDescriptionSpec>

List of dynamic link descriptions

headlines

List<DynamicHeadlineSpec>

List of dynamic headlines

captions

List<DynamicCaptionSpec>

List of dynamic captions

images

List<DynamicImageSpec>

List of dynamic images

videos

List<DynamicVideoSpec>

List of dynamic videos

destinationObjects

List<DynamicLinkUrlSpec>

List of dynamic link URLs

postSpecs

List<DynamicPostSpec>

List of dynamic post specifications

Field Name

Field Type

Description

cta

String

Call-to-action text

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Field Type

Description

caption

String

Caption text

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Field Type

Description

postTextList

List<String>

List of post text variations

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Field Type

Description

linkDescription

String

Description for link

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Field Type

Description

headlineList

List<String>

List of headline variations

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Field Type

Description

imageUrl

String

URL of the image

imageHqUrl

String

High-quality image URL

imageCrops

ImageCrops

Image crop details

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Field Type

Description

videoTitle

String

Title of the video

videoUrl

String

URL of the video

imageUrl

String

Thumbnail image URL

imageCrops

ImageCrops

Image crop details

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Field Type

Description

displayLink

String

Display URL of the link

linkUrl

String

Destination URL

carouselIndex

int

Specifies the index of the item in a carousel.

ruleSpecs

DynamicRuleSpec

Contains rules for placement and visibility.

urlTags

String

URL tracking parameters for analytics.

Field Name

Type

Description

placementRules

Set<PlacementRule>

A set of rules specifying ad placements.

Field Name

Type

Description

platform

String

Platform where the ad will be shown (e.g., Facebook, Instagram).

position

String

Position where the ad appears (e.g., Feed, Sidebar).

device

String

Type of device targeted (e.g., Mobile, Desktop).

Field Name

Field Type

Description

cropSpecs100x100

List<List<Integer>>

Crop specifications for 100x100

cropSpecs191x100

List<List<Integer>>

Crop specifications for 191x100

cropSpecs100x72

List<List<Integer>>

Crop specifications for 100x72

cropSpecs400x150

List<List<Integer>>

Crop specifications for 400x150

cropSpecs400x500

List<List<Integer>>

Crop specifications for 400x500

cropSpecs600x360

List<List<Integer>>

Crop specifications for 600x360

cropSpecs90x160

List<List<Integer>>

Crop specifications for 90x160

cropSpecs160x90

List<List<Integer>>

Crop specifications for 160x90

cropSpecs200x300

List<List<Integer>>

Crop specifications for 200x300

cropSpecsCustom

List<List<Integer>>

Custom crop specifications