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

Enum

Label

HOUSING

Housing

CREDIT

Credit

FINANCIAL_PRODUCTS_SERVICES

Financial Products Services

EMPLOYMENT

Employment

ISSUES_ELECTIONS_POLITICS

Issues Election Politics"

Enum

Label

SMART_APP_PROMOTION

Facebook Advantage+ App Campaigns

AUTOMATED_SHOPPING_ADS

Facebook Advantage+ Shopping Ads

Enum

Label

ACCELERATED

Accelerated

STANDARD

Standard

Ad Objective

Supported Destination Types

OUTCOME_AWARENESS

AWARENESS, WEBSITE

OUTCOME_TRAFFIC

WEBSITE, ON_POST, ON_PAGE, ON_EVENT, OPEN_MAP, APP_STORE, CLICK_TO_MESSENGER, PHONE_CALL, INSTAGRAM_PROFILE

OUTCOME_ENGAGEMENT

ON_POST, ON_PAGE, ON_EVENT, ON_VIDEO, ON_REMINDER

APP_INSTALLS

APP_STORE, CROSS_PIXEL_APP

LEAD_GENERATION

ON_AD (Instant Form), WEBSITE

MESSAGES

CLICK_TO_MESSENGER, MESSENGER, WEBSITE_MESSENGER, WHATSAPP, INSTAGRAM_DIRECT

CONVERSIONS

WEBSITE, APP_STORE, CROSS_PIXEL_APP

CATALOG_SALES

WEBSITE, INSTAGRAM_DIRECT

STORE_VISITS

STORE_VISIT, STORE, OPEN_MAP

LEAD_ADS (Deprecated label)

ON_AD

Field Name

Field Type

Supported Field Value

Description

Change Type

Supported

id

String

N

name

String

NAME

Y

channelId

String

N

channelType

Enum

FACEBOOK

N

adObjective

Enum

Enum Mentioned in Supported Objectives

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4793827637/Paid+Initiative+Facebook#Enum

N

adAccountChannelId

String

accountUserId field

from Account Object

N

adAccountId

Long

accountId field From Account Object

N

status

Enum

ACTIVE,PAUSED, DELETED, DRAFT

STATUS

Y

startTime

Long

Epoch Start Time

Y

endTime

Long

Epoch End Time

Y

adCategories

List<Enum>

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4793827637/Paid+Initiative+Facebook#Enum.1

Supported Categories

lifeTimeBudget

Double

Life Time Budget for Paid Initiative

LIFETIME_BUDGET

Y

frequency

List<FrequencyRequest>

Frequency Object

FREQUENCY_CAPPING

Y

pacingType

Enum

STANDARD, ACCELERATED

Strategy for pacing ad delivery

N

adCategoryCountries

List<String>

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4734026021/Helper+Endpoints#POST-%2Flookup%2FbyDimensions

AD_CATEGORIES

Y

smartPromotionType

Enum

https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4793827637/Paid+Initiative+Facebook#Smart-Promotion-Type

SMART_PROMOTION_TYPE

Y

destinationType

CATALOG

N

productCatalogId

String

When catalog is selected at PI level. Then productCatalogId is mandatory

N

promotedObjectType

Enum

APPLICATION, PRODUCT_CATALOG,

APPLICATION is supported when iosCampoaign is Enabled

N

promotedObjectId

String

N

parentPixelChannelId

url

String

pixelRule

customEventType

deepCustomEventType

customEventStr

whatsappPhoneNumber

whatsappBusinessPhoneNumberId

objectStoreURLs

productSetId

pageId

appId

pixelId

ios14Campaign

Boolean

Is IOS Campaign or not

Default False

True : Set promoted Object Type to APPLICATION

N

changeTypes

List<String>

This need to be passed when published Paid Initiative is updated.

Change Type Column

apiAdSetRequests

List<Object>

AdSet Object Schema

https://sprinklr.atlassian.net/wiki/pages/resumedraft.action?draftId=4796350787&draftShareId=8eb6dc7d-7ea9-40f7-98c0-7817d1b0d333