This business owns these ads-related studies. Includes lift studies, split tests and so on.
GET /v19.0/{business-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(
'/{business-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(
"/{business-id}/ad_studies",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{business-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:@"/{business-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
": {} }
data
paging
Error | Description |
---|---|
200 | Permissions error |
100 | Invalid parameter |
270 | This Ads API request is not allowed for apps with development access level (Development access is by default for all apps, please request for upgrade). Make sure that the access token belongs to a user that is both admin of the app and admin of the ad account |
ad_studies
edge from the following paths: Parameter | Description |
---|---|
cells list<Object> | Describes the cells in the study. Required |
client_business numeric string or integer | Business associated with the study. |
confidence_level float | Confidence level used in power calculations and final study report. |
cooldown_start_time integer | Start of the pre-measurement cool-down period. This period ends when the study period starts. |
description string | The purpose of the study. |
end_time integer | Time when the study period ends. Required |
name string | Name of the study. Required |
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. Required |
type enum {LIFT, SPLIT_TEST, CONTINUOUS_LIFT_CONFIG, GEO_LIFT} | The type of ad study, such as |
viewers list<int> | This study is shared with these people. |
id
in the return type.id
: numeric string, Error | Description |
---|---|
100 | Invalid parameter |
200 | Permissions error |