Marketing API Version

Ad Study Cell

Reading

A lift study cell object

Examples

To read the details of an Ad study cell, make an HTTP GET request to

 https://graph.facebook.com/<API_VERSION>/<AD_STUDY_CELL_ID>

Examples

Graph API Explorer
GET /v2.10/{ad-study-cell-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{ad-study-cell-id}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{ad-study-cell-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{ad-study-cell-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{ad-study-cell-id}"
                                      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

This endpoint doesn't have any parameters.

Fields

FieldDescription

ad_entities_count

unsigned int32

The sum of the number of ad accounts, ad campaigns and ad sets in this cell

id

numeric string

ID of the Lift study cell

name

string

Name of the Lift study cell

treatment_percentage

float

The percentage of the total population who will see ads

Edges

EdgeDescription

adaccounts

Ad accounts

Default

adsets

Adsets

Default

campaigns

Campaigns

Default

Validation Rules

ErrorDescription
100Invalid parameter

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.