Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

account_id

decimal

itgen_facebook_account_id

☐

Ad Account ID.

adlabels

string

itgen_facebook_adlabels

☐

List of ad Labels associated with this ad set.

adset_schedule

string

itgen_facebook_adset_schedule

☐

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

attribution_spec

string

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

bid_amount

int32

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

bid_info

string

itgen_facebook_bid_info

☐

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

bid_strategy

string

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

billing_event

string

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

budget_remaining

decimal

itgen_facebook_budget_remaining

☐

Remaining budget.

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

created_time

datetime

Created

☐

Createwd time.

creative_sequence

string

itgen_facebook_creative_sequence

☐

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

daily_budget

decimal

itgen_facebook_daily_budget

☐

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

daily_min_spend_target

decimal

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

daily_spend_cap

decimal

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

destination_type

string

itgen_facebook_destination_type

☐

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

effective_status

string

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

end_time

datetime

itgen_facebook_end_time

☐

End time, in UTC UNIX timestamp.

frequency_control_specs

string

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

id

decimal

ID

☐

Ad set ID.

instagram_actor_id

decimal

itgen_facebook_instagram_actor_id

☐

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

is_dynamic_creative

boolean

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

issues_info

string

itgen_facebook_issues_info

☐

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

lifetime_budget

decimal

itgen_facebook_lifetime_budget

☐

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

lifetime_imps

int32

itgen_facebook_lifetime_imps

☐

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

lifetime_min_spend_target

decimal

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

lifetime_spend_cap

decimal

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

name

string

Name

☐

Name of ad set.

optimization_goal

string

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

pacing_type

string

itgen_facebook_pacing_type

☐

List of pacing types, standard or using ad scheduling.

promoted_object_application_id

decimal

itgen_facebook_promoted_object_application_id

☐

The ID of a Facebook Application. Usually related to mobile or canvas games being promoted on Facebook for installs or engagement.

promoted_object_custom_conversion_id

decimal

itgen_facebook_promoted_object_custom_conversion_id

☐

The ID of a Custom Conversion.

promoted_object_custom_event_type

string

itgen_facebook_promoted_object_custom_event_type

☐

The event from an App Event of a mobile app, (Purchase, Lead or CompleteRegistration) event from Offline Conversion data, or tag of an conversion pixel: RATE, TUTORIAL_COMPLETION, CONTACT, CUSTOMIZE_PRODUCT, DONATE, FIND_LOCATION, SCHEDULE, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, ADD_TO_CART, ADD_TO_WISHLIST, INITIATED_CHECKOUT, ADD_PAYMENT_INFO, PURCHASE, LEAD, COMPLETE_REGISTRATION, CONTENT_VIEW, SEARCH, SERVICE_BOOKING_REQUEST, MESSAGING_CONVERSATION_STARTED_7D, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, SPENT_CREDITS, D2_RETENTION, D7_RETENTION, OTHER.

promoted_object_event_id

decimal

itgen_facebook_promoted_object_event_id

☐

The ID of a Facebook Event.

promoted_object_object_store_url

string

itgen_facebook_promoted_object_object_store_url

☐

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.

promoted_object_offer_id

decimal

itgen_facebook_promoted_object_offer_id

☐

The ID of an Offer from a Facebook Page.

promoted_object_offline_conversion_data_set_id

decimal

itgen_facebook_promoted_object_offline_conversion_data_set_id

☐

The ID of the offline dataset.

promoted_object_page_id

decimal

itgen_facebook_promoted_object_page_id

☐

The ID of a Facebook Page.

promoted_object_pixel_id

decimal

itgen_facebook_promoted_object_pixel_id

☐

The ID of a Facebook conversion pixel. Used with offsite conversion campaigns.

promoted_object_place_page_set_id

decimal

itgen_facebook_promoted_object_place_page_set_id

☐

The ID of a Place Page Set for Dynamic Local Ads.

promoted_object_product_catalog_id

decimal

itgen_facebook_promoted_object_product_catalog_id

☐

The ID of a Product Catalog. Used with Dynamic Product Ads.

promoted_object_product_set_id

decimal

itgen_facebook_promoted_object_product_set_id

☐

The ID of a Product Set within an Ad Set level Product Catalog. Used with Dynamic Product Ads..

recommendations

string

itgen_facebook_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.).

recurring_budget_semantics

boolean

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

rf_prediction_id

decimal

itgen_facebook_rf_prediction_id

☐

Reach and frequency prediction ID.

source_adset_account_id

decimal

itgen_facebook_source_adset_account_id

☐

Ad Account ID.

source_adset_adlabels

string

itgen_facebook_source_adset_adlabels

☐

List of ad Labels associated with this ad set.

source_adset_adset_schedule

string

itgen_facebook_source_adset_adset_schedule

☐

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

source_adset_attribution_spec

string

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

source_adset_bid_amount

int32

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

source_adset_bid_info

string

itgen_facebook_source_adset_bid_info

☐

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

source_adset_bid_strategy

string

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

source_adset_billing_event

string

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

source_adset_budget_remaining

decimal

itgen_facebook_source_adset_budget_remaining

☐

Remaining budget.

source_adset_configured_status

string

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

source_adset_created_time

datetime

itgen_facebook_source_adset_created_time

☐

Createwd time.

source_adset_creative_sequence

string

itgen_facebook_source_adset_creative_sequence

☐

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

source_adset_daily_budget

decimal

itgen_facebook_source_adset_daily_budget

☐

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

source_adset_daily_min_spend_target

decimal

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

source_adset_daily_spend_cap

decimal

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

source_adset_destination_type

string

itgen_facebook_source_adset_destination_type

☐

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

source_adset_effective_status

string

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

