Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

account_id

string

itgen_facebook_account_id

☐

The ID of the ad account that this ad belongs to.

ad_review_feedback_global

string

itgen_facebook_ad_review_feedback_global

☐

Reasons for review disapproval across all platforms, such as facebook or instagram. Each reason has a key and a description. Some of the key-description combinations can be found at Ad review feedback definitions.

adlabels

string

itgen_facebook_adlabels

☐

List of ad labels associated with this ad.

adset_account_id

decimal

itgen_facebook_adset_account_id

☐

Ad Account ID.

adset_adlabels

string

itgen_facebook_adset_adlabels

☐

List of ad Labels associated with this ad set.

adset_adset_schedule

string

itgen_facebook_adset_adset_schedule

☐

List of ad set schedules, representing a delivery schedule for a single day.

adset_attribution_spec

string

itgen_facebook_adset_attribution_spec

☐

List of conversion attribution spec used for attributing conversions for optimization. Supported window lengths differ by optimization goal and campaign objective. See Validation, Attribution Spec.

adset_bid_amount

int32

itgen_facebook_adset_bid_amount

☐

Bid cap or target cost for this ad set. The bid cap used in a lowest cost bid strategy is defined as the maximum bid you want to pay for a result based on your optimization_goal. The target cost used in a target cost bid strategy lets Facebook bid on your behalf to meet your target on average and keep costs stable as you raise budget. This field is not returned if is_autobid is true. The bid amount's unit is cents for currencies like USD, EUR, and the basic unit for currencies like JPY, KRW. The bid amount for ads with IMPRESSION or REACH as billing_event is per 1,000 occurrences of that event, and the bid amount for ads with other billing_events is for each occurrence.

adset_bid_info

string

itgen_facebook_adset_bid_info

☐

Map of bid objective to bid value. This field is not available if is_autobid is true.

adset_bid_strategy

string

itgen_facebook_adset_bid_strategy

☐

Bid strategy for this ad set when you use AUCTION as your buying type: LOWEST_COST_WITHOUT_CAP: Designed to get the most results for your budget based on your ad set optimization_goal without limiting your bid amount.This is the best strategy if you care most about cost efficiency.However with this strategy it may be harder to get stable average costs as you spend.This strategy is also known as automatic bidding.Learn more in Ads Help Center, About bid strategies: Lowest cost. LOWEST_COST_WITH_BID_CAP: Designed to get the most results for your budget based on your ad set optimization_goal while limiting actual bid to your specified amount. With a bid cap you have more control over your cost per actual optimization event. However if you set a limit which is too low you may get less ads delivery. Get your bid cap with the field bid_amount. This strategy is also known as manual maximum-cost bidding. Learn more in Ads Help Center, About bid strategies: Lowest cost. TARGET_COST: Maintains a stable average cost while delivering towards your optimization_goal as you raise your budget. We recommend this strategy if you care most about maintaining stable average costs for your ads. However, note that this may be less cost-efficient than the lowest cost strategy. Get your target average cost in the bid_amount field. Target cost bid strategy is also known as manual average-cost bidding. Learn more in Ads Help Center, About bid strategies: Target cost. Note: If you enable campaign budget optimization, you should get bid_strategy at the parent campaign level.

adset_billing_event

string

itgen_facebook_adset_billing_event

☐

The billing event for this ad set: 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 your video ads for at least 10 seconds. THRUPLAY: Pay for ads that are played to completion, or played for at least 15 seconds.

adset_budget_remaining

decimal

itgen_facebook_adset_budget_remaining

☐

Remaining budget.

adset_configured_status

string

itgen_facebook_adset_configured_status

☐

The status set at the ad set level. It can be different from the effective status due to its parent campaign. Prefer using 'status' instead of this: ACTIVE, PAUSED, DELETED, ARCHIVED.

adset_created_time

datetime

itgen_facebook_adset_created_time

☐

Createwd time.

adset_creative_sequence

string

itgen_facebook_adset_creative_sequence

