Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

account_id

decimal

itgen_facebook_account_id

☐

Account ID.

actor_id

int32

itgen_facebook_actor_id

☐

The actor ID (Page ID) of this creative.

adlabels

string

itgen_facebook_adlabels

☐

List of Ad Labels that are associated with this creative.

applink_treatment

string

itgen_facebook_applink_treatment

☐

Deep link fallback behavior for dynamic product ads if the app is not installed: deeplink_with_web_fallback, deeplink_with_appstore_fallback, web_only.

asset_feed_spec_ad_formats

string

itgen_facebook_asset_feed_spec_ad_formats

☐

List of ad format spec in asset feed spec.

asset_feed_spec_asset_customization_rules

string

itgen_facebook_asset_feed_spec_asset_customization_rules

☐

List of Target rules spec in asset feed spec.

asset_feed_spec_autotranslate

string

itgen_facebook_asset_feed_spec_autotranslate

☐

List of auto translated languages.

asset_feed_spec_bodies

string

itgen_facebook_asset_feed_spec_bodies

☐

List of ad body asset spec in asset feed spec.

asset_feed_spec_call_to_action_types

string

itgen_facebook_asset_feed_spec_call_to_action_types

☐

List of ad call to action spec in asset feed spec: OPEN_LINK, LIKE_PAGE, SHOP_NOW, PLAY_GAME, INSTALL_APP, USE_APP, CALL, CALL_ME, INSTALL_MOBILE_APP, USE_MOBILE_APP, MOBILE_DOWNLOAD, BOOK_TRAVEL, LISTEN_MUSIC, WATCH_VIDEO, LEARN_MORE, SIGN_UP, DOWNLOAD, WATCH_MORE, NO_BUTTON, VISIT_PAGES_FEED, APPLY_NOW, BUY_NOW, GET_OFFER, GET_OFFER_VIEW, BUY_TICKETS, UPDATE_APP, GET_DIRECTIONS, BUY, MESSAGE_PAGE, DONATE, SUBSCRIBE, SAY_THANKS, SELL_NOW, SHARE, DONATE_NOW, GET_QUOTE, CONTACT_US, ORDER_NOW, ADD_TO_CART, VIDEO_ANNOTATION, MOMENTS, RECORD_NOW, GET_SHOWTIMES, LISTEN_NOW, WOODHENGE_SUPPORT, EVENT_RSVP, WHATSAPP_MESSAGE, FOLLOW_NEWS_STORYLINE, SEE_MORE.

asset_feed_spec_captions

string

itgen_facebook_asset_feed_spec_captions

☐

List of ad caption asset spec in asset feed spec.

asset_feed_spec_descriptions

string

itgen_facebook_asset_feed_spec_descriptions

☐

List of ad description asset spec in asset feed spec.

asset_feed_spec_groups

string

itgen_facebook_asset_feed_spec_groups

☐

List of groups spec in asset feed spec.

asset_feed_spec_images

string

itgen_facebook_asset_feed_spec_images

☐

List of ad image asset spec in asset feed spec.

asset_feed_spec_link_urls

string

itgen_facebook_asset_feed_spec_link_urls

☐

List of ad link urls asset spec in asset feed spec.

asset_feed_spec_optimization_type

string

itgen_facebook_asset_feed_spec_optimization_type

☐

Optimization type (for language, placement, etc) used in asset feed.

asset_feed_spec_titles

string

itgen_facebook_asset_feed_spec_titles

☐

List of ad title asset spec in asset feed spec.

asset_feed_spec_videos

string

itgen_facebook_asset_feed_spec_videos

☐

List of ad video asset spec in asset feed spec.

body

string

itgen_facebook_body

☐

The body of the ad. Not supported for video post creatives.

branded_content_sponsor_page_id

decimal

itgen_facebook_branded_content_sponsor_page_id

☐

Branded Content sponsor ID, creating ads using existing BC posts.

call_to_action_type

string

itgen_facebook_call_to_action_type

☐

The call to action button text and header text of legacy ads: OPEN_LINK, LIKE_PAGE, SHOP_NOW, PLAY_GAME, INSTALL_APP, USE_APP, CALL, CALL_ME, INSTALL_MOBILE_APP, USE_MOBILE_APP, MOBILE_DOWNLOAD, BOOK_TRAVEL, LISTEN_MUSIC, WATCH_VIDEO, LEARN_MORE, SIGN_UP, DOWNLOAD, WATCH_MORE, NO_BUTTON, VISIT_PAGES_FEED, APPLY_NOW, BUY_NOW, GET_OFFER, GET_OFFER_VIEW, BUY_TICKETS, UPDATE_APP, GET_DIRECTIONS, BUY, MESSAGE_PAGE, DONATE, SUBSCRIBE, SAY_THANKS, SELL_NOW, SHARE, DONATE_NOW, GET_QUOTE, CONTACT_US, ORDER_NOW, ADD_TO_CART, VIDEO_ANNOTATION, MOMENTS, RECORD_NOW, GET_SHOWTIMES, LISTEN_NOW, WOODHENGE_SUPPORT, EVENT_RSVP, WHATSAPP_MESSAGE, FOLLOW_NEWS_STORYLINE, SEE_MORE.

