Cmdlets for Facebook Ads

Build 24.0.9060

AdCreatives

Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.

Table Specific Information

AdCreatives in Facebook represent a collection of the creatives for specific Ads in Facebook.

Select

When querying ad creatives, either the Id or Target must be used to filter results. The Target may be an ad account, ad set, or ad. For instance:

SELECT * FROM AdCreatives WHERE Target = 'adid'

Columns

Name Type Description
ID [KEY] String The Id of Ad Creative.
Target String The Ad Account Id or Campaign Id to get Ad Sets of.
Name String The name of the Ad Creative.
ApplinkTreatment String Deep link fallback behavior for dynamic product ads if the app is not installed.

The allowed values are deeplink_with_web_fallback, deeplink_with_appstore_fallback, web_only.

Body String The body of the ad.
CallToActionType String The call to action button text and header text of legacy ads.

The allowed values are OPEN_LINK, LIKE_PAGE, SHOP_NOW, PLAY_GAME, INSTALL_APP, USE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, BOOK_TRAVEL, LISTEN_MUSIC, LEARN_MORE, SIGN_UP, DOWNLOAD, WATCH_MORE, NO_BUTTON, CALL_NOW, BUY_NOW, GET_OFFER, GET_OFFER_VIEW, GET_DIRECTIONS, MESSAGE_PAGE, SUBSCRIBE, SELL_NOW, DONATE_NOW, GET_QUOTE, CONTACT_US, RECORD_NOW, VOTE_NOW, REGISTER_NOW, OPEN_MOVIES.

EffectiveInstagramMediaId String The ID of an Instagram post to use in an ad.
EffectiveInstagramStoryId String The ID of an Instagram post to display as an Instagram ad.
ImageHash String Image hash for an image you can use in creatives.
ImageUrl String A URL for the image for this creative. The image specified at this URL will be saved into the ad account's image library.
InstagramActorId String Instagram actor ID.
InstagramPermalinkUrl String Instagram permalink.
InstagramUserId String The ID of an Instagram user for creating ads.
LinkOgId String The Open Graph (OG) ID for the link in this creative if the landing page has OG tags.
LinkUrl String Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL.
ObjectId String The ID of the promoted_object or object that is relevant to the ad and ad type.
ObjectStoryId String The ID of a page post to use in an ad.
ObjectType String The type of object that is being advertised.

The allowed values are APPLICATION, DOMAIN, EVENT, OFFER, PAGE, PHOTO, SHARE, STATUS, STORE_ITEM, VIDEO, INVALID.

ObjectUrl String Destination URL for a link ads not connected to a page.
PageId String The actor ID (Page ID) of this creative.
ProductSetId String The ID of the product set for this creative.
RunStatus String The run status of this creative.

The allowed values are ACTIVE, DELETED.

SourceInstagramMediaId String The ID of an Instagram post for creating ads.
TemplateUrl String The Tracking URL for dynamic product ads.
ThumbnailUrl String The URL to a thumbnail for this creative.
Title String Title for a link ad (not connected to a Page).
UrlTags String A set of query string parameters which will replace or be appended to urls clicked from page post ads, message of the post, and canvas app install creatives only.
UsePageActorOverride Boolean If this is true, we will show the page actor for mobile app ads.
AdLabels String Ad Labels that are associated with this creative.
ObjectStorySpecLinkData String The link data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecPhotoData String The photo data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecVideoData String The video data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTextData String The text data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTemplateData String The template data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
ThumbnailHeight String Rendered height of thumbnails provided in ThumbnailUrl, in pixels. Default 64.
ThumbnailWidth String Rendered width of thumbnails provided in ThumbnailUrl, in pixels. Default 64.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060