Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

account_id

decimal

itgen_facebook_account_id

☐

The ID of the Ad Account this reach frequency prediction belongs to.

campaign_group_id

decimal

itgen_facebook_campaign_group_id

☐

The id of the campaign which this prediction belongs to.

campaign_id

decimal

itgen_facebook_campaign_id

☐

The ID of the ad set to which this reach frequency prediction is assigned.

campaign_time_start

datetime

itgen_facebook_campaign_time_start

☐

Unix timestamp of the ad set start time.

campaign_time_stop

datetime

itgen_facebook_campaign_time_stop

☐

Unix timestamp of the ad set stop time.

curve_budget_reach

string

itgen_facebook_curve_budget_reach

☐

The curve for budget and reach. It is a string in JSON format representing a JSON object with these fields.num_points: the number of data points within the object.reach: Data contained at corresponding indices of each array form a single data point.The 'reach' values are presented in ascending order with the final value containing the maximum available reach.In video view buying, this is the number of unique users with viewsraw_reach: Data contained at corresponding indices of each array form a single data point.In video view buying, reach representsunique view throughs and raw_reach represents unique viewsbudget: Data contained at corresponding indices of each array form a single data point.Cent of accounts currency.impression: Data contained at corresponding indices of each array form a single data point.In video view buying, this is the number of view throughs(aka impression by conversion)interpolated_reach: Interpolated reach which is the original.value of reach without truncationraw_impression: Data contained at corresponding indices of each array form a single data point.In video view buying, impressions represents view throughs and raw_impressions representstotal number of views.

daily_impression_curve

string

itgen_facebook_daily_impression_curve

☐

List of daily Impression fields represents a vector of predicted daily impressions for every single day. Measured from midnight to midnight in the advertiser timezone during the campaign duration.

destination_id

decimal

itgen_facebook_destination_id

☐

The ID of the Page or the ID of the app which the ad promotes.

expiration_time

datetime

itgen_facebook_expiration_time

☐

Unix timestamp of the expiration time of prediction, if applicable.

external_budget

int32

itgen_facebook_external_budget

☐

Predicted budget in cents for the ad set, relevant if prediction mode is 0.

external_impression

int32

itgen_facebook_external_impression

☐

Predicted impressions for the ad set.

external_maximum_budget

int32

itgen_facebook_external_maximum_budget

☐

Maximum budget given the target, in cents.

external_maximum_impression

int32

itgen_facebook_external_maximum_impression

☐

Maximum number of impressions given the target.

external_maximum_reach

int32

itgen_facebook_external_maximum_reach

☐

Maximum reach given the target.

external_minimum_budget

int32

itgen_facebook_external_minimum_budget

☐

Minimum budget given the target, in cents.

external_minimum_impression

int32

itgen_facebook_external_minimum_impression

☐

Minimum impressions given the target.

external_minimum_reach

int32

itgen_facebook_external_minimum_reach

☐

Minimum reach given the target.

external_reach

int32

itgen_facebook_external_reach

☐

Predicted reach for the ad set, relevant if prediction mode is 1.

frequency_cap

int32

itgen_facebook_frequency_cap

☐

Lifetime frequency cap per user, always relevant, 0 means no frequncy cap.

frequency_distribution

string

itgen_facebook_frequency_distribution

☐

List of predicted percentages. The first value in the list represents the predicted percentage of people that will be reached once. The second value is the predicted percentage of people reached twice, and so on.

frequency_distribution_map

string

itgen_facebook_frequency_distribution_map

☐

List of key-value pairs. Each key is a predicted number of people reached by your ad and each value is a frequency_distribution associated with that reach.

frequency_distribution_map_agg

string

itgen_facebook_frequency_distribution_map_agg

☐

List of key-value pairs. Each key is a predicted number of people reached by your ad and each value is a list of 10 numbers associated with that reach. The first number represents the number of people reached which is greater than or equal to 1 time, 2 times and so on. The last number represents the number of people reached which is greater than or equal to 10 times.

grp_dmas_audience_size

double

itgen_facebook_grp_dmas_audience_size

☐

GRP: Audience size within DMAs based on Nielsen definition.

holdout_percentage

int32

itgen_facebook_holdout_percentage

☐

Percent of users in hold-out.

id

decimal

ID

☐

ID.

instagram_destination_id

decimal

itgen_facebook_instagram_destination_id

☐

The Instagram account id if instagramstream placement is used, except in the case of Mobile App Installs ads.

interval_frequency_cap

int32

itgen_facebook_interval_frequency_cap

☐

Interval frequency cap which is set for a custom period.

interval_frequency_cap_reset_period

int32

itgen_facebook_interval_frequency_cap_reset_period

☐

Custom reset period (hours) for interval frequency cap.

is_io

boolean

itgen_facebook_is_io

☐

Flag to indicate whether prediction is tied to an IO.

name

string

Name

☐

Prediction name.

pause_periods

string