☐

List of order of the adgroup sequence to be shown to users.

adset_daily_budget

decimal

itgen_facebook_adset_daily_budget

☐

The daily budget of the set defined in your account currency.

adset_daily_min_spend_target

decimal

itgen_facebook_adset_daily_min_spend_target

☐

Daily minimum spend target of the ad set defined in your account currency. To use this field, daily budget must be specified in the Campaign. This target is not a guarantee but our best effort.

adset_daily_spend_cap

decimal

itgen_facebook_adset_daily_spend_cap

☐

Daily spend cap of the ad set defined in your account currency. To use this field, daily budget must be specified in the Campaign.

adset_destination_type

string

itgen_facebook_adset_destination_type

☐

Destination of ads in this Ad Set (e.g. Website, App, Messenger).

adset_effective_status

string

itgen_facebook_adset_effective_status

☐

The effective status of the ad set, which can be either its own status or caused by its parent campaign: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, WITH_ISSUES.

adset_end_time

datetime

itgen_facebook_adset_end_time

☐

End time, in UTC UNIX timestamp.

adset_frequency_control_specs

string

itgen_facebook_adset_frequency_control_specs

☐

An array of frequency control specs for this ad set. As there is only one event type currently supported, this array has no more than one element. Writes to this field are only available in ad sets where REACH is the objective.

adset_id

decimal

itgen_facebook_adset_id

☐

Ad set ID.

adset_instagram_actor_id

decimal

itgen_facebook_adset_instagram_actor_id

☐

Represents your Instagram account id, used for ads, including dynamic creative ads on Instagram.

adset_is_dynamic_creative

boolean

itgen_facebook_adset_is_dynamic_creative

☐

Whether this ad set is a dynamic creative ad set. dynamic creative ad can be created only under ad set with this field set to be true.

adset_issues_info

string

itgen_facebook_adset_issues_info

☐

List of issues for this ad set that prevented it from deliverying.

adset_lifetime_budget

decimal

itgen_facebook_adset_lifetime_budget

☐

The lifetime budget of the set defined in your account currency.

adset_lifetime_imps

int32

itgen_facebook_adset_lifetime_imps

☐

Lifetime impressions. Available only for campaigns with buying_type=FIXED_CPM.

adset_lifetime_min_spend_target

decimal

itgen_facebook_adset_lifetime_min_spend_target

☐

Lifetime minimum spend target of the ad set defined in your account currency. To use this field, lifetime budget must be specified in the Campaign. This target is not a guarantee but our best effort.

adset_lifetime_spend_cap

decimal

itgen_facebook_adset_lifetime_spend_cap

☐

Lifetime spend cap of the ad set defined in your account currency. To use this field, lifetime budget must be specified in the Campaign.

adset_name

string

itgen_facebook_adset_name

☐

Name of ad set.

adset_optimization_goal

string

itgen_facebook_adset_optimization_goal

☐

Which optimization goal this ad set is using:NONE: Only available in read mode for campaigns created pre v2.4.APP_INSTALLS: Optimize for people more likely to install your app.BRAND_AWARENESS: Optimize to reach the most number of users who are likely to spend at least a minimum amount of time on the image or video.AD_RECALL_LIFT: Optimize for people more likely to remember seeing your ads.CLICKS: Deprecated.Only available in read mode.ENGAGED_USERS: Optimize for people more likely to take a particular action in your app.EVENT_RESPONSES: Optimize for people more likely to attend your event.IMPRESSIONS: Show the ads as many times as possible.LEAD_GENERATION: Optimize for people more likely to fill out a lead generation form.LINK_CLICKS: Optimize for people more likely to click in the link of the ad.OFFER_CLAIMS: Optimize for people more likely to claim the offer.OFFSITE_CONVERSIONS: Optimize for people more likely to make a conversion in the sitePAGE_ENGAGEMENT: Optimize for people more likely to engage with your page.PAGE_LIKES: Optimize for people more likely to like your page.POST_ENGAGEMENT: Optimize for people more likely to engage with your post.REACH: Optimize to reach the most unique users of each day or interval specified in frequency_control_specs.SOCIAL_IMPRESSIONS: Increase the number of impressions with social context. I.e. with the names of one or more of the user's friends attached to the ad who have already liked the page or installed the app.VIDEO_VIEWS: Optimize delivery of your ads to people who are more likely to watch videos for at least 10 seconds.VALUE: Optimize for maximum total purchase value within the specified attribution window.THRUPLAY: Optimize delivery of your ads to people who are more likely to play your ad to completion, or play it for at least 15 seconds.REPLIES: REPLIES optimization will direct ads to people more likely to have a conversation with the business.DERIVED_EVENTS: Optimize for retention, which reaches people who are most likely to return to the app and open it again during a given time frame after installing. You can choose either two days, meaning the app is likely to be reopened between 24 and 48 hours after installation; or seven days, meaning the app is likely to be reopened between 144 and 168 hours after installation..