source_adset_end_time

datetime

itgen_facebook_source_adset_end_time

☐

End time, in UTC UNIX timestamp.

source_adset_frequency_control_specs

string

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

source_adset_id

decimal

itgen_facebook_source_adset_id

☐

Ad set ID.

source_adset_instagram_actor_id

decimal

itgen_facebook_source_adset_instagram_actor_id

☐

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

source_adset_is_dynamic_creative

boolean

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

source_adset_issues_info

string

itgen_facebook_source_adset_issues_info

☐

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

source_adset_lifetime_budget

decimal

itgen_facebook_source_adset_lifetime_budget

☐

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

source_adset_lifetime_imps

int32

itgen_facebook_source_adset_lifetime_imps

☐

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

source_adset_lifetime_min_spend_target

decimal

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

source_adset_lifetime_spend_cap

decimal

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

source_adset_name

string

itgen_facebook_source_adset_name

☐

Name of ad set.

source_adset_optimization_goal

string

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

source_adset_pacing_type

string

itgen_facebook_source_adset_pacing_type

☐

List of pacing types, standard or using ad scheduling.

source_adset_recommendations

string

itgen_facebook_source_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.).

source_adset_recurring_budget_semantics

boolean

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

source_adset_rf_prediction_id

decimal

itgen_facebook_source_adset_rf_prediction_id

☐

Reach and frequency prediction ID.

source_adset_start_time

datetime

itgen_facebook_source_adset_start_time

☐

Start time, in UTC UNIX timestamp.

source_adset_status

string

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

source_adset_time_based_ad_rotation_id_blocks

string

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

source_adset_time_based_ad_rotation_intervals

string

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

source_adset_updated_time

datetime

itgen_facebook_source_adset_updated_time

☐

Updated time.

source_adset_use_new_app_click

boolean

itgen_facebook_source_adset_use_new_app_click

☐

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

start_time

datetime

itgen_facebook_start_time

☐

Start time, in UTC UNIX timestamp.

status

string

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

targeting_app_install_state

string

itgen_facebook_targeting_app_install_state

☐

JSON array.

targeting_audience_network_positions

string

itgen_facebook_targeting_audience_network_positions

☐

JSON array.

targeting_behaviors

string

itgen_facebook_targeting_behaviors

☐

JSON array.

targeting_college_years

string

itgen_facebook_targeting_college_years

☐

JSON array.

targeting_connections

string

itgen_facebook_targeting_connections

☐

JSON array.

targeting_custom_audiences

string

itgen_facebook_targeting_custom_audiences

☐

JSON array.

targeting_device_platforms

string

itgen_facebook_targeting_device_platforms

☐

JSON array.

targeting_dynamic_audience_ids

string

itgen_facebook_targeting_dynamic_audience_ids

☐

JSON array.

targeting_education_majors

string

itgen_facebook_targeting_education_majors

☐

JSON array.

targeting_education_schools

string

itgen_facebook_targeting_education_schools

☐

JSON array.

targeting_education_statuses

string

itgen_facebook_targeting_education_statuses

☐

JSON array.

targeting_effective_audience_network_positions

string

itgen_facebook_targeting_effective_audience_network_positions

☐

JSON array.

targeting_effective_device_platforms

string

itgen_facebook_targeting_effective_device_platforms

☐

JSON array.

targeting_effective_facebook_positions

string

itgen_facebook_targeting_effective_facebook_positions

☐

JSON array.

targeting_effective_instagram_positions

string

itgen_facebook_targeting_effective_instagram_positions

☐

JSON array.

targeting_effective_publisher_platforms

string

itgen_facebook_targeting_effective_publisher_platforms

☐

JSON array.

targeting_excluded_connections

string

itgen_facebook_targeting_excluded_connections

☐

JSON array.

targeting_excluded_custom_audiences

string

itgen_facebook_targeting_excluded_custom_audiences

☐

JSON array.

targeting_excluded_user_device

string

itgen_facebook_targeting_excluded_user_device

☐

JSON array.

targeting_facebook_positions

string

itgen_facebook_targeting_facebook_positions

☐

JSON array.

targeting_flexible_spec

string

itgen_facebook_targeting_flexible_spec

☐

JSON array.

targeting_friends_of_connections

string

itgen_facebook_targeting_friends_of_connections

☐

JSON array.

targeting_geo_locations

string

itgen_facebook_targeting_geo_locations

☐

JSON array.

targeting_household_composition

string

itgen_facebook_targeting_household_composition

☐

JSON array.

targeting_instagram_positions

string

itgen_facebook_targeting_instagram_positions

☐

JSON array.

targeting_locales

string

itgen_facebook_targeting_locales

☐

JSON array.

targeting_product_audience_specs

string

itgen_facebook_targeting_product_audience_specs

☐

JSON array.

targeting_publisher_platforms

string

itgen_facebook_targeting_publisher_platforms

☐

JSON array.

targeting_user_adclusters

string

itgen_facebook_targeting_user_adclusters

☐

JSON array.

targeting_user_device

string

itgen_facebook_targeting_user_device

☐

JSON array.

targeting_user_os

string

itgen_facebook_targeting_user_os

☐

JSON array.

targeting_wireless_carrier

string

itgen_facebook_targeting_wireless_carrier

☐

JSON array.

targeting_work_employers

string

itgen_facebook_targeting_work_employers

☐

JSON array.

targeting_work_positions

string

itgen_facebook_targeting_work_positions

☐

JSON array.

time_based_ad_rotation_id_blocks

string

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

time_based_ad_rotation_intervals

string

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

updated_time

datetime

Updated

☐

Updated time.

use_new_app_click

boolean

itgen_facebook_use_new_app_click

☐

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