Method: domains.trafficStats.list

Listet Traffic-Statistiken für alle verfügbaren Tage auf. Gibt PERMISSION_DENIED zurück, wenn der Nutzer nicht berechtigt ist, auf TrafficStats für die Domain zuzugreifen.

HTTP-Anfrage

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Der Ressourcenname der Domain, deren Traffic-Statistiken Sie auflisten möchten. Er sollte das Format domains/{domain_name} haben, wobei „domain_name“ der vollständig qualifizierte Domainname ist.

Abfrageparameter

Parameter
startDate

object (Date)

Der früheste Tag der abzurufenden Messwerte. „startDate“ und „endDate“ müssen entweder beide angegeben oder beide nicht angegeben werden. Wenn nur ein Wert angegeben ist oder „endDate“ vor dem „startDate“ liegt, wird INVALID_ARGUMENT zurückgegeben.

endDate

object (Date)

Der letzte Tag der Messwerte, die exklusiv abgerufen werden sollen. „startDate“ und „endDate“ müssen entweder angegeben oder beide nicht angegeben werden. Wenn nur ein Wert angegeben ist oder „endDate“ vor dem „startDate“ liegt, wird INVALID_ARGUMENT zurückgegeben.

pageSize

integer

Angeforderte Seitengröße. Der Server gibt möglicherweise weniger TrafficStats als angefordert zurück. Wenn kein Wert angegeben ist, wählt der Server einen geeigneten Standardwert aus.

pageToken

string

Der Wert "nextPageToken" wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. Dies ist der Wert von ListTrafficStatsResponse.next_page_token, der vom vorherigen Aufruf der Methode trafficStats.list zurückgegeben wurde.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für trafficStats.list.

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

JSON-Darstellung
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
Felder
trafficStats[]

object (TrafficStats)

Die Liste der TrafficStats.

nextPageToken

string

Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Datum

Stellt ein ganzes Kalenderdatum oder einen Teil davon dar, z. B. einen Geburtstag. Tageszeit und Zeitzone werden entweder an anderer Stelle angegeben oder sind unbedeutend. Das Datum bezieht sich auf den gregorianischen Kalender. Dies kann Folgendes darstellen:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag ungleich null.
  • Ein Monat und ein Tag mit einem Jahr von 0 (z. B. ein Jahrestag).
  • Ein Jahr für sich alleine, mit einem Monat und einem Tag von null.
  • Ein Jahr und ein Monat mit 0 Tag (z. B. dem Ablaufdatum einer Kreditkarte).

Ähnliche Typen:

JSON-Darstellung
{
  "year": integer,
  "month": integer,
  "day": integer
}
Felder
year

integer

Jahr des Datums. Muss zwischen 1 und 9999 liegen oder 0, um ein Datum ohne Jahr anzugeben.

month

integer

Monat eines Jahres. Muss zwischen 1 und 12 liegen oder 0, um ein Jahr ohne Monat und Tag anzugeben.

day

integer

Tag im Monat. Muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein, oder 0, um ein Jahr allein oder ein Jahr und Monat anzugeben, wenn der Tag nicht von Bedeutung ist.