グラフAPIバージョン

Business Adnetworkanalytics

読み取り

Audience Network Insights for this publisher entity

Graph API Explorer
GET /v21.0/{business-id}/adnetworkanalytics 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}/adnetworkanalytics',
    '{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}/adnetworkanalytics",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-id}/adnetworkanalytics",
    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}/adnetworkanalytics"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
グラフAPIを使用する方法については、グラフAPIの使用ガイドをご覧ください。

パラメーター

パラメーター説明
aggregation_period
enum {DAY, TOTAL}
デフォルト値: "DAY"

The interval to aggregate by

breakdowns
array<enum {AGE, APP, COUNTRY, DELIVERY_METHOD, DISPLAY_FORMAT, DEAL, DEAL_AD, DEAL_PAGE, GENDER, PLACEMENT, PLACEMENT_NAME, AD_SPACE, PLATFORM, PROPERTY, CLICKED_VIEW_TAG, FAIL_REASON, SDK_VERSION, INSTANT_ARTICLE_PAGE_ID, INSTANT_ARTICLE_ID, AD_SERVER_CAMPAIGN_ID, IS_DEAL_BACKFILL}>
デフォルト値: []

Optional breakdowns for results

filters
array<JSON object>
デフォルト値: []

Additional filters for the query

field
enum {AGE, APP, COUNTRY, DELIVERY_METHOD, DISPLAY_FORMAT, DEAL, DEAL_AD, DEAL_PAGE, GENDER, PLACEMENT, PLACEMENT_NAME, AD_SPACE, PLATFORM, PROPERTY, CLICKED_VIEW_TAG, FAIL_REASON, SDK_VERSION, INSTANT_ARTICLE_PAGE_ID, INSTANT_ARTICLE_ID, AD_SERVER_CAMPAIGN_ID, IS_DEAL_BACKFILL}

field

必須
operator
enum {IN, NOT_IN}

operator

必須
values
array<string>

values

必須
limit
int64
デフォルト値: 2000

Limit the number of rows returned

metrics
array<enum {FB_AD_NETWORK_BIDDING_REQUEST, FB_AD_NETWORK_BIDDING_RESPONSE, FB_AD_NETWORK_BIDDING_BID_RATE, FB_AD_NETWORK_BIDDING_WIN_RATE, FB_AD_NETWORK_REQUEST, FB_AD_NETWORK_FILLED_REQUEST, FB_AD_NETWORK_FILL_RATE, FB_AD_NETWORK_IMP, FB_AD_NETWORK_IMPRESSION_RATE, FB_AD_NETWORK_CLICK, FB_AD_NETWORK_CTR, FB_AD_NETWORK_BIDDING_REVENUE, FB_AD_NETWORK_REVENUE, FB_AD_NETWORK_CPM, FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE, FB_AD_NETWORK_VIDEO_VIEW, FB_AD_NETWORK_VIDEO_VIEW_RATE, FB_AD_NETWORK_VIDEO_MRC, FB_AD_NETWORK_VIDEO_MRC_RATE, FB_AD_NETWORK_SHOW_RATE}>

List of metrics to query for

必須
ordering_column
enum {TIME, VALUE, METRIC}
デフォルト値: "TIME"

Order results by value (result of the aggregation) or by time.

ordering_type
enum {ASCENDING, DESCENDING}
デフォルト値: "DESCENDING"

Ascending or descending

should_include_until
boolean

should_include_until

since
datetime/timestamp

A unix timestamp or strtotime data value that indicates the start of the data range

until
datetime/timestamp

A unix timestamp or strtotime data value that indicates the end of the data range

項目

このエッジからの読み込むではJSONフォーマットの結果が返されます:

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

data

AdNetworkAnalyticsSyncQueryResultノードの一覧です。

paging

ページネ―ションについて詳しくは、グラフAPIガイドをご覧ください。

エラーコード

エラー詳細
200Permissions error
100Invalid parameter
3000Reading insights of a Page, business, app, domain or event source group not owned by the querying user or application
368The action attempted has been deemed abusive or is otherwise disallowed
104Incorrect signature
190Invalid OAuth 2.0 Access Token
613Calls to this api have exceeded the rate limit.

