Method: domains.domainStats.query

Recupera un elenco di statistiche del dominio per un determinato dominio e periodo di tempo. Restituisce PERMISSION_DENIED se non hai l'autorizzazione per accedere a DomainStats per il dominio.

Richiesta HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

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

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Campi
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.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di QueryDomainStatsResponse.

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.