UserAdStudies
GET /v21.0/{user-id}/ad_studies 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(
'/{user-id}/ad_studies',
'{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(
"/{user-id}/ad_studies",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{user-id}/ad_studies",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/{user-id}/ad_studies"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Reading from this edge will return a JSON formatted result:
{ "
data
": [], "paging
": {}, "summary
": {} }
data
paging
summary
Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=total_count
).
Field | Description |
---|---|
total_count unsigned int32 | Total number of lift studies for this person |
Error | Description |
---|---|
100 | Invalid parameter |
ad_studies
edge from the following paths: Parameter | Description |
---|---|
cells list<Object> | A shape to describe the cells of the study |
client_business numeric string or integer | Business associated with study |
confidence_level float | Confidence level used in power calculation and final report |
cooldown_start_time integer | The beginning of the pre measurement cooldown period. This period ends when the study period starts. |
description string | A brief description about the purpose of the study. |
end_time integer | The time when the study period ends. |
name string | The name of the study. |
objectives list<Object> | A vector of objects describing the objectives assigned to this study |
observation_end_time integer | The end of the observation period for this study, this period starts when the study period ends. |
start_time integer | The time when the study period starts. |
type enum {LIFT, SPLIT_TEST, CONTINUOUS_LIFT_CONFIG, GEO_LIFT, BACKEND_AB_TESTING} | The type of ad study, either SPLIT_TEST or LIFT. |
viewers list<int> | The list of people who this study has been shared with. |
id
in the return type.id
: numeric string, cell_ids
: List [objective_ids
: List [Error | Description |
---|---|
200 | Permissions error |
100 | Invalid parameter |