Enumerations
We expose many different types as enumerations (enums) via the Ads API. While we can’t promise that this is an absolute list of any possible value you could see, we will do our best to add and remove enums as they change and document those here.
Accounts
Related endpoints: GET accounts, GET accounts/:account_id
| approval_status |
|---|
ACCEPTED |
UNDER_REVIEW |
REJECTED |
Analytics
Related endpoints:
| entity |
|---|
ACCOUNT |
FUNDING_INSTRUMENT |
CAMPAIGN |
LINE_ITEM |
PROMOTED_TWEET |
ORGANIC_TWEET |
| metric_groups |
|---|
ENGAGEMENT |
WEB_CONVERSION |
MOBILE_CONVERSION |
MEDIA |
VIDEO |
LIFE_TIME_VALUE_MOBILE_CONVERSION |
BILLING |
| placement |
|---|
ALL_ON_TWITTER |
PUBLISHER_NETWORK |
| status |
|---|
PROCESSING |
SUCCESS |
FAILED |
CANCELLED |
Funding Instruments
Related endpoints: GET accounts/:account_id/funding_instruments, GET accounts/:account_id/funding_instruments/:id
| type |
|---|
INSERTION_ORDER |
CREDIT_LINE |
AGENCY_CREDIT_LINE |
CREDIT_CARD |
PARTNER_MANAGED |
LIVE_TV_EVENT_IO |
| reasons_not_able_to_fund |
|---|
BUDGET_EXHAUSTED |
CREDIT_CARD_APPROVAL_PENDING |
CREDIT_CARD_DELETED |
CREDIT_CARD_REJECTED |
DELETED |
EXPIRED |
PAUSED |
STARTS_IN_FUTURE |
Campaigns
Related endpoints: GET accounts/:account_id/campaigns, GET accounts/:account_id/campaigns/:campaign_id
| reasons_not_servable |
|---|
ACCOUNT_REJECTED |
ACCOUNT_UNDER_REVIEW |
AWAITING_APPROVAL_BY_ADVERTISER |
BUDGET_EXHAUSTED |
CONTENT_REVIEW_PROBLEM |
DELETED |
EXPIRED |
FUNDING_PROBLEM |
INCOMPLETE |
PAUSED_BY_ADVERTISER |
STARTS_IN_FUTURE |
Line Items (Ad Groups)
Related endpoints: POST accounts/:account_id/line_items, PUT accounts/:account_id/line_items/:line_item_id
| bid_unit |
|---|
APP_CLICK |
APP_INSTALL |
ENGAGEMENT |
FOLLOW |
LEAD |
LINK_CLICK |
VIEW |
VIEW_3S_100PCT |
| charge_by |
|---|
APP_CLICK |
APP_INSTALL |
ENGAGEMENT |
FOLLOW |
IMPRESSION |
LEAD |
LINK_CLICK |
VIEW |
| optimization |
Description |
|---|
DEFAULT |
Use the default optimization for this objective. |
ENGAGEMENT |
Optimize for reach with engagements. Only available with the AWARENESS objective. |
WEBSITE_CONVERSIONS |
Optimize for “high-intent” users who exhibit key behaviors signaling a higher likelihood of a website conversion. Only available with the WEBSITE_CLICKS or WEBSITE_CONVERSIONS objectives. |
| placements |
Description |
|---|
ALL_ON_TWITTER |
All possible placement types on Twitter |
TWITTER_SEARCH |
Only search results on Twitter |
TWITTER_TIMELINE |
Only timelines on Twitter |
PUBLISHER_NETWORK |
On the Twitter Audience Platform |
TWITTER_PROFILE |
On Twitter user profiles |
| product_type |
Description |
|---|
MEDIA |
Media creative used for video pre-roll and TAP |
PROMOTED_ACCOUNT |
Promoted Accounts |
PROMOTED_TWEETS |
Promoted Tweets |
LIVE_TV_EVENT |
Mid-roll Video |
| tracking_partner (for tracking_tags) |
Description |
|---|
DOUBLE_CLICK |
Google DoubleClick Campaign Manager |
Tweets / Scoped Timeline
Related endpoints: POST accounts/:account_id/tweet, GET accounts/:account_id/scoped_timeline
Note: These enum values should be used as lowercase
| tweet_mode |
Description |
|---|
compat |
Display the tweet in “classic” mode |
extended |
Display the tweet in “extended” mode |
Promoted Tweets
Related endpoints: GET accounts/:account_id/promoted_tweets, POST accounts/:account_id/promoted_tweets
| approval_status |
|---|
ACCEPTED |
UNDER_REVIEW |
REJECTED |
| display_properties |
|---|
KEN_BURNS_ANIMATION |
SLIDESHOW_ANIMATION |
Tailored Audiences
Related endpoints: GET accounts/:account_id/tailored_audiences, GET accounts/:account_id/tailored_audiences/:id
| reasons_not_targetable |
|---|
PROCESSING |
TOO_SMALL |
UPLOAD_FAILED |
Tailored Audience Changes
Related endpoints: GET accounts/:account_id/tailored_audience_changes, GET accounts/:account_id/tailored_audience_changes/:id
| state |
|---|
UPLOADING |
PROCESSING |
COMPLETED |
FAILED |
Tailored Audience Memberships
Related endpoints: POST tailored_audience_memberships
| membership_type |
|---|
WEB_MEMBERSHIP |
WEB_OPTOUT |
LIST_MEMBERSHIP |
| user_identifier_type |
|---|
TALIST_PARTNER_USER_ID |
TAWEB_PARTNER_USER_ID |
EMAIL |
HANDLE |
TWITTER_ID |
DEVICE_ID |
PHONE_NUMBER |
Targeting
Related endpoints: POST batch/accounts/:account_id/targeting_criteria, POST accounts/:account_id/targeting_criteria
Age
Age targeting is now generally available. To use, set targeting_type=AGE and choose one of the following age buckets as the targeting_value when making a Targeting Criteria create request. Note: It is only possible to target a single age bucket per line item.
The following age buckets are generally available in all locations.
AGE_13_TO_24 |
AGE_13_TO_34 |
AGE_13_TO_49 |
AGE_13_TO_54 |
AGE_OVER_13 |
AGE_18_TO_24 |
AGE_18_TO_34 |
AGE_18_TO_49 |
AGE_18_TO_54 |
AGE_OVER_18 |
AGE_21_TO_34 |
AGE_21_TO_49 |
AGE_21_TO_54 |
AGE_OVER_21 |
AGE_25_TO_49 |
AGE_25_TO_54 |
AGE_OVER_25 |
AGE_35_TO_49 |
AGE_35_TO_54 |
AGE_OVER_35 |
AGE_OVER_50 |
The following age buckets are only available when targeting a location within Japan.
AGE_13_TO_19 |
AGE_13_TO_29 |
AGE_13_TO_39 |
AGE_20_TO_29 |
AGE_20_TO_34 |
AGE_20_TO_39 |
AGE_20_TO_49 |
AGE_OVER_20 |
AGE_30_TO_39 |
AGE_30_TO_49 |
AGE_OVER_30 |
AGE_40_TO_49 |
AGE_OVER_40 |
Event
Related endpoints: GET /targeting_criteria/events
| event_types |
|---|
MUSIC_AND_ENTERTAINMENT |
SPORTS |
HOLIDAY |
CONFERENCE |
OTHER |
Insights
Related endpoints: GET insights/accounts/:account_id, GET insights/accounts/:account_id/available_audiences
| audience_type |
Description |
|---|
ALL_ON_TWITTER |
All users based in the United States. |
ORGANIC |
Set of users who have interacted with organic content belonging to the full promotable (primary) user of the ads account. |
| interaction_type |
|---|
ENGAGEMENT |
IMPRESSION |
CAMPAIGN |
CONVERSION |
Video
Related endpoints:
| reasons_not_servable |
|---|
DMCA_TAKE_DOWN |
ERROR |
NOT_A_VIDEO |
PROCESSING |
VIDEO_INCOMPLETE |
VIDEO_TOO_LONG |
| video_cta |
|---|
WATCH_NOW |
VISIT_SITE |
Creative Types
Related endpoints: POST accounts/:account_id/account_media
| creative_type |
Accepted dimensions |
|---|
BANNER |
width of 320px and height of 50px |
INTERSTITIAL |
width of 320px and height of 480px |
MEDIUM_RECTANGLE |
width of 300px and height of 250px |
BANNER_TABLET |
width of 728px and height of 90px |
INTERSTITIAL_LANDSCAPE |
width of 480px and height of 320px |
INTERSTITIAL_TABLET |
width of 768px and height of 1024px |
INTERSTITIAL_LANDSCAPE_TABLET |
width of 1024px and height of 768px |
PREROLL |
see promoted video for tech specs |
VAST_PREROLL |
URI to a VAST preroll asset (https only) |
App Cards
Related endpoints:
| app_cta |
|---|
BOOK |
CONNECT |
INSTALL |
OPEN |
ORDER |
PLAY |
SHOP |
Web Event Tags
Related endpoints:
| status |
|---|
TRACKING |
UNVERIFIED |
DORMANT |
