Ad data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The ad's name |
campaign_id | string | No | |
group_id | string | No | (reference to AdsGroup) |
organization_id | string | No | |
status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
ad_type | enum | No | Values: TEXT, IMAGE, VIDEO, RESPONSIVE, SHOPPING, APP, CALL, CAROUSEL, SOCIAL, DISPLAY, SEARCH, AUDIO, YOUTUBE, NATIVE, CTV, DOOH, PERFORMANCE_MAX |
advertiser_name | string | No | |
creative_ids | string[] | No | |
creative_asset_url | string | No | |
ad_copy | string | No | |
headline | string | No | |
description | string | No | |
cta | string | No | |
final_url | string | No | |
display_url | string | No | |
path1 | string | No | |
path2 | string | No | |
promoted | AdsPromoted[] | No | |
promoted[].id | string | Yes | |
promoted[].name | string | No | |
promoted[].type | enum | Yes | Promoted entity types for ads_promoted list endpoint Values: PAGE_ID, APP_ID, STORE_URL, PIXEL_ID, CUSTOM_CONVERSION_ID, CATALOG_ID, PRODUCT_SET_ID, PRIORITIZED_SET_ID, EVENT_ID, OFFER_ID, LEAD_FORM_ID, MESSAGING_CHANNEL_ID, PRODUCT_ID, TWEET_ID, AD_GROUP_TYPE |
promoted[].metadata | AdsMetadata[] | No | |
promoted[].metadata[].id | string | No | |
promoted[].metadata[].slug | string | No | |
promoted[].metadata[].value | object | No | |
promoted[].metadata[].namespace | string | No | |
promoted[].metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
promoted[].metadata[].extra_data | object | No | |
logo_creative_id | string | No | |
metadata | AdsMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?