Method: users.history.list

Listet den Verlauf aller Änderungen im angegebenen Postfach auf. Verlaufsergebnisse werden in chronologischer Reihenfolge zurückgegeben, wobei historyId erhöht wird.

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.

Abfrageparameter

Parameter
maxResults

integer (uint32 format)

Maximale Anzahl der zurückzugebenden Verlaufseinträge. Der Standardwert für dieses Feld ist 100. Der maximal zulässige Wert für dieses Feld ist 500.
pageToken

string

Seitentoken zum Abrufen einer bestimmten Ergebnisseite in der Liste.
startHistoryId

string

Erforderlich. Gibt Verlaufseinträge nach dem angegebenen startHistoryId zurück. Das angegebene startHistoryId sollte aus dem historyId einer Nachricht, eines Threads oder einer vorherigen list-Antwort abgerufen werden. Verlaufs-IDs erhöhen sich chronologisch, sind aber nicht mit zufälligen Lücken zwischen gültigen IDs zusammenhängen. Bei Angabe eines ungültigen oder veralteten startHistoryId wird in der Regel der Fehlercode HTTP 404 zurückgegeben. Eine historyId ist in der Regel mindestens eine Woche gültig, kann in seltenen Fällen aber auch nur wenige Stunden gültig sein. Wenn Sie den Fehler HTTP 404 erhalten, sollte Ihre Anwendung eine vollständige Synchronisierung durchführen. Wenn Sie kein nextPageToken in der Antwort erhalten, gibt es keine Aktualisierungen, die abgerufen werden müssen. 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. Für alle messages in der Antwort sind normalerweise 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 Verlaufseintrags 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

Datensatz einer Änderung am Posteingang des Nutzers Jede Verlaufsänderung 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 Postfachsequenz-ID.
messages[]

object (Message)

Liste der in diesem Verlaufsdatensatz geänderten Nachrichten. Die Felder für bestimmte Änderungsarten wie messagesAdded können Nachrichten in diesem Feld duplizieren. Wir empfehlen, stattdessen die spezifischen Änderungstyp-Felder zu verwenden.
messagesAdded[]

object (MessageAdded)

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

object (MessageDeleted)

Nachrichten wurden aus dem Postfach in diesem Verlaufsdatensatz (nicht im Papierkorb) gelöscht.
labelsAdded[]

object (LabelAdded)

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

object (LabelRemoved)

Labels wurden aus den Nachrichten in diesem Verlauf entfernt.

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.