effective_instagram_story_id

decimal

itgen_facebook_effective_instagram_story_id

☐

The ID of an Instagram post to use in an ad.

effective_object_story_id

string

itgen_facebook_effective_object_story_id

☐

The ID of a page post to use in an ad, regardless of whether it's an organic or unpublished page post.

id

decimal

ID

☐

The ID of this creative.

image_crops_100x100

string

itgen_facebook_image_crops_100x100

☐

Crop specification for 100x100.

image_crops_100x72

string

itgen_facebook_image_crops_100x72

☐

Crop specification for 100x72.

image_crops_191x100

string

itgen_facebook_image_crops_191x100

☐

Crop specification for 191x100.

image_crops_400x150

string

itgen_facebook_image_crops_400x150

☐

Crop specification for 400x150.

image_crops_400x500

string

itgen_facebook_image_crops_400x500

☐

Crop specification for 400x500.

image_crops_600x360

string

itgen_facebook_image_crops_600x360

☐

Crop specification for 600x360.

image_crops_90x160

string

itgen_facebook_image_crops_90x160

☐

Crop specification for 90x160.

image_hash

string

itgen_facebook_image_hash

☐

Image hash for an image you can use in creatives. If provided do not provide image_url. See image library for more details.

image_url

string

itgen_facebook_image_url

☐

A URL for the image for this creative. We save the image at this URL to the ad account's image library. If provided do not include image_hash.

instagram_actor_id

decimal

itgen_facebook_instagram_actor_id

☐

Instagram actor ID.

instagram_permalink_url

string

itgen_facebook_instagram_permalink_url

☐

Instagram permalink.

instagram_story_id

decimal

itgen_facebook_instagram_story_id

☐

The ID of an Instagram post for creating ads. This field will be deprecated in the future. Use SOURCE_INSTAGRAM_STORY_ID.

link_og_id

int32

itgen_facebook_link_og_id

☐

The Open Graph (OG) ID for the link in this creative if the landing page has OG tags.

link_url

string

itgen_facebook_link_url

☐

Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL. See connection objects for retrieving Page tabs' URLs. The likes tab is not supported. app_data parameters may be added to the url to pass data to a tab app.

messenger_sponsored_message

string

itgen_facebook_messenger_sponsored_message

☐

The JSON string of messenger sponsored message for this creative. See (docs/messenger-platform/reference/send-api) for more detail.

name

string

Name

☐

The name of the creative in the creative library.

object_id

int32

Object ID

☐

The ID of the promoted_object or object that is relevant to the ad and ad type.

object_story_id

int32

itgen_facebook_object_story_id

☐

The ID of a page post to use in an ad. This ID can be retrieved by using the graph API to query the posts of the page. If an image is used in the post, it will be downloaded and available in your account's image library. If you create an unpublished page post inline via object_story_spec at the same time as creating the ad, this ID will be null. However the effective_object_story_id will be the ID of the page post regardless of whether it's an organic or unpublished page post.

object_story_spec_instagram_actor_id

decimal

itgen_facebook_object_story_spec_instagram_actor_id

☐

The Instagram user account that the story will be posted to.

object_story_spec_page_id

decimal

itgen_facebook_object_story_spec_page_id

☐

ID of a Facebook page. An unpublished page post will be created on this page. User must have Admin or Editor role for this page.

object_type

string

itgen_facebook_object_type

☐

The type of object that is being advertised. Allowed values are: PAGE, DOMAIN, EVENT, STORE_ITEM: refers to an iTunes or Google Play store destination, SHARE: from a page, PHOTO, STATUS: of a page, VIDEO, APPLICATION: app on Facebook, INVALID: when an invalid object_id was specified such as a deleted object or if you do not have permission to see the object.In very few cases, this field may be empty if Facebook is unable to identify the type of advertised object.

object_url

string

itgen_facebook_object_url

☐

Destination URL for a link ads not connected to a page.

product_set_id

int32

itgen_facebook_product_set_id

☐

The ID of the product set for this creative. See dynamic product ads for more detail.

status

string

itgen_facebook_status

☐

The status of this creative: ACTIVE, DELETED.

template_url

string

itgen_facebook_template_url

☐

The Tracking URL for dynamic product ads. See dynamic product ads for more detail.

thumbnail_url

string

itgen_facebook_thumbnail_url

☐

The URL to a thumbnail for this creative. You can optionally request dimensions of this thumbnail by providing the thumbnail_width and thumbnail_height parameters. See example for more detail.

title

string

itgen_facebook_title

☐

Title for a link ad (not connected to a Page).

url_tags

string

itgen_facebook_url_tags

☐

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.

use_page_actor_override

boolean

itgen_facebook_use_page_actor_override

☐

If this is true, we will show the page actor for mobile app ads.

video_id

decimal

itgen_facebook_video_id

☐

The ID of the video in this creative.