Ads.getCampaigns
From Facebook Developer Wiki
Contents |
Description
Note: This functionality is part of a limited beta program. If you’re interested in participating in the beta test, please contact your Facebook Advertising Account Manager. If you don’t yet have a Facebook Advertising Account Manager, you can request support at http://www.facebook.com/business/contact.php.
This API call returns an array of Facebook Ads Campaigns from the specified account ID. Each Campaign element is an array of ads_campaign_specs (link).
Parameters
| Required | Name | Type | Description | |
| required | api_key | string | The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call. | |
|---|---|---|---|---|
| session_key | string | The session key of the logged in user. The session key is automatically included by our PHP client. | ||
| call_id | float | The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function. If you specify the call ID in your client, you don't need to pass it with every call. | ||
| sig | string | An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically. | ||
| v | string | This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call. | ||
| account_id | int | The Facebook Ads account ID. The account ID must be one of the account IDs the session user can access. | ||
| campaign_ids | array | Specify an array of Campaign IDs to filter results otherwise specify null | ||
| include_deleted | bool | Toggle whether or not to retrieve deleted campaigns. | ||
| optional | No optional parameters |
Example Requests
$facebook->api_client->ads_getCampaigns(123456, null, false)
Response
This API call returns an array of ads.campaign_specs a snippet of a response is below
array (
0 =>
array (
'account_id' => 31705387,
'campaign_id' => 6002276788163,
'name' => 'My Ads',
'time_start' => 1241561957,
'time_stop' => 0,
'daily_budget' => 2500,
'campaign_status' => 1,
),..)
Error Codes
| Code | Description | |
| 1 | An unknown error occurred. Please resubmit the request. | |
|---|---|---|
| 4 | The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed. | |
| 100 | One of the parameters specified was missing or invalid. | |
| 200 | Permissions error. | |
| 801 | Data quota exceeded. | |
| 805 | Database error. |