adset_pacing_type

string

itgen_facebook_adset_pacing_type

☐

List of pacing types, standard or using ad scheduling.

adset_recommendations

string

itgen_facebook_adset_recommendations

☐

If there are recommendations for this ad set, this field includes them. Otherwise, will not be included in the response. (This field is not included in redownload mode.).

adset_recurring_budget_semantics

boolean

itgen_facebook_adset_recurring_budget_semantics

☐

If this field is true, your daily spend may be more than your daily budget while your weekly spend will not exceed 7 times your daily budget. More details explained in the Ad Set Budget document. If this is false, your amount spent daily will not exceed the daily budget. This field is not applicable for lifetime budgets..

adset_rf_prediction_id

decimal

itgen_facebook_adset_rf_prediction_id

☐

Reach and frequency prediction ID.

adset_start_time

datetime

itgen_facebook_adset_start_time

☐

Start time, in UTC UNIX timestamp.

adset_status

string

itgen_facebook_adset_status

☐

The status set at the ad set level. It can be different from the effective status due to its parent campaign. The field returns the same value as 'configured_status', and is the suggested one to use: ACTIVE, PAUSED, DELETED, ARCHIVED.

adset_time_based_ad_rotation_id_blocks

string

itgen_facebook_adset_time_based_ad_rotation_id_blocks

☐

Specify ad creative that displays at custom date ranges in a campaign as an array. A list of Adgroup IDs. The list of ads to display for each time range in a given schedule. For example display first ad in Adgroup for first date range, second ad for second date range, and so on. You can display more than one ad per date range by providing more than one ad ID per array. For example set time_based_ad_rotation_id_blocks to [[1], [2, 3], [1, 4]]. On the first date range show ad 1, on the second date range show ad 2 and ad 3 and on the last date range show ad 1 and ad 4. Use with time_based_ad_rotation_intervals to specify date ranges..

adset_time_based_ad_rotation_intervals

string

itgen_facebook_adset_time_based_ad_rotation_intervals

☐

Date range when specific ad creative displays during a campaign. Provide date ranges in an array of UNIX timestamps where each timestamp represents the start time for each date range. For example a 3-day campaign from May 9 12am to May 11 11:59PM PST can have three date ranges, the first date range starts from May 9 12:00AM to May 9 11:59PM, second date range starts from May 10 12:00AM to May 10 11:59PM and last starts from May 11 12:00AM to May 11 11:59PM. The first timestamp should match the campaign start time. The last timestamp should be at least 1 hour before the campaign end time. You must provide at least two date ranges. All date ranges must cover the whole campaign length, so any date range cannot exceed campaign length. Use with time_based_ad_rotation_id_blocks to specify ad creative for each date range.

adset_updated_time

datetime

itgen_facebook_adset_updated_time

☐

Updated time.

adset_use_new_app_click

boolean

itgen_facebook_adset_use_new_app_click

☐

If set, allows Mobile App Engagement ads to optimize for LINK_CLICKS.

