Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

account_id

decimal

itgen_facebook_account_id

☐

ID of the ad account that owns this campaign.

adlabels

string

itgen_facebook_adlabels

☐

List of ad Labels associated with this campaign.

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.

boosted_object_id

decimal

itgen_facebook_boosted_object_id

☐

The Boosted Object this campaign has associated, if any.

brand_lift_studies

string

itgen_facebook_brand_lift_studies

☐

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

budget_rebalance_flag

boolean

itgen_facebook_budget_rebalance_flag

☐

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

budget_remaining

decimal

itgen_facebook_budget_remaining

☐

Remaining budget.

buying_type

string

itgen_facebook_buying_type

☐

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

can_create_brand_lift_study

boolean

itgen_facebook_can_create_brand_lift_study

☐

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

can_use_spend_cap

boolean

itgen_facebook_can_use_spend_cap

☐

Whether the campaign can set the spend cap.

configured_status

string

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

created_time

datetime

Created

☐

Created time.

daily_budget

decimal

itgen_facebook_daily_budget

☐

The daily budget of the campaign.

effective_status

string

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

id

decimal

ID

☐

Ad campaign group ID.

lifetime_budget

decimal

itgen_facebook_lifetime_budget

☐

The lifetime budget of the campaign.

metrics_metadata

string

itgen_facebook_metrics_metadata

☐

Metrics metadata is used for tracking campaign optimization information.

name

string

Name

☐

Campaign's name.

objective

string

itgen_facebook_objective

☐

Campaign's objective.

recommendations

string

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

source_campaign_account_id

decimal

itgen_facebook_source_campaign_account_id

☐

ID of the ad account that owns this campaign.

source_campaign_adlabels

string

itgen_facebook_source_campaign_adlabels

☐

List of ad Labels associated with this campaign.

source_campaign_bid_strategy

string

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

source_campaign_boosted_object_id

decimal

itgen_facebook_source_campaign_boosted_object_id

☐

The Boosted Object this campaign has associated, if any.

source_campaign_brand_lift_studies

string

itgen_facebook_source_campaign_brand_lift_studies

☐

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

source_campaign_budget_rebalance_flag

boolean

itgen_facebook_source_campaign_budget_rebalance_flag

☐

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

source_campaign_budget_remaining

decimal

itgen_facebook_source_campaign_budget_remaining

☐

Remaining budget.

source_campaign_buying_type

string

itgen_facebook_source_campaign_buying_type

☐

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

source_campaign_can_create_brand_lift_study

boolean

itgen_facebook_source_campaign_can_create_brand_lift_study

☐

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

source_campaign_can_use_spend_cap

boolean

itgen_facebook_source_campaign_can_use_spend_cap

☐

Whether the campaign can set the spend cap.

source_campaign_configured_status

string

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

source_campaign_created_time

datetime

itgen_facebook_source_campaign_created_time

☐

Created time.

source_campaign_daily_budget

decimal

itgen_facebook_source_campaign_daily_budget

☐

The daily budget of the campaign.

source_campaign_effective_status

string

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

source_campaign_id

decimal

itgen_facebook_source_campaign_id

☐

Ad campaign group ID.

source_campaign_lifetime_budget

decimal

itgen_facebook_source_campaign_lifetime_budget

☐

The lifetime budget of the campaign.

source_campaign_metrics_metadata

string

itgen_facebook_source_campaign_metrics_metadata

☐

Metrics metadata is used for tracking campaign optimization information.

source_campaign_name

string

itgen_facebook_source_campaign_name

☐

Campaign's name.

source_campaign_objective

string

itgen_facebook_source_campaign_objective

☐

Campaign's objective.

source_campaign_recommendations

string

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

source_campaign_spend_cap

decimal

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

source_campaign_start_time

datetime

itgen_facebook_source_campaign_start_time

☐

Start time.

source_campaign_status

string

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

source_campaign_stop_time

datetime

itgen_facebook_source_campaign_stop_time

☐

Stop time.

source_campaign_updated_time

datetime

itgen_facebook_source_campaign_updated_time

☐

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

spend_cap

decimal

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

start_time

datetime

itgen_facebook_start_time

☐

Start time.

status

string

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

stop_time

datetime

itgen_facebook_stop_time

☐

Stop time.

updated_time

datetime

Updated

☐

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