Facebook API Data Model

account_id

decimal

itgen_facebook_account_id

☐

The ID of the ad account.

account_status

int32

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

age

double

itgen_facebook_age

☐

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

agency_client_declaration_agency_representing_client

int32

itgen_facebook_agency_client_declaration_agency_representing_client

☐

Whether this account is for an agency representing a client.

agency_client_declaration_client_based_in_france

int32

itgen_facebook_agency_client_declaration_client_based_in_france

☐

Whether the client is based in France.

agency_client_declaration_client_city

string

itgen_facebook_agency_client_declaration_client_city

☐

Client's city.

agency_client_declaration_client_country_code

string

itgen_facebook_agency_client_declaration_client_country_code

☐

Client's country code.

agency_client_declaration_client_email_address

string

itgen_facebook_agency_client_declaration_client_email_address

☐

Client's email address.

agency_client_declaration_client_name

string

itgen_facebook_agency_client_declaration_client_name

☐

Name of the client.

agency_client_declaration_client_postal_code

string

itgen_facebook_agency_client_declaration_client_postal_code

☐

Client's postal code.

agency_client_declaration_client_province

string

itgen_facebook_agency_client_declaration_client_province

☐

Client's province.

agency_client_declaration_client_street

string

itgen_facebook_agency_client_declaration_client_street

☐

First line of client's street address.

agency_client_declaration_client_street2

string

itgen_facebook_agency_client_declaration_client_street2

☐

Second line of client's street address.

agency_client_declaration_has_written_mandate_from_advertiser

int32

itgen_facebook_agency_client_declaration_has_written_mandate_from_advertiser

☐

Whether the agency has a written mandate to advertise on behalf of this client.

agency_client_declaration_is_client_paying_invoices

int32

itgen_facebook_agency_client_declaration_is_client_paying_invoices

☐

Whether the client is paying via invoice.

amount_spent

decimal

itgen_facebook_amount_spent

☐

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

attribution_spec

string

itgen_facebook_attribution_spec

☐

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

balance

decimal

itgen_facebook_balance

☐

Bill amount due.

business_city

string

itgen_facebook_business_city

☐

City for business address.

business_country_code

string

itgen_facebook_business_country_code

☐

Country code for the business address.

business_created_by

string

itgen_facebook_business_created_by

☐

Username and id who created this manager.

business_creation_time

string

itgen_facebook_business_creation_time

☐

Time this business created.

business_id

decimal

itgen_facebook_business_id

☐

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

business_name

string

itgen_facebook_business_name

☐

Name.

business_state

string

itgen_facebook_business_state

☐

State abbreviation for business address.

business_street

string

itgen_facebook_business_street

☐

First line of the business street address for the account.

business_street2

string

itgen_facebook_business_street2

☐

Second line of the business street address for the account.

business_timezone_id

int32

itgen_facebook_business_timezone_id

☐

ID of the business's timezone.

business_update_time

string

itgen_facebook_business_update_time

☐

Last time this Business Manager was updated.

business_updated_by

string

itgen_facebook_business_updated_by

☐

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

business_zip

string

itgen_facebook_business_zip

☐

Zip code for business address.

business0_name

string

itgen_facebook_business0_name

☐

The business name for the account.

can_create_brand_lift_study

boolean

itgen_facebook_can_create_brand_lift_study

☐

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

capabilities

string

itgen_facebook_capabilities

☐

Capabilities.

created_time

datetime

Created

☐

The time the account was created in ISO 8601 format.

currency

string

itgen_facebook_currency

☐

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

disable_reason

int32

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

end_advertiser

decimal

itgen_facebook_end_advertiser

☐

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

end_advertiser_name

string

itgen_facebook_end_advertiser_name

☐

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

failed_delivery_checks

string

itgen_facebook_failed_delivery_checks

☐

Failed delivery checks.

funding_source

decimal

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

funding_source_details_amount

decimal

itgen_facebook_funding_source_details_amount

☐

Amount of Facebook Ads Coupon.

funding_source_details_coupon

string

itgen_facebook_funding_source_details_coupon

☐

Details of the Facebook Ads Coupon from the payment method.

