Creative 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 creative's name |
campaign_id | string | No | |
group_id | string | No | (reference to AdsGroup) |
item_id | string | No | references Commerce Item ID (reference to CommerceItem) |
organization_id | string | No | |
status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
creative_type | enum | No | Values: UNSPECIFIED, STANDARD, EXPANDABLE, VIDEO, NATIVE, AUDIO, PUBLISHER_HOSTED, ASSET_BASED, IMAGE, DOCUMENT, SHARE |
hosting_source | enum | No | Values: UNSPECIFIED, CM, THIRD_PARTY, HOSTED, RICH_MEDIA, PUBLISHER_HOSTED |
width | number | No | |
height | number | No | |
asset_urls | string[] | No | Hosted asset mode (best-effort, provider-specific |
cards | AdsCreativeCard[] | No | Carousel cards, in display order |
cards[].asset_url | string | No | Same format as asset_urls (provider asset ref or URL) |
cards[].title | string | No | |
cards[].description | string | No | |
cards[].link_url | string | No | |
cards[].cta | string | No | |
link_url | string | No | Destination URL for creatives with links |
url_tags | string | No | Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template |
body | string | No | |
title | string | No | |
cta | string | No | |
third_party_tag | string | No | |
vast_tag_url | string | No | |
external_creative_reference | string | No | |
external_placement_reference | string | No | |
external_ad_reference | 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 | |
path1 | string | No | Display URL path 1 (Microsoft RSA Path1) |
path2 | string | No | Display URL path 2 (Microsoft RSA Path2) |
data | string | No | |
labels | 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?