Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 2.77 KB

File metadata and controls

31 lines (23 loc) · 2.77 KB

AdCreative

Platform-specific creative data. Fields vary by platform.

Properties

Name Type Description Notes
thumbnailUrl String Primary thumbnail/image URL [optional]
imageUrl String Alternative image URL [optional]
videoId String Meta video ID for VIDEO-type ads. Null for non-video ads. Callers that need an embeddable MP4 can call GET /{videoId}?fields=source with the page access token. [optional]
videoUrl String Public Facebook watch URL for VIDEO-type ads (https://www.facebook.com/watch/?v={videoId}). Null for non-video ads. [optional]
objectType String Meta creative object_type (e.g. SHARE, VIDEO, PRIVACY_CHECK_FAIL, POST_DELETED). Use this to render state-aware previews — when Meta moderation strips image/video fields, only thumbnailUrl at 64x64 is available. [optional]
objectStoryId String Meta creative `object_story_id` (the SHARE reference). Frequently absent — Meta omits it for SHARE creatives. Use effectiveObjectStoryId instead. [optional]
effectiveObjectStoryId String Meta `effective_object_story_id` — `{pageId}_{postId}` of the Facebook post the ad's engagement (comments) lives on. Pass to GET /v1/ads?effectiveObjectStoryId= to map a Business-Manager-visible post back to this ad; GET /v1/ads/{adId}/comments resolves comments against it. [optional]
effectiveInstagramMediaId String Meta `effective_instagram_media_id` — the Instagram media ID of the boosted post the ad's engagement lives on. Pass to GET /v1/ads?effectiveInstagramMediaId= to map a Business-Manager-visible IG post back to this ad. [optional]
instagramUserId String Meta `instagram_user_id` — the Instagram-scoped business ID that owns the boosted media. [optional]
instagramPermalinkUrl String Meta `instagram_permalink_url` — public Instagram post URL of the boosted media. [optional]
mediaUrls List<String> All media URLs for this ad (carousel images, multiple assets). Populated for Meta (carousel child_attachments), Google Ads (responsive display marketing_images), and LinkedIn (multi-image posts). [optional]
body String Ad copy/text [optional]
googleHeadline String Google Ads headline [optional]
googleDescription String Google Ads description [optional]
linkUrl String Destination URL [optional]
pinterestImageUrl String [optional]
pinterestTitle String [optional]
pinterestDescription String [optional]