Creative data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe creative's name
campaign_idstringNo
group_idstringNo(reference to AdsGroup)
item_idstringNoreferences Commerce Item ID (reference to CommerceItem)
organization_idstringNo
statusenumNoValues: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED
creative_typeenumNoValues: UNSPECIFIED, STANDARD, EXPANDABLE, VIDEO, NATIVE, AUDIO, PUBLISHER_HOSTED, ASSET_BASED, IMAGE, DOCUMENT, SHARE
hosting_sourceenumNoValues: UNSPECIFIED, CM, THIRD_PARTY, HOSTED, RICH_MEDIA, PUBLISHER_HOSTED
widthnumberNo
heightnumberNo
asset_urlsstring[]NoHosted asset mode (best-effort, provider-specific
cardsAdsCreativeCard[]NoCarousel cards, in display order
cards[].asset_urlstringNoSame format as asset_urls (provider asset ref or URL)
cards[].titlestringNo
cards[].descriptionstringNo
cards[].link_urlstringNo
cards[].ctastringNo
link_urlstringNoDestination URL for creatives with links
url_tagsstringNoAppended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template
bodystringNo
titlestringNo
ctastringNo
third_party_tagstringNo
vast_tag_urlstringNo
external_creative_referencestringNo
external_placement_referencestringNo
external_ad_referencestringNo
promotedAdsPromoted[]No
promoted[].idstringYes
promoted[].namestringNo
promoted[].typeenumYesPromoted 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[].metadataAdsMetadata[]No
promoted[].metadata[].idstringNo
promoted[].metadata[].slugstringNo
promoted[].metadata[].valueobjectNo
promoted[].metadata[].namespacestringNo
promoted[].metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
promoted[].metadata[].extra_dataobjectNo
path1stringNoDisplay URL path 1 (Microsoft RSA Path1)
path2stringNoDisplay URL path 2 (Microsoft RSA Path2)
datastringNo
labelsstring[]No
metadataAdsMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type AdsCreative = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The creative's name
	campaign_id?: string;
	group_id?: string; // (reference to AdsGroup)
	item_id?: string; // references Commerce Item ID (reference to CommerceItem)
	organization_id?: string;
	status?: 'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED';
	creative_type?: 'UNSPECIFIED' | 'STANDARD' | 'EXPANDABLE' | 'VIDEO' | 'NATIVE' | 'AUDIO' | 'PUBLISHER_HOSTED' | 'ASSET_BASED' | 'IMAGE' | 'DOCUMENT' | 'SHARE';
	hosting_source?: 'UNSPECIFIED' | 'CM' | 'THIRD_PARTY' | 'HOSTED' | 'RICH_MEDIA' | 'PUBLISHER_HOSTED';
	width?: number;
	height?: number;
	asset_urls?: string[]; // Hosted asset mode (best-effort, provider-specific
	cards?: []; // Carousel cards, in display order
	link_url?: string; // Destination URL for creatives with links
	url_tags?: string; // Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template
	body?: string;
	title?: string;
	cta?: string;
	third_party_tag?: string;
	vast_tag_url?: string;
	external_creative_reference?: string;
	external_placement_reference?: string;
	external_ad_reference?: string;
	promoted?: [];
	path1?: string; // Display URL path 1 (Microsoft RSA Path1)
	path2?: string; // Display URL path 2 (Microsoft RSA Path2)
	data?: string;
	labels?: string[];
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAdsCreative = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The creative's name"),
	campaign_id: z.string().optional(),
	group_id: z.string().optional().describe("(reference to AdsGroup)"),
	item_id: z.string().optional().describe("references Commerce Item ID (reference to CommerceItem)"),
	organization_id: z.string().optional(),
	status: z.enum("UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED").optional(),
	creative_type: z.enum("UNSPECIFIED", "STANDARD", "EXPANDABLE", "VIDEO", "NATIVE", "AUDIO", "PUBLISHER_HOSTED", "ASSET_BASED", "IMAGE", "DOCUMENT", "SHARE").optional(),
	hosting_source: z.enum("UNSPECIFIED", "CM", "THIRD_PARTY", "HOSTED", "RICH_MEDIA", "PUBLISHER_HOSTED").optional(),
	width: z.number().optional(),
	height: z.number().optional(),
	asset_urls: z.array().optional().describe("Hosted asset mode (best-effort, provider-specific"),
	cards: z.array().optional().describe("Carousel cards, in display order"),
	link_url: z.string().optional().describe("Destination URL for creatives with links"),
	url_tags: z.string().optional().describe("Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template"),
	body: z.string().optional(),
	title: z.string().optional(),
	cta: z.string().optional(),
	third_party_tag: z.string().optional(),
	vast_tag_url: z.string().optional(),
	external_creative_reference: z.string().optional(),
	external_placement_reference: z.string().optional(),
	external_ad_reference: z.string().optional(),
	promoted: z.array().optional(),
	path1: z.string().optional().describe("Display URL path 1 (Microsoft RSA Path1)"),
	path2: z.string().optional().describe("Display URL path 2 (Microsoft RSA Path2)"),
	data: z.string().optional(),
	labels: z.array().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AdsCreativeStatus(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	ACTIVE = 'ACTIVE'
	PAUSED = 'PAUSED'
	ARCHIVED = 'ARCHIVED'
	DRAFT = 'DRAFT'
	SCHEDULED_FOR_DELETION = 'SCHEDULED_FOR_DELETION'
	PROCESSING = 'PROCESSING'
	PROCESSING_FAILED = 'PROCESSING_FAILED'

@dataclasses.dataclass
class AdsCreativeCreative_type(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	STANDARD = 'STANDARD'
	EXPANDABLE = 'EXPANDABLE'
	VIDEO = 'VIDEO'
	NATIVE = 'NATIVE'
	AUDIO = 'AUDIO'
	PUBLISHER_HOSTED = 'PUBLISHER_HOSTED'
	ASSET_BASED = 'ASSET_BASED'
	IMAGE = 'IMAGE'
	DOCUMENT = 'DOCUMENT'
	SHARE = 'SHARE'

@dataclasses.dataclass
class AdsCreativeHosting_source(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	CM = 'CM'
	THIRD_PARTY = 'THIRD_PARTY'
	HOSTED = 'HOSTED'
	RICH_MEDIA = 'RICH_MEDIA'
	PUBLISHER_HOSTED = 'PUBLISHER_HOSTED'

@dataclasses.dataclass
class AdsCreative:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The creative's name"""
	name: Optional[str]
	campaign_id: Optional[str]
	"""(reference to AdsGroup)"""
	group_id: Optional[str]
	"""references Commerce Item ID (reference to CommerceItem)"""
	item_id: Optional[str]
	organization_id: Optional[str]
	status: Optional[AdsCreativeStatus]
	creative_type: Optional[AdsCreativeCreative_type]
	hosting_source: Optional[AdsCreativeHosting_source]
	width: Optional[int]
	height: Optional[int]
	"""Hosted asset mode (best-effort, provider-specific"""
	asset_urls: Optional[List[List[str]]]
	"""Carousel cards, in display order"""
	cards: Optional[PropertyAdsCreativeCards]
	"""Destination URL for creatives with links"""
	link_url: Optional[str]
	"""Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template"""
	url_tags: Optional[str]
	body: Optional[str]
	title: Optional[str]
	cta: Optional[str]
	third_party_tag: Optional[str]
	vast_tag_url: Optional[str]
	external_creative_reference: Optional[str]
	external_placement_reference: Optional[str]
	external_ad_reference: Optional[str]
	promoted: Optional[PropertyAdsCreativePromoted]
	"""Display URL path 1 (Microsoft RSA Path1)"""
	path1: Optional[str]
	"""Display URL path 2 (Microsoft RSA Path2)"""
	path2: Optional[str]
	data: Optional[str]
	labels: Optional[List[List[str]]]
	metadata: Optional[PropertyAdsCreativeMetadata]
Are we missing anything? Let us know
Was this page helpful?