Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

account_id

string

itgen_facebook_account_id

☐

Ad account ID.

approximate_count

int32

itgen_facebook_approximate_count

☐

Approximate number of people in this audience.

customer_file_source

string

itgen_facebook_customer_file_source

☐

Source of customer information in the uploaded file.

data_source_creation_params

string

itgen_facebook_data_source_creation_params

☐

Additional information on creation source.

data_source_sub_type

string

itgen_facebook_data_source_sub_type

☐

Custom Audience subtype: ANYTHING, NOTHING, HASHES, USER_IDS, HASHES_OR_USER_IDS, MOBILE_ADVERTISER_IDS, EXTERNAL_IDS, MULTI_HASHES, TOKENS, EXTERNAL_IDS_MIX, HOUSEHOLD_EXPANSION, WEB_PIXEL_HITS, MOBILE_APP_EVENTS, MOBILE_APP_COMBINATION_EVENTS, VIDEO_EVENTS, WEB_PIXEL_COMBINATION_EVENTS, PLATFORM, MULTI_DATA_EVENTS, IG_BUSINESS_EVENTS, STORE_VISIT_EVENTS, INSTANT_ARTICLE_EVENTS, FB_EVENT_SIGNALS, ENGAGEMENT_EVENT_USERS, CUSTOM_AUDIENCE_USERS, PAGE_FANS, CONVERSION_PIXEL_HITS, APP_USERS, S_EXPR, DYNAMIC_RULE, CAMPAIGN_CONVERSIONS, WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS, MOBILE_APP_CUSTOM_AUDIENCE_USERS, COMBINATION_CUSTOM_AUDIENCE_USERS, VIDEO_EVENT_USERS, FB_PIXEL_HITS, IG_PROMOTED_POST, PLACE_VISITS, OFFLINE_EVENT_USERS, EXPANDED_AUDIENCE, SEED_LIST, PARTNER_CATEGORY_USERS, PAGE_SMART_AUDIENCE, MULTICOUNTRY_COMBINATION, PLATFORM_USERS, MULTI_EVENT_SOURCE, SMART_AUDIENCE, LOOKALIKE_PLATFORM, MAIL_CHIMP_EMAIL_HASHES, CONSTANT_CONTACTS_EMAIL_HASHES, COPY_PASTE_EMAIL_HASHES, CONTACT_IMPORTER, DATA_FILE.

data_source_type

string

itgen_facebook_data_source_type

☐

Custom Audience type: UNKNOWN, FILE_IMPORTED, EVENT_BASED, SEED_BASED, THIRD_PARTY_IMPORTED, COPY_PASTE, CONTACT_IMPORTER, HOUSEHOLD_AUDIENCE.

delivery_status_code

string

itgen_facebook_delivery_status_code

☐

Status code.

delivery_status_description

string

itgen_facebook_delivery_status_description

☐

Status description.

description

string

Description

☐

Custom audience description.

external_event_source_automatic_matching_fields

string

itgen_facebook_external_event_source_automatic_matching_fields

☐

List of advanced matching fields which are enabled for automatic advanced matching.

external_event_source_can_proxy

boolean

itgen_facebook_external_event_source_can_proxy

☐

Can proxy.

external_event_source_code

string

itgen_facebook_external_event_source_code

☐

Pixel code to be placed on the website.

external_event_source_creation_time

datetime

itgen_facebook_external_event_source_creation_time

☐

Time at which the pixel was created.

external_event_source_data_use_setting

string

itgen_facebook_external_event_source_data_use_setting

☐

Setting to capture how pixel data should be used.

external_event_source_enable_automatic_matching

boolean

itgen_facebook_external_event_source_enable_automatic_matching

☐

Represents whether automatic advanced matching is enabled for the pixel for identity matching purposes.

external_event_source_first_party_cookie_status

string

itgen_facebook_external_event_source_first_party_cookie_status

☐

First party cookie status to indicate whether first party cookies can be set for this pixel.

external_event_source_id

decimal

itgen_facebook_external_event_source_id

☐

ID of the pixel.

