| Field |
Type |
Description |
campaign_id |
INTEGER |
ID of the ad campaign that contains this ad |
id |
INTEGER |
The ID of this ad. https://developers.facebook.com/docs/marketing-api/reference/ad-account/ads/ |
account_id |
INTEGER |
The ID of the ad account that this ad belongs to. |
name |
STRING |
Name of the ad. |
created_time |
INTEGER |
Created time of the ad. |
campaign |
RECORD |
https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group/ |
campaign.id |
INTEGER |
ID of the ad campaign that contains this ad |
campaign.name |
STRING |
Name for this campaign |
campaign.buying_type |
STRING |
Buying type, possible values are: AUCTION: default RESERVED: for reach and frequency ads. |
campaign.objective |
STRING |
Campaign's objective |
adset |
RECORD |
https://developers.facebook.com/docs/marketing-api/reference/ad-campaign/ |
adset.id |
INTEGER |
ID of the ad set that contains the ad |
adset.delivery_estimate.data |
RECORD |
|
adset.delivery_estimate.data.estimate_ready |
BOOLEAN |
|
adset.delivery_estimate.data.estimate_mau |
INTEGER |
|
adset.delivery_estimate.data.estimate_dau |
INTEGER |
|
adset.delivery_estimate.data.daily_outcomes_curve |
RECORD |
|
adset.delivery_estimate.data.daily_outcomes_curve.actions |
FLOAT |
|
adset.delivery_estimate.data.daily_outcomes_curve.impressions |
FLOAT |
|
adset.delivery_estimate.data.daily_outcomes_curve.reach |
FLOAT |
|
adset.delivery_estimate.data.daily_outcomes_curve.spend |
INTEGER |
|
adset.billing_event |
STRING |
The billing event that this adset is using: APP_INSTALLS: Pay when people install your app. CLICKS: Pay when people click anywhere in the ad. IMPRESSIONS: Pay when the ads are shown to people. LINK_CLICKS: Pay when people click on the link of the ad. OFFER_CLAIMS: Pay when people claim the offer. PAGE_LIKES: Pay when people like your page. POST_ENGAGEMENT: Pay when people engage with your post. VIDEO_VIEWS: Pay when people watch videos. |
adset.daily_budget |
INTEGER |
The daily budget of the set defined in your account currency. |
adset.name |
STRING |
Name of ad set |
adset.optimization_goal |
STRING |
|
adset.promoted_object |
RECORD |
The object this ad set is promoting across all its ads. https://developers.facebook.com/docs/marketing-api/reference/ad-promoted-object/ |
adset.promoted_object.application_id |
INTEGER |
The ID of a Facebook Application. Usually related to mobile or canvas games being promoted on Facebook for installs or engagement |
adset.promoted_object.custom_event_type |
STRING |
The event from an App Event of a mobile app, or tag of an conversion pixel. |
adset.promoted_object.event_id |
INTEGER |
The ID of a Facebook Event |
adset.promoted_object.object_store_url |
STRING |
The uri of the mobile / digital store where an application can be bought / downloaded. This is platform specific. When combined with the "application_id" this uniquely specifies an object which can be the subject of a Facebook advertising campaign. |
adset.promoted_object.offer_id |
INTEGER |
The ID of an Offer from a Facebook Page. |
adset.promoted_object.page_id |
INTEGER |
The ID of a Facebook Page |
adset.promoted_object.pixel_id |
INTEGER |
The ID of a Facebook conversion pixel. Used with offsite conversion campaigns. |
adset.promoted_object.pixel_rule |
STRING |
|
adset.promoted_object.place_page_set_id |
INTEGER |
|
adset.promoted_object.product_catalog_id |
INTEGER |
The ID of a Product Catalog. Used with Dynamic Product Ads. |
adset.promoted_object.product_set_id |
INTEGER |
The ID of a Product Set within a Campaign Group level Product Catalog. Used with Dynamic Product Ads. |
creative |
RECORD |
https://developers.facebook.com/docs/marketing-api/reference/ad-creative |
creative.id |
INTEGER |
The ID of this creative |
creative.applink_treatment |
STRING |
Deep link fallback behavior for dynamic product ads if the app is not installed. |
creative.body |
STRING |
The body of the ad |
creative.call_to_action_type |
STRING |
The call to action button text and header text of legacy ads. |
creative.instagram_actor_id |
INTEGER |
Instagram actor ID |
creative.instagram_permalink_url |
STRING |
Instagram permalink |
creative.instagram_story_id |
INTEGER |
The ID of an Instagram post for creating ads. |
creative.link_og_id |
INTEGER |
The Open Graph (OG) ID for the link in this creative if the landing page has OG tags |
creative.link_url |
STRING |
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 |
creative.name |
STRING |
The name of the creative in the creative library. Ad Creative names should be unique. |
creative.object_id |
INTEGER |
The ID of the promoted_object or object that is relevant to the ad and ad type |
creative.object_story_id |
STRING |
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 an unpublished page post was used to create the ad, this ID will be null, but the effective_object_story_id will be the ID of the page post regardless of whether it's an organic or unpublished page post. |
creative.object_url |
STRING |
Destination URL for a link ads not connected to a page |
creative.object_type |
STRING |
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 |
creative.effective_object_story_id |
STRING |
The ID of a page post to use in an ad, regardless of whether it's an organic or unpublished page post. |
creative.product_set_id |
INTEGER |
The ID of the product set for this creative. See dynamic product ads for more detail |
creative.template_url |
STRING |
The Tracking URL for dynamic product ads. See dynamic product ads for more detail |
creative.object_story_spec |
RECORD |
JSON string of AdCreativeObjectStorySpec type. The page id and the content to create a new unpublished page post specified using one of link_data, photo_data, video_data, text_data or template_data. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-object-story-spec/ |
creative.object_story_spec.instagram_actor_id |
INTEGER |
The Instagram user account that the story will be posted to |
creative.object_story_spec.page_id |
INTEGER |
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. |
creative.object_story_spec.link_data |
RECORD |
The spec for a link page post or carousel ad https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data/ |
creative.object_story_spec.link_data.link |
STRING |
Link url. See post for more info. This field is required for a carousel ad . |
creative.object_story_spec.link_data.app_link_spec |
RECORD |
Native deeplinks attached to the post https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data-app-link-spec/ |
creative.object_story_spec.link_data.app_link_spec.android |
RECORD |
Native deeplinks to use on Android https://developers.facebook.com/docs/graph-api/reference/android-app-link/ |
creative.object_story_spec.link_data.app_link_spec.android.url |
STRING |
The native Android URL that will be navigated to. |
creative.object_story_spec.link_data.app_link_spec.ios |
RECORD |
Native deeplinks to use on iOS https://developers.facebook.com/docs/graph-api/reference/ios-app-link/ |
creative.object_story_spec.link_data.app_link_spec.ios.url |
STRING |
The native iOS URL that will be navigated to. |
creative.object_story_spec.link_data.app_link_spec.ipad |
RECORD |
Native deeplinks to use on iPad https://developers.facebook.com/docs/graph-api/reference/ios-app-link/ |
creative.object_story_spec.link_data.app_link_spec.ipad.url |
STRING |
The native iOS URL that will be navigated to. |
creative.object_story_spec.link_data.app_link_spec.iphone |
RECORD |
Native deeplinks to use on iPhone |
creative.object_story_spec.link_data.app_link_spec.iphone.url |
STRING |
The native iOS URL that will be navigated to. |
creative.object_story_spec.link_data.call_to_action |
RECORD |
An optional call to action button. If not specified, on Instagram, a default CTA would be used, {"type":"LEARN_MORE","value": {"link":<LINK VALUE OF LINK_DATA>,}}. Note that LIKE_PAGE is not supported. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data-call-to-action/ |
creative.object_story_spec.link_data.call_to_action.type |
STRING |
The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used based on the objective of your campaign. |
creative.object_story_spec.link_data.call_to_action.value |
RECORD |
RECORD-field containing the call to action data. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data-call-to-action-value/ |
creative.object_story_spec.link_data.call_to_action.value.app_link |
STRING |
Deep link to the app. |
creative.object_story_spec.link_data.call_to_action.value.application |
INTEGER |
Application related to the action. |
creative.object_story_spec.link_data.call_to_action.value.event_id |
INTEGER |
ID of the Facebook event which the attachement show event info |
creative.object_story_spec.link_data.call_to_action.value.lead_gen_form_id |
INTEGER |
The Lead Ad form id. |
creative.object_story_spec.link_data.call_to_action.value.link |
STRING |
The destination link when the CTA button is clicked. |
creative.object_story_spec.link_data.call_to_action.value.page |
STRING |
ID of the Facebook page which the CTA button links to |
creative.object_story_spec.link_data.call_to_action.value.product_link |
STRING |
Open graph object url for canvas virtual good ads. |
creative.object_story_spec.link_data.child_attachments |
RECORD |
A 2-5 element array of link objects required for carousel ads. If multi_share_optimized is set to true, this array could have up to 10 objects. Facebook will automatically optimize the order in which the carousel cards are shown and display the top 5. We strongly recommend that you use at least 3 attachments for achieving optimal performance; allowing minimum of 2 attachments is for enabling lightweight integrations and using 2 objects might result in sub-optimal campaign results. If this ad creative is used for an Instagram Carousel ad, you will need to have at least 3 attachments for MOBILE_APP_INSTALLS ads and 2 for the other objectives. If more than 5 are given, only the first 5 will be shown on Instagram, even if multi_share_optimized is true. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data-child-attachment/ |
creative.object_story_spec.link_data.child_attachments.name |
STRING |
Overwrites the title of the attachment on Facebook, not used on Instagram. |
creative.object_story_spec.link_data.child_attachments.link |
STRING |
The link of this attachment. |
creative.object_story_spec.link_data.child_attachments.caption |
STRING |
The display url shown at the end of a video, if the attachment is a video |
creative.object_story_spec.link_data.child_attachments.video_id |
INTEGER |
ID of an uploaded video, if this attachment is a video. Not supported for Instagram ads. |
creative.object_story_spec.link_data.child_attachments.call_to_action |
RECORD |
Call to action of this attachment. On Facebook supports one optional CTA per attachment. If it not specified, there will be no CTA for this attachment. On Instagram, there is one CTA per attachment. If the CTA is not specified, a CTA will be created by the system, using "Learn more" as the type, and the link from this child attachment as the link. If the CTA is specified, its link must be the same as the link of this child attachment. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data-call-to-action/ |
creative.object_story_spec.link_data.child_attachments.call_to_action.type |
STRING |
The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used based on the objective of your campaign. |
creative.object_story_spec.link_data.child_attachments.call_to_action.value |
RECORD |
RECORD-field containing the call to action data. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data-call-to-action-value/ |
creative.object_story_spec.link_data.child_attachments.call_to_action.value.app_link |
STRING |
Deep link to the app. |
creative.object_story_spec.link_data.child_attachments.call_to_action.value.application |
INTEGER |
Application related to the action. |
creative.object_story_spec.link_data.child_attachments.call_to_action.value.event_id |
INTEGER |
ID of the Facebook event which the attachement show event info |
creative.object_story_spec.link_data.child_attachments.call_to_action.value.lead_gen_form_id |
INTEGER |
The Lead Ad form id. |
creative.object_story_spec.link_data.child_attachments.call_to_action.value.link |
STRING |
The destination link when the CTA button is clicked. |
creative.object_story_spec.link_data.child_attachments.call_to_action.value.page |
STRING |
ID of the Facebook page which the CTA button links to |
creative.object_story_spec.link_data.child_attachments.call_to_action.value.product_link |
STRING |
Open graph object url for canvas virtual good ads. |
creative.object_story_spec.photo_data |
RECORD |
The spec for a photo page post. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-photo-data/ |
creative.object_story_spec.photo_data.branded_content_sponsor_page_id |
INTEGER |
The branded content sponsor page ID. If your ad promotes branded content, you must use this to indicate the sponsor page. Your sponsor will be notified and can create an ad using your post. Your sponsor can also see metrics about your ad, including total spend and CPM metrics |
creative.object_story_spec.photo_data.url |
STRING |
URL of an image to use in the ad. Specify this field or image_hash but not both. The image specified at the URL will be saved into the ad accounts image library |
creative.object_story_spec.video_data |
RECORD |
The spec for a video page post. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-video-data/ |
creative.object_story_spec.video_data.branded_content_sponsor_page_id |
INTEGER |
The branded content sponsor page id. |
creative.object_story_spec.video_data.video_id |
INTEGER |
ID of video that user has permission to or a video in ad account video library. |
creative.object_story_spec.video_data.call_to_action |
RECORD |
An optional call to action. Additionally you can specify a LIKE_PAGE call to action when the ad is in a PAGE_LIKES campaign. |
creative.object_story_spec.video_data.call_to_action.type |
STRING |
The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used based on the objective of your campaign. |
creative.object_story_spec.video_data.call_to_action.value |
RECORD |
RECORD-field containing the call to action data. |
creative.object_story_spec.video_data.call_to_action.value.app_link |
STRING |
Deep link to the app. |
creative.object_story_spec.video_data.call_to_action.value.application |
INTEGER |
Application related to the action. |
creative.object_story_spec.video_data.call_to_action.value.event_id |
INTEGER |
ID of the Facebook event which the attachement show event info |
creative.object_story_spec.video_data.call_to_action.value.lead_gen_form_id |
INTEGER |
The Lead Ad form id. |
creative.object_story_spec.video_data.call_to_action.value.link |
STRING |
The destination link when the CTA button is clicked. |
creative.object_story_spec.video_data.call_to_action.value.page |
STRING |
ID of the Facebook page which the CTA button links to |
creative.object_story_spec.video_data.call_to_action.value.product_link |
STRING |
Open graph object url for canvas virtual good ads. |
creative.object_story_spec.template_data |
RECORD |
The spec for a template link page post as used in Dynamic Product Ads. |
creative.object_story_spec.template_data.branded_content_sponsor_page_id |
INTEGER |
The branded content sponsor page id. |
creative.object_story_spec.template_data.app_link_spec |
RECORD |
Native deeplinks attached to the post https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data-app-link-spec/ |
creative.object_story_spec.template_data.app_link_spec.android |
RECORD |
Native deeplinks to use on Android |
creative.object_story_spec.template_data.app_link_spec.android.url |
STRING |
The native Android URL that will be navigated to. |
creative.object_story_spec.template_data.app_link_spec.ios |
RECORD |
Native deeplinks to use on iOS |
creative.object_story_spec.template_data.app_link_spec.ios.url |
STRING |
Native deeplinks to use on iOS https://developers.facebook.com/docs/graph-api/reference/ios-app-link/ |
creative.object_story_spec.template_data.app_link_spec.ipad |
RECORD |
Native deeplinks to use on iPad |
creative.object_story_spec.template_data.app_link_spec.ipad.url |
STRING |
Native deeplinks to use on iPad https://developers.facebook.com/docs/graph-api/reference/ios-app-link/ |
creative.object_story_spec.template_data.app_link_spec.iphone |
RECORD |
Native deeplinks to use on iPhone |
creative.object_story_spec.template_data.app_link_spec.iphone.url |
STRING |
The native iOS URL that will be navigated to. |
creative.object_story_spec.template_data.call_to_action |
RECORD |
An optional call to action button. If not specified, on Instagram, a default CTA would be used, {"type":"LEARN_MORE","value": {"link":<LINK VALUE OF LINK_DATA>,}}. Note that LIKE_PAGE is not supported. |
creative.object_story_spec.template_data.call_to_action.type |
STRING |
The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used based on the objective of your campaign. |
creative.object_story_spec.template_data.call_to_action.value |
RECORD |
RECORD-field containing the call to action data. |
creative.object_story_spec.template_data.call_to_action.value.app_link |
STRING |
Deep link to the app. |
creative.object_story_spec.template_data.call_to_action.value.application |
INTEGER |
Application related to the action. |
creative.object_story_spec.template_data.call_to_action.value.event_id |
INTEGER |
ID of the Facebook event which the attachement show event info |
creative.object_story_spec.template_data.call_to_action.value.lead_gen_form_id |
INTEGER |
The Lead Ad form id. |
creative.object_story_spec.template_data.call_to_action.value.link |
STRING |
The destination link when the CTA button is clicked. |
creative.object_story_spec.template_data.call_to_action.value.page |
STRING |
ID of the Facebook page which the CTA button links to |
creative.object_story_spec.template_data.call_to_action.value.product_link |
STRING |
Open graph object url for canvas virtual good ads. |
creative.object_story_spec.template_data.child_attachments |
RECORD |
A 2-5 element array of link objects required for carousel ads. If multi_share_optimized is set to true, this array could have up to 10 objects. Facebook will automatically optimize the order in which the carousel cards are shown and display the top 5. We strongly recommend that you use at least 3 attachments for achieving optimal performance; allowing minimum of 2 attachments is for enabling lightweight integrations and using 2 objects might result in sub-optimal campaign results. If this ad creative is used for an Instagram Carousel ad, you will need to have at least 3 attachments for MOBILE_APP_INSTALLS ads and 2 for the other objectives. If more than 5 are given, only the first 5 will be shown on Instagram, even if multi_share_optimized is true. |
creative.object_story_spec.template_data.child_attachments.name |
STRING |
Overwrites the title of the attachment on Facebook, not used on Instagram. |
creative.object_story_spec.template_data.child_attachments.link |
STRING |
The link of this attachment. |
creative.object_story_spec.template_data.child_attachments.caption |
STRING |
The display url shown at the end of a video, if the attachment is a video |
creative.object_story_spec.template_data.child_attachments.video_id |
INTEGER |
ID of an uploaded video, if this attachment is a video. Not supported for Instagram ads. |
creative.object_story_spec.template_data.child_attachments.call_to_action |
RECORD |
Call to action of this attachment. On Facebook, we support one optional CTA per attachment. If it not specified, there will be no CTA for this attachment. On Instagram, there is one CTA per attachment. If the CTA is not specified, a CTA will be created by the system, using "Learn more" as the type, and the link from this child attachment as the link. If the CTA is specified, its link must be the same as the link of this child attachment. |
creative.object_story_spec.template_data.child_attachments.call_to_action.type |
STRING |
The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used based on the objective of your campaign. |
creative.object_story_spec.template_data.child_attachments.call_to_action.value |
RECORD |
RECORD-field containing the call to action data. |
creative.object_story_spec.template_data.child_attachments.call_to_action.value.app_link |
STRING |
Deep link to the app. |
creative.object_story_spec.template_data.child_attachments.call_to_action.value.application |
INTEGER |
Application related to the action. |
creative.object_story_spec.template_data.child_attachments.call_to_action.value.event_id |
INTEGER |
ID of the Facebook event which the attachement show event info |
creative.object_story_spec.template_data.child_attachments.call_to_action.value.lead_gen_form_id |
INTEGER |
The Lead Ad form id. |
creative.object_story_spec.template_data.child_attachments.call_to_action.value.link |
STRING |
The destination link when the CTA button is clicked. |
creative.object_story_spec.template_data.child_attachments.call_to_action.value.page |
STRING |
ID of the Facebook page which the CTA button links to |
creative.object_story_spec.template_data.child_attachments.call_to_action.value.product_link |
STRING |
Open graph object url for canvas virtual good ads. |
creative.object_story_spec.text_data |
RECORD |
The spec for a text page post. https://developers.facebook.com/docs/marketing-api/reference/ad-creative-text-data/ |
creative.object_story_spec.text_data.message |
STRING |
The text of the page post. |
creative.url_tags |
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. |
insights |
RECORD |
|
insights.data |
RECORD |
https://developers.facebook.com/docs/marketing-api/insights/fields/ |
insights.data.clicks |
INTEGER |
The number of clicks on your ads. |
insights.data.reach |
INTEGER |
The number of people who saw your ads at least once. Reach is different from impressions, which may include multiple views of your ads by the same people. |
insights.data.spend |
FLOAT |
The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. |
insights.data.impressions |
INTEGER |
The number of times your ads were viewed. |
insights.data.inline_link_clicks |
INTEGER |
The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window. |
insights.data.inline_post_engagement |
INTEGER |
The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window. |
insights.data.relevance_score |
RECORD |
A rating from 1 to 10 that estimates how well your target audience is responding to your ad. This score is shown after your ad receives more than 500 impressions. It's only visible when looking at reporting for ads and does not appear for ad sets and campaigns. |
insights.data.relevance_score.score |
INTEGER |
|
insights.data.relevance_score.positive_feedback |
STRING |
|
insights.data.relevance_score.negative_feedback |
STRING |
|
insights.data.relevance_score.status |
STRING |
|
insights.data.video_10_sec_watched_actions |
RECORD |
The number of times your video was watched for an aggregate of at least 10 seconds, or for nearly its total length, whichever happened first. https://developers.facebook.com/docs/marketing-api/reference/ads-action-stats/ |
insights.data.video_10_sec_watched_actions.action_type |
STRING |
The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Action types include Page likes, app installs, conversions, event responses and more. Read more: https://developers.facebook.com/docs/marketing-api/reference/ads-action-stats/ |
insights.data.video_10_sec_watched_actions.value |
STRING |
Metric value of default attribution window |
insights.data.actions |
RECORD |
The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions. |
insights.data.actions.action_type |
STRING |
The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Action types include Page likes, app installs, conversions, event responses and more. Read more: https://developers.facebook.com/docs/marketing-api/reference/ads-action-stats/ |
insights.data.actions.value |
STRING |
Metric value of default attribution window |
insights.data.date_start |
DATE |
The start date for your data. This is controlled by the date range you've selected for your reporting view. |
insights.data.date_stop |
DATE |
The end date for your data. This is controlled by the date range you've selected for your reporting view. |
targetingsentencelines |
RECORD |
|
targetingsentencelines.id |
STRING |
ID of the target sentence line |
targetingsentencelines.targetingsentencelines |
RECORD |
|
targetingsentencelines.targetingsentencelines.children |
STRING |
|
targetingsentencelines.targetingsentencelines.content |
STRING |
|
0 Комментарии