Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

automatic_matching_fields

string

itgen_facebook_automatic_matching_fields

☐

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

business0_name

string

itgen_facebook_business0_name

☐

The business name for the account.

can_proxy

boolean

itgen_facebook_can_proxy

☐

Can proxy.

code

string

itgen_facebook_code

☐

Pixel code to be placed on the website.

creation_time

datetime

itgen_facebook_creation_time

☐

Time at which the pixel was created.

creator_birthday

string

itgen_facebook_creator_birthday

☐

The person's birthday. This is a fixed format string, like MM/DD/YYYY. However, people can control who can see the year they were born separately from the month and day so this string can be only the year (YYYY) or the month + day (MM/DD).

creator_can_review_measurement_request

boolean

itgen_facebook_creator_can_review_measurement_request

☐

Can the person review brand polls.

creator_email

string

itgen_facebook_creator_email

☐

The User's primary email address listed on their profile. This field will not be returned if no valid email address is available.

creator_first_name

string

itgen_facebook_creator_first_name

☐

The person's first name.

creator_gender

string

itgen_facebook_creator_gender

☐

The gender selected by this person, male or female. If the gender is set to a custom value, this value will be based off of the preferred pronoun; it will be omitted if the preferred preferred pronoun is neutral.

creator_id

decimal

itgen_facebook_creator_id

☐

The id of this person's user account. This ID is unique to each app and cannot be used across different apps.

creator_install_type

string

itgen_facebook_creator_install_type

☐

Install type.

creator_installed

string

itgen_facebook_creator_installed

☐

Is the app making the request installed.

creator_is_famedeeplinkinguser

boolean

itgen_facebook_creator_is_famedeeplinkinguser

☐

If the user has used FAME deeplinking.

creator_is_shared_login

boolean

itgen_facebook_creator_is_shared_login

☐

Is this a shared login (e.g. a gray user).

creator_last_name

string

itgen_facebook_creator_last_name

☐

The person's last name.

creator_link

string

itgen_facebook_creator_link

☐

A link to the person's Timeline. The link will only resolve if the person clicking the link is logged into Facebook and is a friend of the person whose profile is being viewed.

creator_middle_name

string

itgen_facebook_creator_middle_name

☐

The person's middle name.

creator_name

string

itgen_facebook_creator_name

☐

The person's full name.

creator_name_format

string

itgen_facebook_creator_name_format

☐

The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering.

creator_public_key

string

itgen_facebook_creator_public_key

☐

The person's PGP public key.

creator_quotes

string

itgen_facebook_creator_quotes

☐

The person's favorite quotes.

creator_shared_login_upgrade_required_by

datetime

itgen_facebook_creator_shared_login_upgrade_required_by

☐

The time that the shared loginneeds to be upgraded to Business Manager by.

creator_short_name

string

itgen_facebook_creator_short_name

☐

Shortened, locale-aware name for the person.

creator_test_group

int32

itgen_facebook_creator_test_group

☐

Platform test group.

creator_viewer_can_send_gift

boolean

itgen_facebook_creator_viewer_can_send_gift

☐

Can the viewer send a gift to this person?

data_use_setting

string

itgen_facebook_data_use_setting

☐

Setting to capture how pixel data should be used.

enable_automatic_matching

boolean

itgen_facebook_enable_automatic_matching

☐

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

first_party_cookie_status

string

itgen_facebook_first_party_cookie_status

☐

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

id

decimal

ID

☐

ID of the pixel.

is_created_by_business

boolean

itgen_facebook_is_created_by_business

☐

Flag stands for if a pixel is created by busines.

last_fired_time

datetime

itgen_facebook_last_fired_time

☐

Time at which the pixel was last fired.

name

string

Name

☐

Name of the pixel.

owner_ad_account_account_id

decimal

itgen_facebook_owner_ad_account_account_id

☐

The ID of the ad account.

owner_ad_account_account_status

int32

itgen_facebook_owner_ad_account_account_status

☐

Status of the account: 1 = ACTIVE, 2 = DISABLED, 3 = UNSETTLED, 7 = PENDING_RISK_REVIEW, 8 = PENDING_SETTLEMENT, 9 = IN_GRACE_PERIOD, 100 = PENDING_CLOSURE, 101 = CLOSED, 201 = ANY_ACTIVE, 202 = ANY_CLOSED.

