Facebook API Data Model

ad_account_id

string

☑

Facebook ads account ID including prefix 'act_'.

account_account_id

decimal

itgen_facebook_account_account_id

☐

The ID of the ad account.

account_account_status

int32

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

account_age

double

itgen_facebook_account_age

☐

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

account_amount_spent

decimal

itgen_facebook_account_amount_spent

☐

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

account_attribution_spec

string

itgen_facebook_account_attribution_spec

☐

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

account_balance

decimal

itgen_facebook_account_balance

☐

Bill amount due.

account_business_city

string

itgen_facebook_account_business_city

☐

City for business address.

account_business_country_code

string

itgen_facebook_account_business_country_code

☐

Country code for the business address.

account_business_state

string

itgen_facebook_account_business_state

☐

State abbreviation for business address.

account_business_street

string

itgen_facebook_account_business_street

☐

First line of the business street address for the account.

account_business_street2

string

itgen_facebook_account_business_street2

☐

Second line of the business street address for the account.

account_business_zip

string

itgen_facebook_account_business_zip

☐

Zip code for business address.

account_can_create_brand_lift_study

boolean

itgen_facebook_account_can_create_brand_lift_study

☐

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

account_capabilities

string

itgen_facebook_account_capabilities

☐

Capabilities.

account_created_time

datetime

itgen_facebook_account_created_time

☐

The time the account was created in ISO 8601 format.

account_currency

string

itgen_facebook_account_currency

☐

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

account_disable_reason

int32

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

account_end_advertiser

decimal

itgen_facebook_account_end_advertiser

☐

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

account_end_advertiser_name

string

itgen_facebook_account_end_advertiser_name

☐

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

account_failed_delivery_checks

string

itgen_facebook_account_failed_delivery_checks

☐

Failed delivery checks.

account_funding_source

decimal

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

account_has_migrated_permissions

boolean

itgen_facebook_account_has_migrated_permissions

☐

Whether this account has migrated permissions.

account_id

string

itgen_facebook_account_id

☐

The string act_{ad_account_id}.

account_io_number

decimal

itgen_facebook_account_io_number

☐

The IO number.

account_is_attribution_spec_system_default

boolean

itgen_facebook_account_is_attribution_spec_system_default

☐

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

account_is_direct_deals_enabled

boolean

itgen_facebook_account_is_direct_deals_enabled

☐

Whether the account is enabled to run Direct Deals.

account_is_in_3ds_authorization_enabled_market

boolean

itgen_facebook_account_is_in_3ds_authorization_enabled_market

☐

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

account_is_in_middle_of_local_entity_migration

boolean

itgen_facebook_account_is_in_middle_of_local_entity_migration

☐

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

account_is_notifications_enabled

boolean

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

account_is_personal

boolean

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

account_is_prepay_account

boolean

itgen_facebook_account_is_prepay_account

☐

If this ad account is a prepay or postpay account.

account_is_tax_id_required

boolean

itgen_facebook_account_is_tax_id_required

☐

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

account_media_agency

decimal

itgen_facebook_account_media_agency

☐

The ID of a Facebook Page or Facebook Application.

account_min_campaign_group_spend_cap

decimal

itgen_facebook_account_min_campaign_group_spend_cap

☐

The minimum required spend cap of campaign group.

account_min_daily_budget

decimal

itgen_facebook_account_min_daily_budget

☐

The minimum daily budget for this ad account.

account_name

string

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

account_owner

decimal

itgen_facebook_account_owner

☐

The ID of the account owner.

account_partner

decimal

itgen_facebook_account_partner

☐

The ID of a Facebook Page or Facebook App.

account_spend_cap

decimal

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

account_tax_id

string

itgen_facebook_account_tax_id

☐

Tax ID.

account_tax_id_status

int32

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

account_tax_id_type

string

itgen_facebook_account_tax_id_type

☐

Type of Tax ID.

account_timezone_id

int32

itgen_facebook_account_timezone_id

☐

The timezone ID of this ad account.

account_timezone_name

string

itgen_facebook_account_timezone_name

☐

Name for the time zone.

account_timezone_offset_hours_utc

double

itgen_facebook_account_timezone_offset_hours_utc

☐

Time Zone difference from UTC.

account_user_role

decimal

itgen_facebook_account_user_role

☐

Role ID of the user.

business0_name

string

itgen_facebook_business0_name

☐

The business name for the account.

created_time

datetime

Created

☐

Created time.

id

decimal

ID

☐

Ad label ID.

name

string

Name

☐

Name.

updated_time

datetime

Updated

☐

Updated time.