Method: domains.domainStats.query

Ruft eine Liste von Domainstatistiken für eine bestimmte Domain und einen bestimmten Zeitraum ab. Gibt PERMISSION_DENIED zurück, wenn Sie keine Berechtigung für den Zugriff auf DomainStats für die Domain haben.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Ressource, für die die Statistiken abgefragt werden. Format: domains/{domain}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Felder
metricDefinitions[]

object (MetricDefinition)

Erforderlich. Die spezifischen Messwerte, die abgefragt werden sollen. Sie können für jeden Messwert einen benutzerdefinierten Namen definieren, der in der Antwort verwendet wird.
timeQuery

object (TimeQuery)

Erforderlich. Der Zeitraum oder die spezifischen Daten, für die die Messwerte abgerufen werden sollen.
pageSize

integer

Optional. Die maximale Anzahl von DomainStats-Ressourcen, die in der Antwort zurückgegeben werden sollen. Der Server gibt möglicherweise weniger als diesen Wert zurück. Wenn nichts angegeben ist, wird der Standardwert 10 verwendet. Der Höchstwert ist 200.
pageToken

string

Optional. Der Wert "nextPageToken" wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. Wenn der Aggregationsdetaillierungsgrad DAILY ist, ist das Seitentoken das codierte Datum + „/“ + Messwertname. Wenn der Aggregationsdetaillierungsgrad OVERALL ist, ist das Seitentoken der codierte Messwertname.
aggregationGranularity

enum (AggregationGranularity)

Optional. Der Detaillierungsgrad, auf dem die Statistiken aggregiert werden sollen. Wenn nicht angegeben, wird standardmäßig DAILY verwendet.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von QueryDomainStatsResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.