itgen_facebook_pause_periods

☐

List of time periods the associated campaign has been paused.

prediction_mode

int32

itgen_facebook_prediction_mode

☐

The prediction mode: 0 = given reach, predict budget, 1 = given budget, predict reach.

prediction_progress

int32

itgen_facebook_prediction_progress

☐

Percentage value indicating the prediction progress (values 0-100). When 100 check status to indicate whether the prediction was successful.

reservation_status

int32

itgen_facebook_reservation_status

☐

Reservation status: 0 = Cancelled prediction, 1 = Reserved prediction, 2 = Prediction has been attached to a campaign.

status

int32

itgen_facebook_status

☐

Represents the status of the prediction, refer to Response Status.

story_event_type

int32

itgen_facebook_story_event_type

☐

Used to indicated the prediction is for video ads or not. If it is for video, the prediction will not include devices that cannot play video.

target_audience_size

int32

itgen_facebook_target_audience_size

☐

Unique 30-day active users for given targetting specs. Used as tip to indicate the maximum possible audience size if campaign length is increased.

target_spec_app_install_state

string

itgen_facebook_target_spec_app_install_state

☐

JSON array.

target_spec_audience_network_positions

string

itgen_facebook_target_spec_audience_network_positions

☐

JSON array.

target_spec_behaviors

string

itgen_facebook_target_spec_behaviors

☐

JSON array.

target_spec_college_years

string

itgen_facebook_target_spec_college_years

☐

JSON array.

target_spec_connections

string

itgen_facebook_target_spec_connections

☐

JSON array.

target_spec_custom_audiences

string

itgen_facebook_target_spec_custom_audiences

☐

JSON array.

target_spec_device_platforms

string

itgen_facebook_target_spec_device_platforms

☐

JSON array.

target_spec_dynamic_audience_ids

string

itgen_facebook_target_spec_dynamic_audience_ids

☐

JSON array.

target_spec_education_majors

string

itgen_facebook_target_spec_education_majors

☐

JSON array.

target_spec_education_schools

string

itgen_facebook_target_spec_education_schools

☐

JSON array.

target_spec_education_statuses

string

itgen_facebook_target_spec_education_statuses

☐

JSON array.

target_spec_effective_audience_network_positions

string

itgen_facebook_target_spec_effective_audience_network_positions

☐

JSON array.

target_spec_effective_device_platforms

string

itgen_facebook_target_spec_effective_device_platforms

☐

JSON array.

target_spec_effective_facebook_positions

string

itgen_facebook_target_spec_effective_facebook_positions

☐

JSON array.

target_spec_effective_instagram_positions

string

itgen_facebook_target_spec_effective_instagram_positions

☐

JSON array.

target_spec_effective_publisher_platforms

string

itgen_facebook_target_spec_effective_publisher_platforms

☐

JSON array.

target_spec_excluded_connections

string

itgen_facebook_target_spec_excluded_connections

☐

JSON array.

target_spec_excluded_custom_audiences

string

itgen_facebook_target_spec_excluded_custom_audiences

☐

JSON array.

target_spec_excluded_user_device

string

itgen_facebook_target_spec_excluded_user_device

☐

JSON array.

target_spec_facebook_positions

string

itgen_facebook_target_spec_facebook_positions

☐

JSON array.

target_spec_flexible_spec

string

itgen_facebook_target_spec_flexible_spec

☐

JSON array.

target_spec_friends_of_connections

string

itgen_facebook_target_spec_friends_of_connections

☐

JSON array.

target_spec_geo_locations

string

itgen_facebook_target_spec_geo_locations

☐

JSON array.

target_spec_household_composition

string

itgen_facebook_target_spec_household_composition

☐

JSON array.

target_spec_instagram_positions

string

itgen_facebook_target_spec_instagram_positions

☐

JSON array.

target_spec_locales

string

itgen_facebook_target_spec_locales

☐

JSON array.

target_spec_product_audience_specs

string

itgen_facebook_target_spec_product_audience_specs

☐

JSON array.

target_spec_publisher_platforms

string

itgen_facebook_target_spec_publisher_platforms

☐

JSON array.

target_spec_user_adclusters

string

itgen_facebook_target_spec_user_adclusters

☐

JSON array.

target_spec_user_device

string

itgen_facebook_target_spec_user_device

☐

JSON array.

target_spec_user_os

string

itgen_facebook_target_spec_user_os

☐

JSON array.

target_spec_wireless_carrier

string

itgen_facebook_target_spec_wireless_carrier

☐

JSON array.

target_spec_work_employers

string

itgen_facebook_target_spec_work_employers

☐

JSON array.

target_spec_work_positions

string

itgen_facebook_target_spec_work_positions

☐

JSON array.

time_created

datetime

itgen_facebook_time_created

☐

The time when this reach frequency prediction was created.

time_updated

datetime

itgen_facebook_time_updated

☐

Unix timestamp when the row is updated.