Promoted data model

Updated:

Promoted entity (e.g. page, app, product, tweet) for ads create

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

FieldTypeRequiredDescription
idstringYes
namestringNo
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
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 AdsPromoted = {
	id: string;
	name?: string;
	type: '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 entity types for ads_promoted list endpoint
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAdsPromoted = z.object({
	id: z.string(),
	name: z.string().optional(),
	type: z.enum("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").describe("Promoted entity types for ads_promoted list endpoint"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AdsPromotedType(str, Enum):
	PAGE_ID = 'PAGE_ID'
	APP_ID = 'APP_ID'
	STORE_URL = 'STORE_URL'
	PIXEL_ID = 'PIXEL_ID'
	CUSTOM_CONVERSION_ID = 'CUSTOM_CONVERSION_ID'
	CATALOG_ID = 'CATALOG_ID'
	PRODUCT_SET_ID = 'PRODUCT_SET_ID'
	PRIORITIZED_SET_ID = 'PRIORITIZED_SET_ID'
	EVENT_ID = 'EVENT_ID'
	OFFER_ID = 'OFFER_ID'
	LEAD_FORM_ID = 'LEAD_FORM_ID'
	MESSAGING_CHANNEL_ID = 'MESSAGING_CHANNEL_ID'
	PRODUCT_ID = 'PRODUCT_ID'
	TWEET_ID = 'TWEET_ID'
	AD_GROUP_TYPE = 'AD_GROUP_TYPE'

@dataclasses.dataclass
class AdsPromoted:
	id: str
	name: Optional[str]
	"""Promoted entity types for ads_promoted list endpoint"""
	type: AdsPromotedType
	metadata: Optional[PropertyAdsPromotedMetadata]
Are we missing anything? Let us know
Was this page helpful?