owner_ad_account_age

double

itgen_facebook_owner_ad_account_age

☐

Amount of time the ad account has been open, in days.

owner_ad_account_amount_spent

decimal

itgen_facebook_owner_ad_account_amount_spent

☐

Current total amount spent by the account. This can be reset.

owner_ad_account_attribution_spec

string

itgen_facebook_owner_ad_account_attribution_spec

☐

The attribution specification of ad account, including click through window length, view through window length, etc.

owner_ad_account_balance

decimal

itgen_facebook_owner_ad_account_balance

☐

Bill amount due.

owner_ad_account_business_city

string

itgen_facebook_owner_ad_account_business_city

☐

City for business address.

owner_ad_account_business_country_code

string

itgen_facebook_owner_ad_account_business_country_code

☐

Country code for the business address.

owner_ad_account_business_state

string

itgen_facebook_owner_ad_account_business_state

☐

State abbreviation for business address.

owner_ad_account_business_street

string

itgen_facebook_owner_ad_account_business_street

☐

First line of the business street address for the account.

owner_ad_account_business_street2

string

itgen_facebook_owner_ad_account_business_street2

☐

Second line of the business street address for the account.

owner_ad_account_business_zip

string

itgen_facebook_owner_ad_account_business_zip

☐

Zip code for business address.

owner_ad_account_can_create_brand_lift_study

boolean

itgen_facebook_owner_ad_account_can_create_brand_lift_study

☐

If we can create a new automated brand lift study under the ad account.

owner_ad_account_capabilities

string

itgen_facebook_owner_ad_account_capabilities

☐

Capabilities.

owner_ad_account_created_time

datetime

itgen_facebook_owner_ad_account_created_time

☐

The time the account was created in ISO 8601 format.

owner_ad_account_currency

string

itgen_facebook_owner_ad_account_currency

☐

The currency used for the account, based on the corresponding value in the account settings.

owner_ad_account_disable_reason

int32

itgen_facebook_owner_ad_account_disable_reason

☐

The reason why the account was disabled. Possible reasons are: 0 = NONE, 1 = ADS_INTEGRITY_POLICY, 2 = ADS_IP_REVIEW, 3 = RISK_PAYMENT, 4 = GRAY_ACCOUNT_SHUT_DOWN, 5 = ADS_AFC_REVIEW, 6 = BUSINESS_INTEGRITY_RAR, 7 = PERMANENT_CLOSE, 8 = UNUSED_RESELLER_ACCOUNT, 9 = UNUSED_ACCOUNT.

owner_ad_account_end_advertiser

decimal

itgen_facebook_owner_ad_account_end_advertiser

☐

The ID of a Facebook Page, Facebook App, or Facebook Business.

owner_ad_account_end_advertiser_name

string

itgen_facebook_owner_ad_account_end_advertiser_name

☐

The name of a Facebook Page, Facebook App, or Facebook Business.

owner_ad_account_failed_delivery_checks

string

itgen_facebook_owner_ad_account_failed_delivery_checks

☐

Failed delivery checks.

owner_ad_account_funding_source

decimal

itgen_facebook_owner_ad_account_funding_source

☐

ID of the payment method. If the account does not have a payment method it will still be possible to create ads but these ads will get no delivery. Not available if the account is disabled.

owner_ad_account_has_migrated_permissions

boolean

itgen_facebook_owner_ad_account_has_migrated_permissions

☐

Whether this account has migrated permissions.

owner_ad_account_id

string

itgen_facebook_owner_ad_account_id

☐

The string act_{ad_account_id}.

owner_ad_account_io_number

decimal

itgen_facebook_owner_ad_account_io_number

☐

The IO number.

owner_ad_account_is_attribution_spec_system_default

boolean

itgen_facebook_owner_ad_account_is_attribution_spec_system_default

☐

If the attribution specification of ad account is generated from system default values.

owner_ad_account_is_direct_deals_enabled

boolean

itgen_facebook_owner_ad_account_is_direct_deals_enabled

☐

Whether the account is enabled to run Direct Deals.

owner_ad_account_is_in_3ds_authorization_enabled_market

boolean

itgen_facebook_owner_ad_account_is_in_3ds_authorization_enabled_market

