Overview
An ad account is an account object for managing ads. Each ad account can have multiple users, each with a different role. You may also create groups of ad accounts - learn more in the ad account group documentation.
Read
To read information about an ad account, make an HTTP GET call to
https://graph.facebook.com/act_{ad_account_id}/?fields=<comma separated list of fields>
And specify any of the following fields. Only
id is returned by default.| Name | Description | Type |
|---|---|---|
| account_groups | Container for the ID, name, and status of the account's account groups | array |
| account_id | The ID of the ad account | long |
| account_status | Status of the account. 1 = Active 2 = Disabled 3 = Unsettled 7 = Pending Review 101 = temporarily unavailable 100 = pending closure.) | integer |
| age | Amount of time the ad account has been open, in days | integer |
| agency_client_declaration | Details of the agency advertising on behalf of this client account, if applicable. See table below for more detail | object |
| amount_spent | Current total amount spent by the account. This can be reset. | integer |
| balance | Bill amount due | integer |
| business_city | City for business address | string |
| business_country_code | Country code for the business address | string |
| business_name | The business name for the account | string |
| business_state | State abbreviation for business address | string |
| business_street2 | Second line of the business street address for the account | string |
| business_street | First line of the business street address for the account | string |
| business_zip | Zip code for business address | string |
| capabilities | 1=DIRECT_SALES 2=PREMIUM 4= VIEW_TAGS 5= CUSTOM_CLUSTER_SHARING 6= LOOKALIKE_AUDIENCE 7= CUSTOM_AUDIENCES_OPT_OUT_LINK 12= CUSTOM_AUDIENCES_FOLDERS 28=NEW_CAMPAIGN_STRUCTURE | array. April 9th breaking change notice: The enum (string) value will be used instead of the array value. |
| currency | The currency used for the account, based on the corresponding value in the account settings. The list of supported currencies can be found here | string |
| daily_spend_limit | The account's limit for daily spend, based on the corresponding value in the account settings | integer |
| id | The string act_{ad_account_id} | string |
| is_personal | If this is a personal or business account | integer |
| name | Name of the account; note that many accounts are unnamed, so this field may be empty | string |
| offsite_pixels_tos_accepted | Indicates whether the offsite pixel Terms Of Service contract was signed | boolean |
| spend_cap | The maximum that can be spent by this account after which campaigns will be paused. | integer |
| timezone_id | ID for the timezone. See here | integer |
| timezone_name | Name for the time zone | string |
| timezone_offset_hours_utc | Time Zone difference from UTC | integer |
| tos_accepted | IDs of Terms of Service contracts signed | array |
| users | Container for the user ID, permissions, and role | array |
| vat_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 | integer |
Description of the fields in array
agency_client_declaration:| Name | Description | Type |
|---|---|---|
| agency_representing_client | Whether this account is for an agency representing a client | integer |
| client_based_in_france | Whether the client is based in France | integer |
| has_written_mandate_from_advertiser | Whether the agency has a written mandate to advertise on behalf of this client | integer |
| is_client_paying_invoices | Whether the client is paying via invoice | integer |
| client_name | Name of the client | string |
| client_email_address | Client's email address | string |
| client_street | First line of client's street address | string |
| client_street2 | Second line of client's street address | string |
| client_city | Client's city | string |
| client_province | Client's province | string |
| client_postal_code | Client's postal code | string |
| client_country_code | Client's country code | string |
Update
To update the below fields of an ad account, make an HTTP POST call to
https://graph.facebook.com/act_{ad_account_id}
with the following mutable fields:
You can only update one field at a time.
| Name | Description | Type |
|---|---|---|
| spend_cap | The total amount that this account can spend, after which all campaigns will be paused, based on amount_spent. | integer |
| spend_cap_action | Setting this parameter to reset sets the amount_spent back to 0. Setting it to delete removes the spend_cap from the account. | string |
The response will be
true.Connections
An Ad Account object has connections to other information. To query an account's connections, make an HTTP GET call to
https://graph.facebook.com/act_{ad_account_id}/{connection_name}
The list below details which connections are available:
| Name | Description | Type |
|---|---|---|
| users | The users of the ad account | array of aduser objects |
| adcampaign_groups | The ad campaigns in the account | array of ad campaign objects |
| adcampaigns | The ad sets in the account | array of ad set objects |
| adgroups | The ads of the account | array of adgroup objects |
| adcreatives | The creatives in the account's creative library | array of adcreative objects |
| adimages | The ad images of the account | array of adimage objects |
| adcampaignstats | The statistics for the account by ad campaign | array of adstatistics objects |
| adgroupstats | The statistics for the account by ad group | array of adstatistics objects |
| stats | The statistics for the account in aggregate | array of adstatistics objects |
| reportstats | The statistics for the account using the new Ad Report Stats API | Dependent on input, see report stats documentation |
| adpreviewscss | The Ad Preview CSS for the account | Ad Preview CSS snippet |
| broadtargetingcategories | Array of broad category targeting (BCT) that you can specify for ads | array of broadcategorytargetingobjects |
| connectionobjects | The Connection Objects of the ad account user | array of connectionobjects objects |
| ratecard | The Rate Cards for Homepage Ads for this account | array of objects containing the country, currency and price for each rate |
| reachestimate | Used to estimate the reach of intended targeting | array of reachestimate objects |
| transactions | The payment order for the account | Payment Order object |
Limits
The following are the limits on ad account
- What is the maximum amount of accounts that a user can have? : 25
- What is the maximum number of users per account? : 25
- How many ads can a regular ad account have? : 5,000 non-deleted ads
- How many ads can a bulk ad account have? : 50,000 non-deleted ads
- How many sets can a regular ad account have? : 1,000 non-deleted sets
- How many sets can a bulk ad account have? : 10,000 non-deleted sets
- How many campaigns can a regular ad account have? : 1,000 non-deleted campaigns
- How many campaigns can a bulk ad account have? : 10,000 non-deleted campaigns
- How many images can be uploaded to each ad account? There is no limit
Examples
Updating the spend cap of an ad account
curl \
-F "spend_cap=1000" \
-F "access_token=_____" \
"https://graph.facebook.com/act_12345678"
Querying for all ad campaigns in this ad account
curl -G \
-d "access_token=_____" \
"https://graph.facebook.com/act_12345678/adcampaigns"
Querying for the objects that this ad account's user is connected to
curl -G \
-d "access_token=_____" \
"https://graph.facebook.com/act_12345678/connectionobjects"
Finding the list of users who have access to this ad account
curl -G \
-d "access_token=_____" \
"https://graph.facebook.com/act_12345678/users"
No comments:
Post a Comment