Ad Set
Updated
Supported Objectives
adObjective | Label |
PROMOTED_TWEETS | X Engagements |
TWITTER_AWARENESS | X Reach |
TWITTER_WEBSITE_CLICKS | X Website Traffic |
PROMOTED_ACCOUNTS | X Followers |
TWITTER_VIDEO_VIEWS | X Video Views |
TWITTER_PREROLL_VIEWS | X Preroll Views |
TWITTER_APP_INSTALLS | X App Installs |
TWITTER_APP_ENGAGEMENTS | X App Re Engagements |
ApiAdSet (X)
Field Name | Field Type | Description | Update Supported | Change Type |
name | String | Name of the ad set. | Y | NAME |
channelId | String | Campaign Id or Channel Id | N | |
id | String | Unique identifier for the ad set. | 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 | Objective of the ad campaign (e.g., brand awareness, conversions). | N | |
status | AdSetStatus | Current status of the ad set (default: DRAFT, ACTIVE, PAUSED). | Y | STATUS |
adPlacements | List<Enum> | Specific placements within platforms where the ad will appear. https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4800775483/Ad+Set+Twitter#adPlacements.1 | Y | PLACEMENT |
pacingType | String | Strategy for pacing ad delivery. Supported Values 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 | BidStrategy | Strategy used for bidding (e.g., cost cap, target ROAS). | N | |
bidType | BidType | Y | BID_TYPE | |
bidAmount | Double | Amount bid per impression/click/action. | Y | BID_AMOUNT, BID_INFO |
chargeBy | ChargeBy | Defines what the advertiser is charged for (e.g., impressions, clicks). https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4800775483/Ad+Set+Twitter#ChargeBy-(chargeBy) | Y | CHARGE_BY |
optimiseFor | OptimizationGoal | Optimization goal for the ad set https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4800775483/Ad+Set+Twitter#BidFor-and-OptimiseFor | Y | OPTIMIZE_FOR |
targetCPA | Double | Target CPA | Y | TARGET_CONVERSION_VALUE |
bidFor | OptimizationGoal | Secondary optimization goal, if applicable. https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4800775483/Ad+Set+Twitter#BidFor-and-OptimiseFor | Y | BID_FOR |
promotedObjectType | String | Only Supported For TWITTER_APP_ENGAGEMENTS, TWITTER_APP_INSTALLS Objective | Y | PROMOTED_OBJECT |
promotedObjectId | String | Identifier of the promoted object. | Y | PROMOTED_OBJECT |
targeting | TargetingRequest | Targeting parameters for the ad set. https://sprinklr.atlassian.net/wiki/spaces/SM/pages/4800775483/Ad+Set+Twitter#targeting.1 | Y | TARGETING |
frequency | List<FrequencyRequest> | Frequency capping settings for ad delivery. | Y | FREQUENCY_CAP |
promotedAccountId | String | Twitter ID of the promoted advertiser account. | N | |
preRollCtaLink | String | URL for the call-to-action in pre-roll ads. Supported Objective : TWITTER_VIDEO_VIEWS | N | |
preRollCtaType | String | Type of call-to-action in pre-roll ads. Supported Objective: TWITTER_VIDEO_VIEWS | N | |
apiAdVariantRequests | List<PaidApiAdVariant> | Variations of the ad set for A/B testing. | ||
adBrandSafetyContentFilterLevels | Set<String> | Levels of brand safety content filtering. | N | |
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> | Conversion Pixels | Y | PIXEL |
changeTypes | List<String> |
adPlacements
Enum | Label |
SEARCH | Search |
USER_TIMELINE | User Timeline |
USER_PROFILE | User Profile |
REPLIES | Replies |
ChargeBy (chargeBy)
ChargeBy Enum |
ChargeBy.APP_CLICK |
ChargeBy.APP_INSTALL |
ChargeBy.ENGAGEMENT |
ChargeBy.FOLLOW |
ChargeBy.LEAD |
ChargeBy.LINK_CLICK |
ChargeBy.VIEW |
ChargeBy.VIEW_3S_100PCT |
ChargeBy.VIEW_6S |
ChargeBy.IMPRESSION |
BidType (bidType)
Enum | Label | Bid Goals |
CPA | CPA | ACTIONS |
OPTIMIZED | Optimized CPM | REACH, CLICKS, SOCIAL, ACTIONS |
BidFor and OptimiseFor
BidFor (bidFor) | OptimizeFor (OptimiseFor) | AdObjective |
APP_CLICK | DEFAULT | - |
APP_INSTALL | DEFAULT | - |
APP_PURCHASE | DEFAULT | - |
ENGAGEMENT | DEFAULT | - |
FOLLOW | DEFAULT | - |
LINK_CLICK | DEFAULT | - |
VIDEO_VIEWS | DEFAULT | - |
VIDEO_VIEWS | DEFAULT | TWITTER_PREROLL_VIEWS |
VIDEO_VIEWS | ENGAGEMENT | TWITTER_AWARENESS |
VIDEO_VIEWS | DEFAULT | TWITTER_VIDEO_VIEWS |
VIEW_3S_100PCT | DEFAULT | - |
VIEW_6S | DEFAULT | - |
VIEW_15S | DEFAULT | - |
LINK_CLICK | OFFSITE_CONVERSIONS | - |
LINK_CLICK | SITE_VISITS | TWITTER_WEBSITE_CLICKS |
Supported OptimizeFor (per Objective)
Ad Objective | Supported optimiseFor |
TWITTER_AWARENESS | DEFAULT, ENGAGEMENT |
PROMOTED_TWEETS | DEFAULT |
PROMOTED_ACCOUNTS | DEFAULT |
TWITTER_WEBSITE_CLICKS | DEFAULT, SITE_VISITS, OFFSITE_CONVERSIONS, WEBSITE_CONVERSIONS |
TWITTER_VIDEO_VIEWS | DEFAULT |
TWITTER_PREROLL_VIEWS | DEFAULT, WEBSITE_CONVERSIONS, VIDEO_VIEWS |
TWITTER_APP_INSTALLS | APP_CLICK, DEFAULT |
TWITTER_APP_ENGAGEMENTS | DEFAULT |
Supported BidFor (per Objective)
Ad Objective | Supported bidFor |
TWITTER_AWARENESS | VIDEO_VIEWS, VIEW |
PROMOTED_TWEETS | ENGAGEMENT |
PROMOTED_ACCOUNTS | FOLLOW |
TWITTER_WEBSITE_CLICKS | LINK_CLICK |
TWITTER_VIDEO_VIEWS | VIDEO_VIEWS, VIEW_15S, VIEW_6S, VIEW_3S_100PCT |
TWITTER_PREROLL_VIEWS | VIDEO_VIEWS, LINK_CLICK, VIEW_6S, VIEW_3S_100PCT |
TWITTER_APP_INSTALLS | APP_INSTALL, APP_CLICK, APP_PURCHASE |
TWITTER_APP_ENGAGEMENTS | APP_CLICK |
Supported ChargeBy (per Objective)
Ad Objective | Supported chargeBy |
TWITTER_AWARENESS | IMPRESSION |
PROMOTED_TWEETS | ENGAGEMENT |
PROMOTED_ACCOUNTS | FOLLOW |
TWITTER_WEBSITE_CLICKS | LINK_CLICK, IMPRESSION |
TWITTER_VIDEO_VIEWS | VIEW, IMPRESSION, VIEW_3S_100PCT, VIDEO_VIEWS, VIEW_6S |
TWITTER_PREROLL_VIEWS | VIEW, IMPRESSION, VIEW_6S, VIEW_3S_100PCT |
TWITTER_APP_INSTALLS | APP_CLICK, IMPRESSION |
TWITTER_APP_ENGAGEMENTS | APP_CLICK |
targeting
Field Name | Type | Values | Description |
name | String | ||
targetingValues | Map<Enum, List<String>> | Enum keys with String Arrays | A map of TargetField Enums to an array of target-specific values. |
exclusionValues | Map<Enum, List<String>> | Enum keys with String Arrays | A map of TargetField enums to an array of target-specific values. |
flexibleList | List<Map<Enum, List<String>>> | List of maps of Enum keys with Arrays | A list of maps combining multiple flexible targeting criteria. |
TargetField supported values API are AGE, INETEREST, LOCATION, GENDER , MAX_AGE, MIN_AGE
frequency
Field Name | Field Type | Description |
status | String | Current status of the frequency request. |
type | String | Type of frequency control |
value | Integer | Maximum allowed occurrences within the duration. |
durationInDays | int | Duration over which the frequency cap applies (in days). |
event | String | Event type associated with the frequency control. |
Creating Promoted Object
promotedObjectType supported values
Supported Value : APPLICATION
promotedObjectType | String | Type of object being promoted (e.g., product, service). |
promotedObjectId | String | Identifier of the promoted object. |