Method: users.history.list

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

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. Der spezielle Wert me kann verwendet werden, um den authentifizierten Nutzer anzugeben.

Abfrageparameter

Parameter
maxResults

integer (uint32 format)

Die maximale Anzahl der zurückzugebenden Verlaufseinträge. Der Standardwert für dieses 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 Verlaufseinträge nach dem angegebenen startHistoryId zurück. Die angegebene startHistoryId sollte aus dem historyId einer Nachricht, eines Threads oder einer vorherigen list-Antwort stammen. Verlaufs-IDs steigen chronologisch an, sind aber nicht fortlaufend und weisen zufällige Lücken zwischen gültigen IDs auf. Wenn Sie eine ungültige oder veraltete startHistoryId angeben, wird in der Regel der Fehlercode HTTP 404 zurückgegeben. Ein historyId ist in der Regel mindestens eine Woche lang gültig, kann aber in seltenen Fällen auch nur wenige Stunden lang gültig sein. Wenn Sie eine HTTP 404-Fehlerantwort erhalten, sollte Ihre Anwendung eine vollständige Synchronisierung ausführen. Wenn in der Antwort keine nextPageToken enthalten ist, gibt es keine Updates zum Abrufen und Sie können die zurückgegebene historyId für eine zukünftige Anfrage speichern.
labelId

string

Es werden nur Nachrichten mit einem Label zurückgegeben, das mit der ID übereinstimmt.
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 Verlaufseinträge. Bei allen messages-Elementen 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 im Leitfaden zur Autorisierung.

HistoryType

Enums
messageAdded
messageDeleted
labelAdded
labelRemoved

Verlauf

Ein Eintrag zu einer Änderung am Postfach des Nutzers. Jede Änderung am 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 Mailboxsequenz-ID.
messages[]

object (Message)

Liste der Nachrichten, die in diesem Verlaufsdatensatz geändert wurden. In den Feldern für bestimmte Änderungstypen wie messagesAdded können Nachrichten in diesem Feld dupliziert werden. Wir empfehlen stattdessen die Verwendung der entsprechenden Felder für den Änderungstyp.
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 Verlaufseintrag hinzugefügt wurden.
labelsRemoved[]

object (LabelRemoved)

Labels, die aus Nachrichten in diesem Verlaufselement 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

Label-IDs wurden aus der Nachricht entfernt.