Method: users.history.list

Listet den Verlauf aller Änderungen am angegebenen Postfach auf. Verlaufsergebnisse werden in chronologischer Reihenfolge zurückgegeben (aufsteigende historyId).

HTTP-Anfrage

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userId

string

Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert me kann der authentifizierte Nutzer angegeben werden.

Suchparameter

Parameter
maxResults

integer (uint32 format)

Maximale Anzahl der zurückzugebenden Verlaufsdatensätze. Der Standardwert in diesem Feld ist „100“. Der maximal zulässige Wert für dieses Feld beträgt 500.
pageToken

string

Seitentoken zum Abrufen einer bestimmten Ergebnisseite in der Liste.
startHistoryId

string

Erforderlich. Gibt Verlaufsdatensätze nach dem angegebenen startHistoryId zurück. Die angegebene startHistoryId sollte aus der historyId einer Nachricht, eines Threads oder einer vorherigen list-Antwort stammen. Verlaufs-IDs werden chronologisch erhöht, sind aber nicht fortlaufend, da zwischen gültigen IDs zufällige Lücken auftreten. Wenn Sie ein ungültiges oder abgelaufenes startHistoryId angeben, wird in der Regel der Fehlercode HTTP 404 zurückgegeben. Ein historyId ist in der Regel mindestens eine Woche lang gültig, in seltenen Fällen aber auch nur wenige Stunden. Wenn Sie eine HTTP 404-Fehlerantwort erhalten, sollte Ihre Anwendung eine vollständige Synchronisierung durchführen. Wenn Sie in der Antwort kein nextPageToken erhalten, gibt es keine abzurufenden Updates. Sie können das zurückgegebene historyId für eine zukünftige Anfrage speichern.
labelId

string

Gibt nur Nachrichten mit einem Label zurück, das der ID entspricht.
historyTypes[]

enum (HistoryType)

Verlaufstypen, die von der Funktion zurückgegeben werden sollen

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Felder
history[]

object (History)

Liste der Verlaufsdatensätze. Bei allen messages in der Antwort sind in der Regel nur die Felder id und threadId ausgefüllt.
nextPageToken

string

Seitentoken zum Abrufen der nächsten Ergebnisseite in der Liste.
historyId

string

Die ID des aktuellen Verlaufsdatensatzes des Postfachs.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

HistoryType

Enums
messageAdded
messageDeleted
labelAdded
labelRemoved

Verlauf

Ein Datensatz mit einer Änderung am Postfach des Nutzers. Jede Änderung im Verlauf kann sich auf mehrere Nachrichten auf unterschiedliche Weise auswirken.

JSON-Darstellung 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Felder
id

string

Die ID der Postfachsequenz.
messages[]

object (Message)

Liste der Nachrichten, die in diesem Verlaufsdatensatz geändert wurden. Die Felder für bestimmte Änderungstypen, z. B. messagesAdded, können Nachrichten in diesem Feld duplizieren. Wir empfehlen, stattdessen die spezifischen Felder für den Änderungstyp zu verwenden.
messagesAdded[]

object (MessageAdded)

Nachrichten, die dem Postfach in diesem Verlaufsdatensatz hinzugefügt wurden.
messagesDeleted[]

object (MessageDeleted)

Nachrichten, die in diesem Verlaufseintrag aus dem Postfach gelöscht (nicht in den Papierkorb verschoben) wurden.
labelsAdded[]

object (LabelAdded)

Labels, die Nachrichten in diesem Verlaufsdatensatz hinzugefügt wurden.
labelsRemoved[]

object (LabelRemoved)

Labels, die aus Nachrichten in diesem Verlaufsdatensatz entfernt wurden.

MessageAdded

JSON-Darstellung 
{
  "message": {
    object (Message)
  }
}
Felder
message

object (Message)

MessageDeleted

JSON-Darstellung 
{
  "message": {
    object (Message)
  }
}
Felder
message

object (Message)

LabelAdded

JSON-Darstellung 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Felder
message

object (Message)
labelIds[]

string

Label-IDs, die der Nachricht hinzugefügt wurden.

LabelRemoved

JSON-Darstellung 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Felder
message

object (Message)
labelIds[]

string

Aus der Nachricht entfernte Label-IDs.