Versione API Graph

Business Adnetworkanalytics

Lettura

Audience Network Insights for this publisher entity

Esempio

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
}];
Se desideri scoprire come usare l'API Graph, leggi la nostra Guida per l'utilizzo dell'API Graph.

Parametri

ParametroDescrizione
aggregation_period
enum {DAY, TOTAL}
Valore predefinito: "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}>
Valore predefinito: []

Optional breakdowns for results

filters
array<JSON object>
Valore predefinito: []

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

Obbligatorio
operator
enum {IN, NOT_IN}

operator

Obbligatorio
values
array<string>

values

Obbligatorio
limit
int64
Valore predefinito: 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

Obbligatorio
ordering_column
enum {TIME, VALUE, METRIC}
Valore predefinito: "TIME"

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

ordering_type
enum {ASCENDING, DESCENDING}
Valore predefinito: "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

Campi

La lettura da questo segmento fornirà un risultato formattato JSON:

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

data

Una lista di nodi AdNetworkAnalyticsSyncQueryResult.

paging

Per ulteriori dettagli sulla paginazione, consulta la Guida su API Graph.

Error Codes

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

Creazione

You can make a POST request to adnetworkanalytics edge from the following paths:
When posting to this edge, an AnalyticsQueryResult will be created.

Parametri

ParametroDescrizione
aggregation_period
enum {DAY, TOTAL}
Valore predefinito: 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}>
Valore predefinito: Vec

Optional breakdowns for results

filters
list<Object>
Valore predefinito: 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.

Obbligatorio
operator
enum {IN, NOT_IN}

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

Obbligatorio
values
list<string>
Valore predefinito: 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
Valore predefinito: 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

Obbligatorio
ordering_column
enum {TIME, VALUE, METRIC}
Valore predefinito: TIME

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

ordering_type
enum {ASCENDING, DESCENDING}
Valore predefinito: 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

Tipo di ricavo

Questo endopoint supporta read-after-write e leggerà il nodo in cui hai effettuato una richiesta POST.
Struct {
query_id: string,
async_result_link: string,
}

Error Codes

ErroreDescrizione
200Permissions error
3000Reading insights of a Page, business, app, domain or event source group not owned by the querying user or application
190Invalid OAuth 2.0 Access Token
368The action attempted has been deemed abusive or is otherwise disallowed

Aggiornamento

Non puoi eseguire questa operazione in questo endpoint.

Eliminazione

Non puoi eseguire questa operazione in questo endpoint.