funding_source_details_currency

string

itgen_facebook_funding_source_details_currency

☐

Currency of the Facebook Ads Coupon.

funding_source_details_display_amount

string

itgen_facebook_funding_source_details_display_amount

☐

How the amount of Facebook Ads Coupon is displayed.

funding_source_details_expiration

datetime

itgen_facebook_funding_source_details_expiration

☐

When the coupon will expire.

funding_source_details_id

decimal

itgen_facebook_funding_source_details_id

☐

ID of the payment method.

funding_source_details_type

int32

itgen_facebook_funding_source_details_type

☐

Type of the funding source: 0 = Unset, 1 = Credit carrd, 2 = Facebook wallet, 3 = Facebook paid credit, 4 = Facebook extended credit, 5 = Order, 6 = Invoice, 7 = Facebook token, 8 = External funding, 9 = Fee, 10 = FX, 11 = Discount, 12 = PayPal token, 13 = PayPal billing agreement, 14 = FS null, 15 = External deposit, 16 = Tax, 17 = Direct debit, 18 = Dummy, 19 = Altpay, 20 = Stored balance.

has_migrated_permissions

boolean

itgen_facebook_has_migrated_permissions

☐

Whether this account has migrated permissions.

id

string

ID

☐

The string act_{ad_account_id}.

io_number

decimal

itgen_facebook_io_number

☐

The IO number.

is_attribution_spec_system_default

boolean

itgen_facebook_is_attribution_spec_system_default

☐

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

is_direct_deals_enabled

boolean

itgen_facebook_is_direct_deals_enabled

☐

Whether the account is enabled to run Direct Deals.

is_in_3ds_authorization_enabled_market

boolean

itgen_facebook_is_in_3ds_authorization_enabled_market

☐

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

is_in_middle_of_local_entity_migration

boolean

itgen_facebook_is_in_middle_of_local_entity_migration

☐

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

is_notifications_enabled

boolean

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

is_personal

boolean

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

is_prepay_account

boolean

itgen_facebook_is_prepay_account

☐

If this ad account is a prepay or postpay account.

is_tax_id_required

boolean

itgen_facebook_is_tax_id_required

☐

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

media_agency

decimal

itgen_facebook_media_agency

☐

The ID of a Facebook Page or Facebook Application.

min_campaign_group_spend_cap

decimal

itgen_facebook_min_campaign_group_spend_cap

☐

The minimum required spend cap of campaign group.

min_daily_budget

decimal

itgen_facebook_min_daily_budget

☐

The minimum daily budget for this ad account.

name

string

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

decimal

itgen_facebook_owner

☐

The ID of the account owner.

partner

decimal

itgen_facebook_partner

☐

The ID of a Facebook Page or Facebook App.

rf_spec_countries

string

itgen_facebook_rf_spec_countries

☐

Array of Supported countries for reach and frequency.

rf_spec_max_campaign_duration

string

itgen_facebook_rf_spec_max_campaign_duration

☐

Object of Maximum campaign duration in days, per supported country.

rf_spec_max_days_to_finish

string

itgen_facebook_rf_spec_max_days_to_finish

☐

Object of Days in advance campaign can finish at time prediction made, per supported country.

rf_spec_min_campaign_duration

string

itgen_facebook_rf_spec_min_campaign_duration

☐

Object of Minimum campaign duration in days, per supported country.

rf_spec_min_reach_limits

string

itgen_facebook_rf_spec_min_reach_limits

☐

Object of Minimum reach in number of people, per supported country.

spend_cap

decimal

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

tax_id

string

itgen_facebook_tax_id

☐

Tax ID.

tax_id_status

int32

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

tax_id_type

string

itgen_facebook_tax_id_type

☐

Type of Tax ID.

timezone_id

int32

itgen_facebook_timezone_id

☐

The timezone ID of this ad account.

timezone_name

string

itgen_facebook_timezone_name

☐

Name for the time zone.

timezone_offset_hours_utc

double

itgen_facebook_timezone_offset_hours_utc

☐

Time Zone difference from UTC.

user_role

decimal

itgen_facebook_user_role

☐

Role ID of the user.