bid_amount

int32

itgen_facebook_bid_amount

☐

Bid amount for this ad which will be used in auction instead of the ad set bid_amount, if specified. Any updates to the ad set bid_amount will overwrite this value with the new ad set value.

bid_info

string

itgen_facebook_bid_info

☐

A dictionary of {objective}:{value} that you place on your bid, based on the bid_type of ad set. Values are defined in your currency's minimum denomination.

bid_type

string

itgen_facebook_bid_type

☐

Bid type: CPC, CPM, MULTI_PREMIUM, ABSOLUTE_OCPM, CPA.

campaign_account_id

decimal

itgen_facebook_campaign_account_id

☐

ID of the ad account that owns this campaign.

campaign_adlabels

string

itgen_facebook_campaign_adlabels

☐

List of ad Labels associated with this campaign.

campaign_bid_strategy

string

itgen_facebook_campaign_bid_strategy

☐

Bid strategy for this ad set when you use AUCTION as your buying type: LOWEST_COST_WITHOUT_CAP: Designed to get the most results for your budget based on your ad set optimization_goal without limiting your bid amount.This is the best strategy if you care most about cost efficiency.However with this strategy it may be harder to get stable average costs as you spend.This strategy is also known as automatic bidding.Learn more in Ads Help Center, About bid strategies: Lowest cost. LOWEST_COST_WITH_BID_CAP: Designed to get the most results for your budget based on your ad set optimization_goal while limiting actual bid to your specified amount. With a bid cap you have more control over your cost per actual optimization event. However if you set a limit which is too low you may get less ads delivery. Get your bid cap with the field bid_amount. This strategy is also known as manual maximum-cost bidding. Learn more in Ads Help Center, About bid strategies: Lowest cost. TARGET_COST: Maintains a stable average cost while delivering towards your optimization_goal as you raise your budget. We recommend this strategy if you care most about maintaining stable average costs for your ads. However, note that this may be less cost-efficient than the lowest cost strategy. Get your target average cost in the bid_amount field. Target cost bid strategy is also known as manual average-cost bidding. Learn more in Ads Help Center, About bid strategies: Target cost. Note: If you enable campaign budget optimization, you should get bid_strategy at the parent campaign level.

campaign_boosted_object_id

decimal

itgen_facebook_campaign_boosted_object_id

☐

The Boosted Object this campaign has associated, if any.

campaign_brand_lift_studies

string

itgen_facebook_campaign_brand_lift_studies

☐

List of automated Brand Lift V2 studies for this ad set..

campaign_budget_rebalance_flag

boolean

itgen_facebook_campaign_budget_rebalance_flag

☐

Whether to automatically rebalance budgets daily for all the adsets under this campaign.

campaign_budget_remaining

decimal

itgen_facebook_campaign_budget_remaining

☐

Remaining budget.

campaign_buying_type

string

itgen_facebook_campaign_buying_type

☐

Buying type, possible values are AUCTION: default, RESERVED: for reach and frequency ads.

campaign_can_create_brand_lift_study

boolean

itgen_facebook_campaign_can_create_brand_lift_study

☐

If we can create a new automated brand lift study for the ad set.

campaign_can_use_spend_cap

boolean

itgen_facebook_campaign_can_use_spend_cap

☐

Whether the campaign can set the spend cap.

campaign_configured_status

string

itgen_facebook_campaign_configured_status

☐

If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this: ACTIVE, PAUSED, DELETED, ARCHIVED.

campaign_created_time

datetime

itgen_facebook_campaign_created_time

☐

Created time.

campaign_daily_budget

decimal

itgen_facebook_campaign_daily_budget

☐

The daily budget of the campaign.

campaign_effective_status

string

itgen_facebook_campaign_effective_status

☐

The effective status of this campaign: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, WITH_ISSUES.

campaign_id

decimal

itgen_facebook_campaign_id

☐

Ad campaign group ID.

campaign_lifetime_budget

