Method: domainStats.batchQuery

Führt einen Batch von QueryDomainStats-Anfragen für mehrere Domains aus. Gibt PERMISSION_DENIED zurück, wenn Sie für keine der angeforderten Domains auf DomainStats zugreifen dürfen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Felder
requests[]

object (QueryDomainStatsRequest)

Erforderlich. Eine Liste der einzelnen Abfrageanfragen. Jede Anfrage kann sich auf eine andere Domain beziehen. Ein einzelner Batch kann maximal 100 Anfragen enthalten.

Antworttext

Antwortnachricht für domainStats.batchQuery.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Felder
results[]

object (BatchQueryDomainStatsResult)

Eine Liste von Antworten, eine für jede Anfrage in BatchQueryDomainStatsRequest. Die Reihenfolge der Antworten entspricht der Reihenfolge der Anfragen.

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.

QueryDomainStatsRequest

Anfragenachricht für QueryDomainStats

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

string

Erforderlich. Der Name der übergeordneten Ressource, für die die Statistiken abgefragt werden. Format: domains/{domain}
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.

BatchQueryDomainStatsResult

Stellt das Ergebnis einer einzelnen QueryDomainStatsRequest in einem Batch dar.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld result. Das Ergebnis der einzelnen Abfrage. Für result ist nur einer der folgenden Werte zulässig:
response

object (QueryDomainStatsResponse)

Die erfolgreiche Antwort für die einzelne Anfrage.
error

object (Status)

Der Fehlerstatus, wenn die einzelne Abfrage fehlgeschlagen ist.

Status

Mit dem Typ Status wird ein logisches Fehlermodell definiert, das für verschiedene Programmierumgebungen wie REST APIs und RPC APIs geeignet ist. Dieses Modell wird von gRPC verwendet. Jede Status-Meldung enthält die folgenden drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.

Weitere Informationen zu diesem Fehlermodell und zur Arbeit damit finden Sie in der API-Designanleitung.

JSON-Darstellung 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.
message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede für Nutzer sichtbare Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.
details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen allgemeinen Satz von Nachrichtentypen, die von APIs verwendet werden können.