Campaign Adsets

Reading

Edge query from Ad Campaign to Ad Sets

Example

Graph API Explorer

GET /v24.0/<AD_CAMPAIGN_ID>/adsets?fields=name%2Cstart_time%2Cend_time%2Cdaily_budget%2Clifetime_budget 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>/adsets?fields=name%2Cstart_time%2Cend_time%2Cdaily_budget%2Clifetime_budget',     '{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>/adsets",     {         "fields": "name,start_time,end_time,daily_budget,lifetime_budget"     },     function (response) {       if (response && !response.error) {         /* handle the result */       }     } );

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

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

curl -X GET -G \   -d 'fields="name,start_time,end_time,daily_budget,lifetime_budget"' \   -d 'access_token=<ACCESS_TOKEN>' \   https://graph.facebook.com/v24.0/<AD_CAMPAIGN_ID>/adsets

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}	Preset date range used to aggregate insights metrics
`effective_status` list<enum{ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, IN_PROCESS, WITH_ISSUES}>	Filter adsets by effective status
`is_completed` boolean	Filter adsets by completed status
`time_range` {'since':YYYY-MM-DD,'until':YYYY-MM-DD}	Time 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.

Fields

Reading from this edge will return a JSON formatted result:

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

`data`

A list of AdSet 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>	An analytics summary result for an Ad object
`total_count` unsigned int32	Total number of ad objects returned by the query Default

insights

Edge<AdsInsights>

An analytics summary result for an Ad object

total_count

unsigned int32

Total number of ad objects returned by the query

Default

Error Codes

Error	Description
613	Calls to this api have exceeded the rate limit.
100	Invalid parameter
200	Permissions error
3018	The start date of the time range cannot be beyond 37 months from the current date
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.
190	Invalid OAuth 2.0 Access Token
104	Incorrect signature
2635	You are calling a deprecated version of the Ads API. Please update to the latest version.
2500	Error parsing graph query