decimal

itgen_facebook_campaign_lifetime_budget

☐

The lifetime budget of the campaign.

campaign_metrics_metadata

string

itgen_facebook_campaign_metrics_metadata

☐

Metrics metadata is used for tracking campaign optimization information.

campaign_name

string

itgen_facebook_campaign_name

☐

Campaign's name.

campaign_objective

string

itgen_facebook_campaign_objective

☐

Campaign's objective.

campaign_recommendations

string

itgen_facebook_campaign_recommendations

☐

If there are recommendations for this campaign, this field includes them. Otherwise, will not be included in the response. (This field is not included in redownload mode.).

campaign_spend_cap

decimal

itgen_facebook_campaign_spend_cap

☐

A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency.

campaign_start_time

datetime

itgen_facebook_campaign_start_time

☐

Start time.

campaign_status

string

itgen_facebook_campaign_status

☐

If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use: ACTIVE, PAUSED, DELETED, ARCHIVED.

campaign_stop_time

datetime

itgen_facebook_campaign_stop_time

☐

Stop time.

campaign_updated_time

datetime

itgen_facebook_campaign_updated_time

☐

Updated Time. If you update spend_cap, this will not automatically update this field.

configured_status

string

itgen_facebook_configured_status

☐

The configured status of the ad. Prefer using 'status' instead of this: ACTIVE, PAUSED, DELETED, ARCHIVED.

conversion_specs

string

itgen_facebook_conversion_specs

☐

List of conversion specs.

created_time

string

Created

☐

Created time.

creative_account_id

decimal

itgen_facebook_creative_account_id

☐

Account ID.

creative_actor_id

int32

itgen_facebook_creative_actor_id

☐

The actor ID (Page ID) of this creative.

creative_adlabels

string

itgen_facebook_creative_adlabels

☐

List of Ad Labels that are associated with this creative.

creative_applink_treatment

string

itgen_facebook_creative_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.

creative_body

string

itgen_facebook_creative_body

☐

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

creative_branded_content_sponsor_page_id

decimal

itgen_facebook_creative_branded_content_sponsor_page_id

☐

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

creative_call_to_action_type

string

itgen_facebook_creative_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.

creative_effective_instagram_story_id

decimal

itgen_facebook_creative_effective_instagram_story_id

☐

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

creative_effective_object_story_id

string

itgen_facebook_creative_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.

creative_id

decimal

itgen_facebook_creative_id

☐

The ID of this creative.

creative_image_hash

string

itgen_facebook_creative_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.

creative_image_url

string

itgen_facebook_creative_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.

creative_instagram_actor_id

decimal

itgen_facebook_creative_instagram_actor_id

☐

Instagram actor ID.

creative_instagram_permalink_url

string

itgen_facebook_creative_instagram_permalink_url

☐

Instagram permalink.

creative_instagram_story_id

decimal

itgen_facebook_creative_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.

creative_link_og_id

int32

itgen_facebook_creative_link_og_id

☐

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

creative_link_url

string

itgen_facebook_creative_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.

creative_messenger_sponsored_message

string

itgen_facebook_creative_messenger_sponsored_message

☐

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

creative_name

string

itgen_facebook_creative_name

☐

The name of the creative in the creative library.

creative_object_id

int32

itgen_facebook_creative_object_id

☐

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

creative_object_story_id

int32

itgen_facebook_creative_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.

creative_object_type

string

itgen_facebook_creative_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.

creative_object_url

string

itgen_facebook_creative_object_url

☐

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

creative_product_set_id

int32

itgen_facebook_creative_product_set_id

☐

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

creative_status

string

itgen_facebook_creative_status

☐

The status of this creative: ACTIVE, DELETED.

creative_template_url

string

itgen_facebook_creative_template_url

☐

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

creative_thumbnail_url

string

itgen_facebook_creative_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.

creative_title

string

itgen_facebook_creative_title

☐

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

creative_url_tags

string

itgen_facebook_creative_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.