☐

If the account is in a market requiring to go through payment process going through 3DS authorization.

owner_ad_account_is_in_middle_of_local_entity_migration

boolean

itgen_facebook_owner_ad_account_is_in_middle_of_local_entity_migration

☐

If the account is in the peroid localization project rolling out.

owner_ad_account_is_notifications_enabled

boolean

itgen_facebook_owner_ad_account_is_notifications_enabled

☐

Get the notifications status of the user for this ad account. This will return true or false depending if notifications are enabled or not.

owner_ad_account_is_personal

boolean

itgen_facebook_owner_ad_account_is_personal

☐

Indicates that this ad account is being used for private, non-business purposes which affects how value added tax (VAT) is assessed. NOTE: This does not mean if an account is attached to a business or not.

owner_ad_account_is_prepay_account

boolean

itgen_facebook_owner_ad_account_is_prepay_account

☐

If this ad account is a prepay or postpay account.

owner_ad_account_is_tax_id_required

boolean

itgen_facebook_owner_ad_account_is_tax_id_required

☐

If tax id for this ad account is required or not.

owner_ad_account_media_agency

decimal

itgen_facebook_owner_ad_account_media_agency

☐

The ID of a Facebook Page or Facebook Application.

owner_ad_account_min_campaign_group_spend_cap

decimal

itgen_facebook_owner_ad_account_min_campaign_group_spend_cap

☐

The minimum required spend cap of campaign group.

owner_ad_account_min_daily_budget

decimal

itgen_facebook_owner_ad_account_min_daily_budget

☐

The minimum daily budget for this ad account.

owner_ad_account_name

string

itgen_facebook_owner_ad_account_name

☐

Name of the account. If the account name is not set, the name of the first admin visible to the user will be returned.

owner_ad_account_owner

decimal

itgen_facebook_owner_ad_account_owner

☐

The ID of the account owner.

owner_ad_account_partner

decimal

itgen_facebook_owner_ad_account_partner

☐

The ID of a Facebook Page or Facebook App.

owner_ad_account_spend_cap

decimal

itgen_facebook_owner_ad_account_spend_cap

☐

The maximum that can be spent by this account after which campaigns will be paused. A value of 0 signifies no spending-cap and setting a new spend cap only applies to spend AFTER the time at which you set it. Value specified in basic unit of the currency, e.g. cents for USD.

owner_ad_account_tax_id

string

itgen_facebook_owner_ad_account_tax_id

☐

Tax ID.

owner_ad_account_tax_id_status

int32

itgen_facebook_owner_ad_account_tax_id_status

☐

VAT status code for the account: 0: Unknown, 1: VAT not required - US / CA, 2: VAT information required, 3: VAT information submitted, 4: Offline VAT validation failed, 5: Account is a personal account.

owner_ad_account_tax_id_type

string

itgen_facebook_owner_ad_account_tax_id_type

☐

Type of Tax ID.

owner_ad_account_timezone_id

int32

itgen_facebook_owner_ad_account_timezone_id

☐

The timezone ID of this ad account.

owner_ad_account_timezone_name

string

itgen_facebook_owner_ad_account_timezone_name

☐

Name for the time zone.

owner_ad_account_timezone_offset_hours_utc

double

itgen_facebook_owner_ad_account_timezone_offset_hours_utc

☐

Time Zone difference from UTC.

owner_ad_account_user_role

decimal

itgen_facebook_owner_ad_account_user_role

☐

Role ID of the user.

owner_business_created_by

string

itgen_facebook_owner_business_created_by

☐

Username and id who created this manager.

owner_business_creation_time

string

itgen_facebook_owner_business_creation_time

☐

Time this business created.

owner_business_id

decimal

itgen_facebook_owner_business_id

☐

The id of this person's user account. This ID is unique to each app and cannot be used across different apps.

owner_business_name

string

itgen_facebook_owner_business_name

☐

Name.

owner_business_timezone_id

int32

itgen_facebook_owner_business_timezone_id

☐

ID of the business's timezone.

owner_business_update_time

string

itgen_facebook_owner_business_update_time

☐

Last time this Business Manager was updated.

owner_business_updated_by

string

itgen_facebook_owner_business_updated_by

☐

Last user, by name and id, who have updated this manager.