Ad Set
Updated
1. The channelId refers to the unique identifier of an entity within the Native Channel.This case facebook
2. For publisherPlatforms,positions, devicePlatforms Supported values can be fetched via Enpoint
Helper Endpoints - Default Ad Placements
3.
Field Name | Field Type | Field Values | Description | Update Supported | Change Type |
name | String | Name of the ad set. | Y | NAME | |
channelId | String | Campaign Id or Ad Set Channel Id(Facebook) | N | ||
id | String | Unique identifier for the ad set. Sprinklr Id | N | ||
startTime | Long | Start time of the ad set in epoch milliseconds. | Y | START_DATE | |
endTime | Long | End time of the ad set in epoch milliseconds. | Y | END_DATE | |
adObjective | AdObjective | Ad Objective. Note : Need to same as PaidIntiative | N | ||
campaignGroupId | String | Channel ID of the campaign group(Paid Initiative) the ad set belongs to. | N | ||
campaignGroupName | String | Name of the campaign group. | N | ||
status | AdSetStatus | DRAFT, ACTIVE, PAUSED, COMPLETED | Status of the ad set. | Y | STATUS |
publisherPlatforms | List<Enum> | FACEBOOK,INSTAGRAM,AUDIENCE_NETWORK,MESSENGER,WHATSAPP | Platforms where the ad will be published (FACEBOOK, INSTAGRAM, MESSENGER). | Y | PUBLISHER_PLATFORMS |
positions | List<Enum> | https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4796350787/Ad+Set+Facebook#positions.1 FEED, INSTANT_ARTICLE, INSTREAM_VIDEO, RIGHT_HAND_COLUMN, SUGGESTED_VIDEO, MARKETPLACE, FACEBOOK_STORIES, FACEBOOK_SEARCH, INSTAGRAM_FEED, INSTAGRAM_EXPLORE, INSTAGRAM_STORIES, CLASSIC, AUDIENCE_NETWORK_INSTREAM_VIDEO, REWARDED_VIDEO, SPONSORED_MESSAGES, MESSENGER_STORY, INSTAGRAM_IGTV, INSTAGRAM_REELS, FACEBOOK_REELS, FACEBOOK_REELS_OVERLAY, FACEBOOK_BIZ_DISCO_FEED, INSTAGRAM_PROFILE_FEED, INSTAGRAM_EXPLORE_HOME, INSTAGRAM_SEARCH_RESULTS, INSTAGRAM_REELS_OVERLAY, WHATSAPP_MARKETING_MESSAGE, FACEBOOK_PROFILE_FEED, INSTAGRAM_PROFILE_REELS | Positions within platforms where the ad can appear.Eg | Y | AD_POSITIONS |
devicePlatforms | List<Enum> | Devices on which the ad will be shown (e.g., mobile, desktop). | Y | DEVICE_PLATFORMS | |
adPlacementType | Enum | AUTOMATIC, MANUAL | Type of ad placement (default: AUTOMATIC). | Y | AD_PLACEMENT_TYPE |
pacingType | Enum | STANDARD, ACCELERATED | Strategy for pacing ad delivery (e.g., standard, accelerated). | N | |
dailyBudget | Double | Daily budget allocated for the ad set. | Y | DAILY_BUDGET | |
lifeTimeBudget | Double | Lifetime budget allocated for the ad set. | Y | LIFETIME_BUDGET | |
bidStrategy | Enum | https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4796350787/Ad+Set+Facebook#bidStrategy.1 LOWEST_COST, COST_CAP, LOWEST_COST_WITH_BID_CAP, TARGET_COST, LOWEST_COST_WITH_MIN_ROAS | Strategy used for bidding (e.g., cost cap, target ROAS). When changing bid strategy to WITHOUT_CAP, pass bidAmount = null and include BID_AMOUNT as part of changeType. | Y | BID_STRATEGY |
bidAmount | Double | Set Bid Amount when bidStrategy is COST_CAP,LOWEST_COST_WITH_BID_CAP,TARGET_COST | Y | BID_AMOUNT | |
minimumROAS | Double | Minimum required return on ad spend (ROAS). Set when bidStrategy is LOWEST_COST_WITH_MIN_ROAS | |||
chargeBy | ChargeBy | https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4796350787/Ad+Set+Facebook#chargeBy.1 NONE, CLICKS, IMPRESSIONS, LINK_CLICKS, APP_INSTALLS, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, VIDEO_VIEWS, TWO_SECOND_CONTINUOUS_VIDEO_VIEWS, THRUPLAY | Defines what the advertiser is charged for (e.g., impressions, clicks). | Y | CHARGE_BY |
optimiseFor | OptimizationGoal | https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4796350787/Ad+Set+Facebook#optimiseFor.1 NONE, APP_INSTALL, APP_EVENTS, APP_INSTALLS_AND_OFFSITE_CONVERSIONS, LEAD, CLICKS, ENGAGED_USERS, EXTERNAL, EVENT_RESPONSES, LANDING_PAGE_VIEWS, IMPRESSIONS, LINK_CLICK, OFFER_CLAIMS, OFFSITE_CONVERSIONS, PAGE_ENGAGEMENT, PAGE_LIKES, POST_ENGAGEMENT, REACH, STORE_VISITS, SOCIAL_IMPRESSIONS, BRAND_AWARENESS, VIDEO_VIEWS, REPLIES, AD_RECALL_LIFT, VALUE, TWO_SECOND_CONTINUOUS_VIDEO_VIEWS, THRUPLAY, CONVERSION_LEAD, QUALITY_CALL, DERIVED_EVENTS, VISIT_INSTAGRAM_PROFILE, INCREMENTAL_OFFSITE_CONVERSIONS, REMINDERS_SET, PROFILE_VISITS | Optimization goal for the ad set | Y | OPTIMIZE_FOR |
apiAttributionSpecs | List<ApiAttributionSpec> | Eg: [{"eventType":"CLICK_THROUGH","windowDays":7},{"eventType":"CLICK_THROUGH","windowDays":30},{"eventType":"CLICK_THROUGH","windowDays":14},{"eventType":"CLICK_THROUGH","windowDays":10}] | Attribution specifications for tracking conversions. | Y | ATTRIBUTION_SPEC |
destinationType | DestinationType | Type of destination where the ad leads (e.g., website, app). | Y | DESTINATION_TYPE | |
promotedObjectType | String | Type of object being promoted (e.g., product, service). | Y | PROMOTED_OBJECT | |
promotedObjectId | String | Note : For changing any promoted object object details all info need to be passed | Identifier of the promoted object. | Y | PROMOTED_OBJECT |
parentPixelChannelId | String | ID of the parent pixel tracking channel. | Y | PROMOTED_OBJECT | |
url | String | Object Store Url | Y | PROMOTED_OBJECT | |
pixelRule | String | Rule applied for pixel tracking. | Y | PROMOTED_OBJECT | |
customEventType | String | Type of custom event used for tracking. | Y | PROMOTED_OBJECT | |
deepCustomEventType | String | Deep Custom Event Type | Y | PROMOTED_OBJECT | |
customEventStr | String | Additional details for the custom event. | Y | PROMOTED_OBJECT | |
whatsappPhoneNumber | String | Phone number for WhatsApp | Y | PROMOTED_OBJECT | |
objectStoreURLs | List<String> | URLs of objects stored for dynamic ads. | Y | PROMOTED_OBJECT | |
productSetId | String | Identifier of the product set for catalog ads. | Y | PROMOTED_OBJECT | |
pageId | String | Identifier of the linked business page. | Y | PROMOTED_OBJECT | |
appId | String | Identifier of the promoted app. | Y | PROMOTED_OBJECT | |
pixelId | String | Identifier of the tracking pixel. | Y | PROMOTED_OBJECT | |
catalogId | String | Identifier of the product catalog. | Y | PROMOTED_OBJECT | |
targeting | Object of type TargetingRequest | Targeting parameters for the ad set. | Y | TARGETING | |
frequency | List<FrequencyRequest> | Frequency capping settings for ad delivery. | Y | FREQUENCY_CAP | |
apiAdVariantRequests | List<PaidApiAdVariant> | List of Advariant to Publish | Variations of the ad set for A/B testing. | ||
adBrandSafetyContentFilterLevels | Set<String> | Levels of brand safety content filtering. | |||
skipableAdPreference | Enum | Preference for whether ads can be skipped. | |||
dsaPayor | String | Payor information for dynamic structured ads (DSA). | Y | DSA_PAYOR | |
dsaBeneficiary | String | Beneficiary information for DSA. | Y | DSA_BENEFICIARY | |
dsaPayorAustralia | String | Payor information specific to Australia. | Y | FB_AUSTRALIA_FINSERV_PAYER | |
dsaBeneficiaryAustralia | String | Beneficiary information specific to Australia. | Y | FB_AUSTRALIA_FINSERV_BENEFICIARY | |
dsaPayorTaiwan | String | Payor information specific to Taiwan. | Y | FB_TAIWAN_FINSERV_PAYER | |
dsaBeneficiaryTaiwan | String | Beneficiary information specific to Taiwan. | Y | FB_TAIWAN_FINSERV_BENEFICIARY | |
dsaPayorTaiwanUniversal | String | Universal payor info for Taiwan. | Y | FB_TAIWAN_UNIVERSAL_PAYER | |
dsaBeneficiaryTaiwanUniversal | String | Universal beneficiary info for Taiwan. | Y | FB_TAIWAN_UNIVERSAL_BENEFICIARY | |
isDynamicCreative | Boolean | If Dynamic Creative | Indicates if dynamic creative optimization is enabled. | N |
Supported Objectives
adObjective
Enum | Label |
OUTCOME_AWARENESS | Facebook Awareness |
OUTCOME_ENGAGEMENT | Facebook Engagement |
OUTCOME_LEADS | Facebook Leads |
OUTCOME_SALES | Facebook Sales |
OUTCOME_TRAFFIC | Facebook Traffic |
OUTCOME_APP_PROMOTION | Facebook App Promotion |
MARKETING_MESSAGES | Marketing Messages |
Supported Destination Type
destinationType
Table 1: Objectives → Destination Types
Objective (adObjective) | Destination Type (destinationType) |
OUTCOME_TRAFFIC | WEBSITE_MESSENGER |
APP_STORE | |
MESSENGER | |
INSTAGRAM_DIRECT | |
PHONE_CALL | |
INSTAGRAM_PROFILE | |
OUTCOME_AWARENESS | STORE_VISIT |
WEBSITE_MESSENGER | |
OUTCOME_ENGAGEMENT | ON_POST |
ON_VIDEO | |
WEBSITE_MESSENGER | |
ON_PAGE | |
APP_STORE | |
PHONE_CALL | |
ON_EVENT | |
CLICK_TO_MESSENGER | |
ON_REMINDER | |
SPONSORED_MESSAGES | |
OUTCOME_SALES | WEBSITE_MESSENGER |
CATALOG | |
APP_STORE | |
WEBSITE_APP | |
MESSENGER | |
PHONE_CALL | |
OUTCOME_LEADS | ON_AD |
WEBSITE_MESSENGER | |
MESSENGER | |
LEAD_FORM_MESSENGER | |
APP_STORE | |
LEAD_FROM_IG_DIRECT | |
PHONE_CALL | |
OUTCOME_APP_PROMOTION | (No destination types) |
MARKETING_MESSAGES | (No destination types) |
Table 2: Objective → Destination Type → Promoted Object Type
Ad Objective (adObjective) | Destination Type (destinationType) | Promoted Object Type (promotedObjectType) |
OUTCOME_TRAFFIC | WEBSITE_MESSENGER | PAGE |
OUTCOME_TRAFFIC | WEBSITE_MESSENGER | PIXEL |
OUTCOME_TRAFFIC | APP_STORE | APPLICATION |
OUTCOME_TRAFFIC | PAGE | |
OUTCOME_TRAFFIC | MESSENGER | PAGE |
OUTCOME_TRAFFIC | INSTAGRAM_DIRECT | PAGE |
OUTCOME_TRAFFIC | PHONE_CALL | PAGE |
OUTCOME_TRAFFIC | INSTAGRAM_PROFILE | PAGE |
OUTCOME_AWARENESS | STORE_VISIT | PAGE |
OUTCOME_AWARENESS | WEBSITE_MESSENGER | PAGE |
OUTCOME_ENGAGEMENT | ON_VIDEO | PAGE |
OUTCOME_ENGAGEMENT | WEBSITE_MESSENGER | PIXEL |
OUTCOME_ENGAGEMENT | ON_PAGE | PAGE |
OUTCOME_ENGAGEMENT | PAGE | |
OUTCOME_ENGAGEMENT | APP_STORE | APPLICATION |
OUTCOME_ENGAGEMENT | PHONE_CALL | PAGE |
OUTCOME_ENGAGEMENT | CLICK_TO_MESSENGER | PAGE |
OUTCOME_ENGAGEMENT | SPONSORED_MESSAGES | PAGE |
OUTCOME_SALES | WEBSITE_MESSENGER | PIXEL |
OUTCOME_SALES | CATALOG | PRODUCT_SET |
OUTCOME_SALES | APP_STORE | APPLICATION |
OUTCOME_SALES | WEBSITE_APP | CROSS_PIXEL_APP |
OUTCOME_SALES | PIXEL | |
OUTCOME_SALES | PAGE | |
OUTCOME_SALES | MESSENGER | PIXEL |
OUTCOME_SALES | MESSENGER | PAGE |
OUTCOME_SALES | PHONE_CALL | PAGE |
OUTCOME_LEADS | ON_AD | PAGE |
OUTCOME_LEADS | WEBSITE_MESSENGER | PIXEL |
OUTCOME_LEADS | WEBSITE_MESSENGER | PAGE |
OUTCOME_LEADS | MESSENGER | PAGE |
OUTCOME_LEADS | LEAD_FORM_MESSENGER | PAGE |
OUTCOME_LEADS | APP_STORE | APPLICATION |
OUTCOME_LEADS | LEAD_FROM_IG_DIRECT | PAGE |
OUTCOME_LEADS | PHONE_CALL | PAGE |
MARKETING_MESSAGES | -- | MESSAGING_APP |
MARKETING_MESSAGES | -- | PIXEL |
OUTCOME_APP_PROMOTION | -- | APPLICATION |
OUTCOME_APP_PROMOTION | -- | PRODUCT_SET |
Supported Publisher Platform
Field Key : publisherPlatforms
Enum | Unsupported Objectives | Unsupported Destination Types | Unsupported Device Platform |
(None) | SPONSORED_MESSAGES | ||
(None) | CANVAS, ON_EVENT, SPONSORED_MESSAGES | DESKTOP | |
AUDIENCE_NETWORK | (None) | CLICK_TO_MESSENGER, CANVAS, SPONSORED_MESSAGES, WHATSAPP, PHONE_CALL, STORE_VISIT, ON_EVENT, WEBSITE_APP Note : PHONE_CALL Only Unsupported for OUTCOME_ENGAGEMENT Objective | |
MESSENGER | OUTCOME_APP_PROMOTION, OUTCOME_ENGAGEMENT | CANVAS, WHATSAPP, ON_EVENT, STORE_VISIT, WEBSITE_APP, ON_REMINDER, PHONE_CALL Note : PHONE_CALL Only Unsupported for OUTCOME_ENGAGEMENT Objective | DESKTOP |
OUTCOME_APP_PROMOTION, OUTCOME_ENGAGEMENT, OUTCOME_LEADS, OUTCOME_AWARENESS, OUTCOME_SALES, OUTCOME_TRAFFIC | MESSENGER, WEBSITE, WEBSITE_MESSENGER, APP_STORE, PHONE_CALL, INSTAGRAM_DIRECT, WHATSAPP |
Supported Positions
positions
Enum | Display Name |
FEED | Facebook Feed |
INSTANT_ARTICLE | Instant Articles |
INSTREAM_VIDEO | Facebook In-Stream Videos |
RIGHT_HAND_COLUMN | Facebook right column |
SUGGESTED_VIDEO | Facebook Video Feeds |
MARKETPLACE | Facebook Marketplace |
FACEBOOK_STORIES | Facebook Stories |
FACEBOOK_SEARCH | Facebook Search Results |
INSTAGRAM_FEED | Instagram Feed |
INSTAGRAM_EXPLORE | Instagram Explore |
INSTAGRAM_STORIES | Instagram Stories |
CLASSIC | Audience Network native, banner and interstitial |
AUDIENCE_NETWORK_INSTREAM_VIDEO | Audience Network In-Stream Videos |
REWARDED_VIDEO | Audience Network rewarded videos |
SPONSORED_MESSAGES | Messenger sponsored messages |
MESSENGER_STORY | Messenger Stories |
INSTAGRAM_IGTV | Instagram TV |
INSTAGRAM_REELS | Instagram Reels |
FACEBOOK_REELS | Facebook Reels |
FACEBOOK_REELS_OVERLAY | Ads on Facebook Reels |
FACEBOOK_BIZ_DISCO_FEED | Facebook Business Explore |
INSTAGRAM_PROFILE_FEED | Instagram Profile Feed |
INSTAGRAM_EXPLORE_HOME | Instagram Explore Home |
INSTAGRAM_SEARCH_RESULTS | Instagram search results |
INSTAGRAM_REELS_OVERLAY | Ads on Instagram Reels |
WHATSAPP_MARKETING_MESSAGE | WhatsApp Marketing Messages |
FACEBOOK_PROFILE_FEED | Facebook Profile Feed |
INSTAGRAM_PROFILE_REELS | Instagram Profile Reels |
Supported Device Platform
devicePlatforms
Enum | Display Name |
MOBILE | Mobile |
DESKTOP | Desktop |
BOTH | All Devices (Recommended) |
Supported Optimise For
optimiseFor
LINK_CLICK, IMPRESSIONS, REACH, LANDING_PAGE_VIEWS, QUALITY_CALL, AD_RECALL_LIFT, THRUPLAY, TWO_SECOND_CONTINUOUS_VIDEO_VIEWS, POST_ENGAGEMENT, OFFSITE_CONVERSIONS, PAGE_LIKES, EVENT_RESPONSES, REMINDERS_SET, PROFILE_VISITS, LEAD, CONVERSION_LEAD, APP_INSTALL, REPLIES, VISIT_INSTAGRAM_PROFILE |
Supported Bid Strategy
bidStrategy
Enum | Label |
LOWEST_COST | Lowest Cost |
COST_CAP | Cost Cap |
LOWEST_COST_WITH_BID_CAP | Lowest Cost With Bid Cap |
TARGET_COST | Target Cost |
LOWEST_COST_WITH_MIN_ROAS | Minimum ROAS |
Supported Charge By
chargeBy
Enum | |||||
NONE, CLICKS, IMPRESSIONS, LINK_CLICKS, APP_INSTALLS, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, VIDEO_VIEWS, THRUPLAY, TWO_SECOND_CONTINUOUS_VIDEO_VIEWS | |||||
Objective | Destination Type (destinationType) | Optimisation Goal (optimiseFor) | Bid Strategy (bidStrategy) | Charge By(chargeBy) | |
OUTCOME_TRAFFIC | WEBSITE_MESSENGER | LINK_CLICK | LOWEST_COST, COST_CAP | IMPRESSIONS, LINK_CLICK | |
IMPRESSIONS | LOWEST_COST | IMPRESSIONS | |||
REACH | LOWEST_COST | IMPRESSIONS | |||
LANDING_PAGE_VIEWS | LOWEST_COST | IMPRESSIONS | |||
QUALITY_CALL | LOWEST_COST | LINK_CLICK | |||
APP_STORE | LINK_CLICK, REACH | LOWEST_COST | IMPRESSIONS | ||
LINK_CLICK, REPLIES, IMPRESSIONS | LOWEST_COST, COST_CAP | IMPRESSIONS | |||
MESSENGER | LINK_CLICK, REPLIES, IMPRESSIONS | LOWEST_COST | IMPRESSIONS | ||
INSTAGRAM_DIRECT | LINK_CLICK, REPLIES, IMPRESSIONS | LOWEST_COST | IMPRESSIONS | ||
INSTAGRAM_PROFILE | PROFILE_VISITS | LOWEST_COST | IMPRESSIONS | ||
PHONE_CALL | LINK_CLICK, QUALITY_CALL | LOWEST_COST | LINK_CLICK | ||
OUTCOME_AWARENESS | STORE_VISIT | AD_RECALL_LIFT, REACH, THRUPLAY | LOWEST_COST | IMPRESSIONS | |
WEBSITE_MESSENGER | AD_RECALL_LIFT | LOWEST_COST | IMPRESSIONS | ||
OUTCOME_ENGAGEMENT | ON_POST | POST_ENGAGEMENT | LOWEST_COST | IMPRESSIONS | |
ON_VIDEO | THRUPLAY, TWO_SECOND_CONTINUOUS_VIDEO_VIEWS | LOWEST_COST, COST_CAP | IMPRESSIONS | ||
WEBSITE_MESSENGER | LINK_CLICK, LANDING_PAGE_VIEWS | LOWEST_COST, COST_CAP | IMPRESSIONS | ||
ON_PAGE | PAGE_LIKES | LOWEST_COST | IMPRESSIONS | ||
LINK_CLICK, REPLIES, OFFSITE_CONVERSIONS | LOWEST_COST, COST_CAP | IMPRESSIONS | |||
ON_EVENT | EVENT_RESPONSES, POST_ENGAGEMENT | LOWEST_COST | IMPRESSIONS | ||
CLICK_TO_MESSENGER | LINK_CLICK, REPLIES | LOWEST_COST | IMPRESSIONS | ||
ON_REMINDER | REMINDERS_SET | LOWEST_COST | IMPRESSIONS | ||
SPONSORED_MESSAGES | IMPRESSIONS | LOWEST_COST | IMPRESSIONS | ||
OUTCOME_SALES | CATALOG | LINK_CLICK, OFFSITE_CONVERSIONS | LOWEST_COST, COST_CAP | IMPRESSIONS | |
APP_STORE | LINK_CLICK, OFFSITE_CONVERSIONS, REACH | LOWEST_COST | IMPRESSIONS | ||
LINK_CLICK, REPLIES, OFFSITE_CONVERSIONS | LOWEST_COST, COST_CAP | IMPRESSIONS | |||
MESSENGER | REPLIES, OFFSITE_CONVERSIONS | LOWEST_COST | IMPRESSIONS | ||
WEBSITE_MESSENGER | LANDING_PAGE_VIEWS, LINK_CLICK | LOWEST_COST, COST_CAP | IMPRESSIONS | ||
OUTCOME_LEADS | ON_AD | LEAD, CONVERSION_LEAD | LOWEST_COST | IMPRESSIONS | |
MESSENGER | LEAD | LOWEST_COST | IMPRESSIONS | ||
LEAD_FORM_MESSENGER | LEAD | LOWEST_COST | IMPRESSIONS | ||
WEBSITE_MESSENGER | LEAD, LINK_CLICK, LANDING_PAGE_VIEWS | LOWEST_COST | IMPRESSIONS | ||
LEAD_FROM_IG_DIRECT | LEAD | LOWEST_COST | IMPRESSIONS | ||
OUTCOME_APP_PROMOTION | N/A | APP_INSTALL, LINK_CLICK, CONVERSIONS | LOWEST_COST, COST_CAP | IMPRESSIONS | |
MARKETING_MESSAGES | N/A | LINK_CLICK, OFFSITE_CONVERSIONS, IMPRESSIONS | LOWEST_COST, COST_CAP | IMPRESSIONS | |
Note : Bid amount can only be set for COST_CAP
Promoted Object Type (promotedObjectType)
Ad Objective | Promoted Object Types (promotedObjectType) |
OUTCOME_TRAFFIC | PAGE, PIXEL, APPLICATION |
OUTCOME_AWARENESS | PAGE |
OUTCOME_ENGAGEMENT | PAGE, PIXEL, APPLICATION |
OUTCOME_SALES | PIXEL, PAGE, APPLICATION, PRODUCT_SET, CROSS_PIXEL_APP |
OUTCOME_LEADS | PIXEL, PAGE, APPLICATION |
MARKETING_MESSAGES | MESSAGING_APP, PIXEL |
OUTCOME_APP_PROMOTION | APPLICATION, PRODUCT_SET |
Field Key Required To Create Promoted Object
promotedObjectType, promotedObjectId, parentPixelChannelId, url, pixelRule, customEventType, deepCustomEventType, customEventStr, whatsappPhoneNumber, objectStoreURLs, productSetId, pageId, appId, pixelId, catalogId
Brand Safety Filters
adBrandSafetyContentFilterLevels
Enum Value | Display Name |
FACEBOOK_RELAXED | Facebook In-stream videos and Ads on Facebook Reels: Expanded Inventory |
FACEBOOK_STANDARD | Facebook In-stream videos and Ads on Facebook Reels: Moderate Inventory |
FACEBOOK_STRICT | Facebook In-stream videos and Ads on Facebook Reels: Limited Inventory |
AN_RELAXED | Audience Network: Expanded Inventory |
AN_STANDARD | Audience Network: Moderate Inventory |
AN_STRICT | Audience Network: Limited Inventory |
FEED_RELAXED | Facebook Feed ads: Expanded Inventory |
FEED_STANDARD | Facebook Feed ads: Moderate Inventory |
FEED_STRICT | Facebook Feed ads: Limited Inventory |
Note : Can only select one from
Facebook group ----- FACEBOOK_RELAXED,FACEBOOK_STANDAR,FACEBOOK_STRICT
Audience Network -----AN_RELAXED,AN_STANDARD,AN_STANDARD
Facebook Feed ads----FEED_RELAXED,FEED_STANDARD,FEED_STRICT
Eg : [FACEBOOK_RELAXED, AN_STANDARD, FEED_STRICT ] this is valid only one from each group
This can only be selected when placement type is MANUAL
Skippable
(skipableAdPreference)
Enum Value | Display Name |
ENABLED | Enabled |
DISABLED | Disabled |
For Beneficiary
1.dsaPayor,
lookupType : additional.DSA_PAYOR
dsaBeneficiary,
"lookupType": "additional.DSA_BENEFICIARY"
2.dsaPayorAustralia,
lookupType : channelSpecificMap.FB_AUSTRALIA_FINSERV_PAYER
dsaBeneficiaryAustralia,
"lookupType": "channelSpecificMap.FB_AUSTRALIA_FINSERV_BENEFICIARY"
3.dsaPayorTaiwan,
lookupType : channelSpecificMap.FB_TAIWAN_FINSERV_PAYER
dsaBeneficiaryTaiwan,
"lookupType": "channelSpecificMap.FB_TAIWAN_FINSERV_BENEFICIARY"
4. dsaPayorTaiwanUniversal,
lookupType : channelSpecificMap.FB_TAIWAN_UNIVERSAL_PAYER
dsaBeneficiaryTaiwanUniversal
"lookupType": "channelSpecificMap.FB_TAIWAN_UNIVERSAL_BENEFICIARY"
Helper Endpoints
{
"filters": [
{
"field": "accountIds",
"filterType": "IN",
"values": [
1000169995. //this is sprinklr account ID
]
}
],
"dimensionLookups": [
{
"lookupType": "channelSpecificMap.FB_TAIWAN_UNIVERSAL_BENEFICIARY",
"page": {
"page": 0,
"size": 20
},
"query": ""
}
]
}