creative_use_page_actor_override

boolean

itgen_facebook_creative_use_page_actor_override

☐

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

creative_video_id

decimal

itgen_facebook_creative_video_id

☐

The ID of the video in this creative.

effective_status

string

itgen_facebook_effective_status

☐

The effective status of the ad. The status could be effective either because of its own status, or the status of its parent units. WITH_ISSUES is available for version 3.2 or higher: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, WITH_ISSUES.

id

decimal

ID

☐

ID of this report run.

issues_info

string

itgen_facebook_issues_info

☐

List of issues for this ad that prevented it from delivering.

last_updated_by_app_id

decimal

itgen_facebook_last_updated_by_app_id

☐

Last Updated By App ID.

name

string

Name

☐

Name of the ad.

recommendations

string

itgen_facebook_recommendations

☐

If there are recommendations for this ad, this field includes them. Otherwise, will not be included in the response. (This field is not included in redownload mode.)

source_ad_account_id

string

itgen_facebook_source_ad_account_id

☐

The ID of the ad account that this ad belongs to.

source_ad_adlabels

string

itgen_facebook_source_ad_adlabels

☐

List of ad labels associated with this ad.

source_ad_bid_amount

int32

itgen_facebook_source_ad_bid_amount

☐

Bid amount for this ad which will be used in auction instead of the ad set bid_amount, if specified. Any updates to the ad set bid_amount will overwrite this value with the new ad set value.

source_ad_bid_info

string

itgen_facebook_source_ad_bid_info

☐

A dictionary of {objective}:{value} that you place on your bid, based on the bid_type of ad set. Values are defined in your currency's minimum denomination.

source_ad_bid_type

string

itgen_facebook_source_ad_bid_type

☐

Bid type: CPC, CPM, MULTI_PREMIUM, ABSOLUTE_OCPM, CPA.

source_ad_configured_status

string

itgen_facebook_source_ad_configured_status

☐

The configured status of the ad. Prefer using 'status' instead of this: ACTIVE, PAUSED, DELETED, ARCHIVED.

source_ad_conversion_specs

string

itgen_facebook_source_ad_conversion_specs

☐

List of conversion specs.

source_ad_created_time

string

itgen_facebook_source_ad_created_time

☐

Created time.

source_ad_effective_status

string

itgen_facebook_source_ad_effective_status

☐

The effective status of the ad. The status could be effective either because of its own status, or the status of its parent units. WITH_ISSUES is available for version 3.2 or higher: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, WITH_ISSUES.

source_ad_id

decimal

itgen_facebook_source_ad_id

☐

ID of this report run.

source_ad_issues_info

string

itgen_facebook_source_ad_issues_info

☐

List of issues for this ad that prevented it from delivering.

source_ad_last_updated_by_app_id

decimal

itgen_facebook_source_ad_last_updated_by_app_id

☐

Last Updated By App ID.

source_ad_name

string

itgen_facebook_source_ad_name

☐

Name of the ad.

source_ad_recommendations

string

itgen_facebook_source_ad_recommendations

☐

If there are recommendations for this ad, this field includes them. Otherwise, will not be included in the response. (This field is not included in redownload mode.)

source_ad_status

string

itgen_facebook_source_ad_status

☐

The configured status of the ad. The field returns the same value as 'configured_status', and is the suggested one to use: ACTIVE, PAUSED, DELETED, ARCHIVED.

source_ad_tracking_specs

string

itgen_facebook_source_ad_tracking_specs

☐

List of tracking specs.

source_ad_updated_time

datetime

itgen_facebook_source_ad_updated_time

☐

Updated time.

status

string

itgen_facebook_status

☐

The configured status of the ad. The field returns the same value as 'configured_status', and is the suggested one to use: ACTIVE, PAUSED, DELETED, ARCHIVED.

tracking_specs

string

itgen_facebook_tracking_specs

☐

List of tracking specs.

updated_time

datetime

Updated

☐

Updated time.