external_event_source_is_created_by_business

boolean

itgen_facebook_external_event_source_is_created_by_business

☐

Flag stands for if a pixel is created by busines.

external_event_source_last_fired_time

datetime

itgen_facebook_external_event_source_last_fired_time

☐

Time at which the pixel was last fired.

external_event_source_name

string

itgen_facebook_external_event_source_name

☐

Name of the pixel.

id

decimal

ID

☐

Video ID.

is_value_based

boolean

itgen_facebook_is_value_based

☐

Whether the audience is used to seed value based lookalike.

lookalike_audience_ids

string

itgen_facebook_lookalike_audience_ids

☐

List of IDs of the lookalike audiences generated from this audience.

lookalike_spec_country

string

itgen_facebook_lookalike_spec_country

☐

Two letter country code. The country to find the lookalikes in.

lookalike_spec_is_financial_service

boolean

itgen_facebook_lookalike_spec_is_financial_service

☐

Is this lookalike used in financial service.

lookalike_spec_origin

string

itgen_facebook_lookalike_spec_origin

☐

List of IDs of origin Custom Audience. The origin audience you create must have a minimum size of 100.

lookalike_spec_origin_event_name

string

itgen_facebook_lookalike_spec_origin_event_name

☐

The name of the origin event for value based LAL.

lookalike_spec_origin_event_source_name

string

itgen_facebook_lookalike_spec_origin_event_source_name

☐

The name of the origin event source. For example, for a product catalog based lookalike, this field will be the product catalog's name.

lookalike_spec_origin_event_source_type

string

itgen_facebook_lookalike_spec_origin_event_source_type

☐

The type of the origin event sources for value based LAL.

lookalike_spec_product_set_name

string

itgen_facebook_lookalike_spec_product_set_name

☐

The name of the product set that is used to create the lookalike. This field only exists for a product catalog based lookalike.

lookalike_spec_ratio

double

itgen_facebook_lookalike_spec_ratio

☐

Range 0.01-0.20. Indicates the top x% of original audience in the selected country. The default value is 0.01 which is 1%.

lookalike_spec_starting_ratio

string

itgen_facebook_lookalike_spec_starting_ratio

☐

Used for tiered lookalikes.

lookalike_spec_target_countries

string

itgen_facebook_lookalike_spec_target_countries

☐

List of two letter country codes. The countries to find the lookalikes in.

lookalike_spec_target_country_names

string

itgen_facebook_lookalike_spec_target_country_names

☐

Country names of corresponding two letter country code for each country used to find the lookalikes in.

lookalike_spec_type

string

itgen_facebook_lookalike_spec_type

☐

Type of the lookalike audience: similarity or reach.

name

string

Name

☐

Custom audience name.

operation_status_code

string

itgen_facebook_operation_status_code

☐

Status code.

operation_status_description

string

itgen_facebook_operation_status_description

☐

Status description.

opt_out_link

string

itgen_facebook_opt_out_link

☐

Your opt-out URL so people can choose not to be targeted.

pixel_id

decimal

itgen_facebook_pixel_id

☐

ID of the pixel which is collecting events for this Website Custom audience.

retention_days

int32

itgen_facebook_retention_days

☐

Number of days to keep the user in this cluster. You can use any value between 1 and 180 days. Defaults to forever if not specified.

rule

string

itgen_facebook_rule

☐

Audience rules to be applied on the referrer URL.

rule_aggregation

string

itgen_facebook_rule_aggregation

☐

Aggregation on top of the rule, examples of aggregations include: count, sum etc.

subtype

string

itgen_facebook_subtype

☐

Type of custom audience, derived from original data source. Note: Subtypes IG_BUSINESS, FB_EVENT, EXPERIMENTAL and MULTI_DATA can only be created through Ads Manager, Audience Manager, and not through the API.

time_content_updated

int32

itgen_facebook_time_content_updated

☐

Last update of people in this custom audience, this field is only supported for Customer List Custom Audiences.

time_updated

int32

itgen_facebook_time_updated

☐

Last time this audience metadata was updated.