作成

adnetworkanalyticsのエッジにPOSTリクエストを以下のパスで送信できます:
このエッジにPOSTする場合、an AnalyticsQueryResultが作成されます。

パラメーター

パラメーター説明
aggregation_period
enum {DAY, TOTAL}
デフォルト値: DAY

The interval to aggregate by

breakdowns
list<enum {AGE, APP, COUNTRY, DELIVERY_METHOD, DISPLAY_FORMAT, DEAL, DEAL_AD, DEAL_PAGE, GENDER, PLACEMENT, PLACEMENT_NAME, AD_SPACE, PLATFORM, PROPERTY, CLICKED_VIEW_TAG, FAIL_REASON, SDK_VERSION, INSTANT_ARTICLE_PAGE_ID, INSTANT_ARTICLE_ID, AD_SERVER_CAMPAIGN_ID, IS_DEAL_BACKFILL}>
デフォルト値: Vec

Optional breakdowns for results

filters
list<Object>
デフォルト値: Vec

Additional filters for the query

field
enum {AGE, APP, COUNTRY, DELIVERY_METHOD, DISPLAY_FORMAT, DEAL, DEAL_AD, DEAL_PAGE, GENDER, PLACEMENT, PLACEMENT_NAME, AD_SPACE, PLATFORM, PROPERTY, CLICKED_VIEW_TAG, FAIL_REASON, SDK_VERSION, INSTANT_ARTICLE_PAGE_ID, INSTANT_ARTICLE_ID, AD_SERVER_CAMPAIGN_ID, IS_DEAL_BACKFILL}

Field on which filter is applied. Currently, only valid breakdowns are supported in filters. eg. Country, OS, etc.

必須
operator
enum {IN, NOT_IN}

The intended operation between field and values. eg. IN, etc.

必須
values
list<string>
デフォルト値: Vec

Values of corresponding field which must be filtered in result subject to the operator. The results join the different field valuesdisjunctively. eg. For Filters = {"Country", "IN", ["US", UK]} translates to {"Country", "IN", "US"} OR {"Country", "IN", "UK"}

limit
integer
デフォルト値: 20000

Limit the number of rows returned

metrics
list<enum {FB_AD_NETWORK_BIDDING_REQUEST, FB_AD_NETWORK_BIDDING_RESPONSE, FB_AD_NETWORK_BIDDING_BID_RATE, FB_AD_NETWORK_BIDDING_WIN_RATE, FB_AD_NETWORK_REQUEST, FB_AD_NETWORK_FILLED_REQUEST, FB_AD_NETWORK_FILL_RATE, FB_AD_NETWORK_IMP, FB_AD_NETWORK_IMPRESSION_RATE, FB_AD_NETWORK_CLICK, FB_AD_NETWORK_CTR, FB_AD_NETWORK_BIDDING_REVENUE, FB_AD_NETWORK_REVENUE, FB_AD_NETWORK_CPM, FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE, FB_AD_NETWORK_VIDEO_VIEW, FB_AD_NETWORK_VIDEO_VIEW_RATE, FB_AD_NETWORK_VIDEO_MRC, FB_AD_NETWORK_VIDEO_MRC_RATE, FB_AD_NETWORK_SHOW_RATE}>

Metrics to return

必須
ordering_column
enum {TIME, VALUE, METRIC}
デフォルト値: TIME

Order results by value (result of the aggregation) or by time.

ordering_type
enum {ASCENDING, DESCENDING}
デフォルト値: DESCENDING

Ascending or descending

since
datetime/timestamp

A unix timestamp or strtotime data value that indicates the start of the data range

until
datetime/timestamp

A unix timestamp or strtotime data value that indicates the end of the data range

戻り値の型

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
query_id: string,
async_result_link: string,
}

エラーコード

エラー詳細
200Permissions error
3000Reading insights of a Page, business, app, domain or event source group not owned by the querying user or application
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed

更新中…

このエンドポイントではこの操作を実行できません。

削除中です

このエンドポイントではこの操作を実行できません。