Campaign Ads

Reading

Ads under this campaign.

Example

Graph API Explorer

GET /v24.0/<AD_CAMPAIGN_ID>/ads?fields=name HTTP/1.1 Host: graph.facebook.com

/* PHP SDK v5.0.0 */ /* make the API call */ try {   // Returns a `Facebook\FacebookResponse` object   $response = $fb->get(     '/<AD_CAMPAIGN_ID>/ads?fields=name',     '{access-token}'   ); } catch(Facebook\Exceptions\FacebookResponseException $e) {   echo 'Graph returned an error: ' . $e->getMessage();   exit; } catch(Facebook\Exceptions\FacebookSDKException $e) {   echo 'Facebook SDK returned an error: ' . $e->getMessage();   exit; } $graphNode = $response->getGraphNode(); /* handle the result */

/* make the API call */ FB.api(     "/<AD_CAMPAIGN_ID>/ads",     {         "fields": "name"     },     function (response) {       if (response && !response.error) {         /* handle the result */       }     } );

Bundle params = new Bundle(); params.putString("fields", "name"); /* make the API call */ new GraphRequest(     AccessToken.getCurrentAccessToken(),     "/<AD_CAMPAIGN_ID>/ads",     params,     HttpMethod.GET,     new GraphRequest.Callback() {         public void onCompleted(GraphResponse response) {             /* handle the result */         }     } ).executeAsync();

NSDictionary *params = @{   @"fields": @"name", }; /* make the API call */ FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]                                initWithGraphPath:@"/<AD_CAMPAIGN_ID>/ads"                                       parameters:params                                       HTTPMethod:@"GET"]; [request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,                                       id result,                                       NSError *error) {     // Handle the result }];

curl -X GET -G \   -d 'fields="name"' \   -d 'access_token=<ACCESS_TOKEN>' \   https://graph.facebook.com/v24.0/<AD_CAMPAIGN_ID>/ads

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

Parameter	Description
`date_preset` enum{today, yesterday, this_month, last_month, this_quarter, maximum, data_maximum, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, last_week_mon_sun, last_week_sun_sat, last_quarter, last_year, this_week_mon_today, this_week_sun_today, this_year}	Date ranges container for benchmarking comparison
`effective_status` list<string>	Filter ads by effective status
`time_range` {'since':YYYY-MM-DD,'until':YYYY-MM-DD}	Date range used to aggregate insights metrics
`since` datetime	A date in the format of "YYYY-MM-DD", which means from the beginning midnight of that day.
`until` datetime	A date in the format of "YYYY-MM-DD", which means to the beginning midnight of the following day.
`updated_since` integer	SELF_EXPLANATORY

Fields

Reading from this edge will return a JSON formatted result:

{     "data": [],     "paging": {},     "summary": {} }

`data`

A list of Ad nodes.

`paging`

For more details about pagination, see the Graph API guide.

`summary`

Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=insights).

Field Description

Field	Description
`insights` Edge<AdsInsights>	Analytics summary for all objects
`total_count` unsigned int32	Total number of objects Default

insights

Edge<AdsInsights>

Analytics summary for all objects

total_count

unsigned int32

Total number of objects

Default

Error Codes

Error	Description
100	Invalid parameter
80004	There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management.
3018	The start date of the time range cannot be beyond 37 months from the current date
104	Incorrect signature
190	Invalid OAuth 2.0 Access Token
200	Permissions error
2500	Error parsing graph query