An account for managing ads, as represented in the Graph API.
Before using this object, see Ads on the Graph API.
The adaccount object is a connection of the following objects:
To read an adaccount you need the following permissions: ads_management.
Retrieve the information for an account with a URL similar to the following:
https://graph.facebook.com/act_AccountID?access_token=___
| Name | Description | Permissions | Returns |
|---|---|---|---|
account_groups |
Container for the ID, name, and status of the account's account groups | ads_management |
array |
account_id |
The ID of the ads account | ads_management |
long |
account_status |
Status of the account (regular values are 1 = Active, 2 = Disabled, 3 = Unsettled, 7 = Pending Review). This can also have a value of 101 if the account is temporarily unavailable and 100 if the account is pending closure.) | ads_management |
int |
agency_client_declaration |
Details of the agency advertising on behalf of this client account, if applicable. | ads_management |
object |
amount_spent |
Current total amount spent by the account. This can be reset. | ads_management |
integer |
business_city |
City for business address | ads_management |
string |
business_country_code |
Country code for the business address | ads_management |
string |
business_name |
The business name for the account | ads_management |
string |
business_state |
State abbreviation for business address | ads_management |
string |
business_street2 |
Second line of the business street address for the account | ads_management |
string |
business_street |
First line of the business street address for the account | ads_management |
string |
business_zip |
Zip code for business address | ads_management |
string |
capabilities |
Reserved for future use | ads_management |
array |
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 | ads_management |
string |
daily_spend_limit |
The account's limit for daily spend, based on the corresponding value in the account settings | ads_management |
int |
is_personal |
If this is a personal or business account | ads_management |
integer |
name |
Name of the account; note that many accounts are unnamed, so this field may be empty | ads_management |
string |
spend_cap |
The maximum that can be spent by this account after which campaigns will be paused. | ads_management |
integer |
timezone_id |
ID for the timezone | ads_management |
int |
timezone_name |
Name for the time zone | ads_management |
string |
timezone_offset_hours_utc |
Time Zone difference from UTC; note that the offset does not change based on daylight savings | ads_management |
integer |
users |
Container for the user ID, permissions, and role (see below) | ads_management |
array |
vat_status |
Vat status code for the account. Here are the values for VAT Status: 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 | ads_management |
integer |
Members of the array agency_client_declaration:
| Name | Description | Permissions | Returns |
|---|---|---|---|
| agency_representing_client | Whether this account is for an agency representing a client | ads_management |
integer |
| client_based_in_france | Whether the client is based in France | ads_management |
integer |
| has_written_mandate_from_advertiser | Whether the agency has a written mandate to advertise on behalf of this client | ads_management |
integer |
| is_client_paying_invoices | Whether the client is paying via invoice | ads_management |
integer |
| client_name | Name of the client | ads_management |
string |
| client_email_address | Client's email address | ads_management |
string |
| client_street | First line of client's street address | ads_management |
string |
| client_street2 | Second line of client's street address | ads_management |
string |
| client_city | Client's city | ads_management |
string |
| client_province | Client's province | ads_management |
string |
| client_postal_code | Client's postal code | ads_management |
string |
| client_country_code | Client's country code | ads_management |
string |
The adaccount object has the following connections.
| Name | Description | Permissions | Returns |
|---|---|---|---|
| adcampaignstats | The statistics for the account by ad campaign | ads_management |
array of adstatistics objects |
| adcampaigns | The campaigns in the account | ads_management |
array of adcampaign objects |
| adcreatives | The creatives in the account's creative library | ads_management |
array of adcreative objects |
| adgroupstats | The statistics for the account by ad group | ads_management |
array of adstatistics objects |
| adgroups | The ads of the account | ads_management |
array of adgroup objects |
| adimages | The ad images of the account | ads_management |
array of adimage objects |
| adpreviewscss | The Ad Preview CSS for the account | ads_management |
Ad Preview CSS snippet |
| broadtargetingcategories | Array of broad category targeting (BCT) that you can specify for ads | ads_management |
array of broadcategorytargeting objects |
| connectionobjects | The Connection Objects of the ad account user | ads_management |
array of connectionobjects objects |
| generatepreviews | Generates a Preview of an Ad group | ads_management |
Ad Preview HTML snippet |
| ratecard | The Rate Cards for Homepage Ads for this account |
ads_management |
array of objects containing the country, currency and price for each rate |
| reachestimate | The Reach Estimate of the supplied targeting | ads_management |
array of reachestimate objects |
| stats | The statistics for the account | ads_management |
array of adstatistics objects |
| targetingsentencelines | Can be queried to get a targeting description for a targeting spec | ads_management |
targetingsentencelines |
| transactions | The payment order for the account | ads_management |
Payment Order object |
| users | The users of the ad account | ads_management |
array of aduser objects |
The following are the limits on ad account
The total amount an account can spend can be limited using a spend_cap and is based on amount_spent. These can be updated using the spend_cap or spend_cap_action parameters, but cannot be combined within a single request.
| Parameter | Description | Type |
|---|---|---|
spend_cap |
The total amount that this account can spend, after which all campaigns will be paused. | integer |
spend_cap_action |
reset sets the amount_spent back to 0. delete removes the spend_cap from the account. |
string |
Specify act_AccountID, or /me/adaccounts, to retrieve the basic data for an ad account.
Thus, a basic example for getting account data is the following, if the account ID is act_368811234:
https://graph.facebook.com/act_368811234?access_token=_____
The result will be similar to the following:
{
"id": "act_368811234",
"name": "My Account Name",
"account_status": 1,
"currency": "USD",
"timezone_id": 1,
"timezone_name": "America/Los_Angeles",
"daily_spend_limit": 25000,
"users": [
{
"uid": 545071234,
"permissions": [
1,2,3,4,5,7
],
"role": 1002
},
{
"uid": 1270651234,
"permissions": [
1,2,3,4,5,7
],
"role": 1001
}],
"account_groups": [
{
"account_group_id": 121069936651234,
"name": "name_of_account_group",
"status": 1
}],
"capabilities": []}
The account data includes the account ID (in the 'id' field), name, currency, time zone, and daily spend limit. The account data also includes associated account groups and the user IDs of authorized users.
The account name may be the empty string if the user has never changed the name of their account in the Facebook Ads Manager. The time zone for an account is returned in the timezone_id field; you can download the list of timezone IDs at Ads API Time Zones.