Graph API Version

Page Ads Posts

Reading

This API returns all ADS_POST created from ads post UI in ads manager. It can also return INLINE_CREATE posts which used to support delivered ads.

Requirements

You will need:

The pages_manage_ads permission
The pages_show_list permission
The ads_management permission
The person requesting the access token must be able to perform the ADVERTISE task on the Page.

New Page Experience

This endpoint is supported for New Page Experience.

Example

Graph API Explorer

GET /v21.0/{page-id}/ads_posts 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(
    '/{page-id}/ads_posts',
    '{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(
    "/{page-id}/ads_posts",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/ads_posts",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/ads_posts"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

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

Parameters

Parameter	Description
`exclude_dynamic_ads` boolean	Default value: `false` Exclude dynamic ad posts from the request
`include_inline_create` boolean	Default value: `false` Include also the INLINE_CREATE posts which are created to support delivered ads.
`since` datetime/timestamp	The earliest timestamp of return data set
`until` datetime/timestamp	The latest timestamp of return data set

Fields

Reading from this edge will return a JSON formatted result:

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

`data`

A list of PagePost 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=total_count).

Field Description

Field	Description
`total_count` unsigned int32	The total number of ad posts associated with this Page

total_count

unsigned int32

The total number of ad posts associated with this Page

Error Codes

Error	Description
200	Permissions error
80001	There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
190	Invalid OAuth 2.0 Access Token
100	Invalid parameter
104	Incorrect signature

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.