Method: domainStats.batchQuery

Esegue un batch di richieste QueryDomainStats per più domini. Restituisce PERMISSION_DENIED se non hai l'autorizzazione per accedere a DomainStats per uno dei domini richiesti.

Richiesta HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/domainStats:batchQuery

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Campi
requests[]

object (QueryDomainStatsRequest)

Obbligatorio. Un elenco di richieste di query individuali. Ogni richiesta può riguardare un dominio diverso. In un singolo batch possono essere incluse al massimo 100 richieste.

Corpo della risposta

Messaggio di risposta per domainStats.batchQuery.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Campi
results[]

object (BatchQueryDomainStatsResult)

Un elenco di risposte, una per ogni query in BatchQueryDomainStatsRequest. L'ordine delle risposte corrisponderà all'ordine delle richieste.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

QueryDomainStatsRequest

Messaggio di richiesta per QueryDomainStats.

Rappresentazione JSON 
{
  "parent": string,
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Campi
parent

string

Obbligatorio. Il nome della risorsa padre in cui vengono eseguite le query sulle statistiche. Formato: domains/{domain}
metricDefinitions[]

object (MetricDefinition)

Obbligatorio. Le metriche specifiche da interrogare. Puoi definire un nome personalizzato per ogni metrica, che verrà utilizzato nella risposta.
timeQuery

object (TimeQuery)

Obbligatorio. L'intervallo di tempo o le date specifiche per cui recuperare le metriche.
pageSize

integer

Facoltativo. Il numero massimo di risorse DomainStats da restituire nella risposta. Il server potrebbe restituire un numero inferiore a questo valore. Se non specificato, verrà utilizzato un valore predefinito di 10. Il valore massimo è 200.
pageToken

string

Facoltativo. Il valore nextPageToken restituito da una precedente richiesta List, se presente. Se la granularità dell'aggregazione è GIORNALIERA, il token di pagina sarà la data codificata + "/" + il nome della metrica. Se la granularità dell'aggregazione è OVERALL, il token di pagina sarà il nome della metrica codificato.
aggregationGranularity

enum (AggregationGranularity)

Facoltativo. La granularità con cui aggregare le statistiche. Se non specificato, il valore predefinito è DAILY.

BatchQueryDomainStatsResult

Rappresenta il risultato di una singola QueryDomainStatsRequest all'interno di un batch.

Rappresentazione JSON 
{

  // Union field result can be only one of the following:
  "response": {
    object (QueryDomainStatsResponse)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Campi
Campo unione result. Il risultato della singola query. result può essere solo uno dei seguenti valori:
response

object (QueryDomainStatsResponse)

La risposta positiva per la singola query.
error

object (Status)

Lo stato di errore se la singola query non è riuscita.

Stato

Il tipo Status definisce un modello di errore logico adatto a diversi ambienti di programmazione, tra cui API REST e API RPC. Viene utilizzato da gRPC. Ogni messaggio Status contiene tre elementi di dati: codice di errore, messaggio di errore e dettagli dell'errore.

Puoi scoprire di più su questo modello di errore e su come utilizzarlo nella guida alla progettazione delle API.

Rappresentazione JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campi
code

integer

Il codice di stato, che deve essere un valore enum di google.rpc.Code.
message

string

Un messaggio di errore rivolto agli sviluppatori, che deve essere in inglese. Qualsiasi messaggio di errore rivolto all'utente deve essere localizzato e inviato nel campo google.rpc.Status.details o localizzato dal client.
details[]

object

Un elenco di messaggi che contengono i dettagli dell'errore. Esiste un insieme comune di tipi di messaggi da utilizzare per le API.