Method: users.history.list

Listet den Verlauf aller Änderungen am jeweiligen Postfach auf. Verlaufsergebnisse werden in chronologischer Reihenfolge zurückgegeben (mit zunehmendem 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.

Abfrageparameter

Parameter
maxResults

integer (uint32 format)

Maximale Anzahl der Verlaufseinträge, die zurückgegeben werden sollen. 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. Die bereitgestellte startHistoryId sollte aus dem historyId einer Nachricht, eines Threads oder einer vorherigen list-Antwort abgerufen werden. Verlaufs-IDs nehmen chronologisch zu, sind aber nicht fortlaufend mit Zufallslücken zwischen gültigen IDs verbunden. Die Angabe eines ungültigen oder veralteten startHistoryId gibt in der Regel einen HTTP 404-Fehlercode zurück. Ein historyId ist normalerweise mindestens eine Woche lang gültig, kann in seltenen Fällen aber auch nur einige 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, müssen keine Aktualisierungen abgerufen werden und Sie können die zurückgegebene historyId für eine zukünftige Anfrage speichern.

labelId

string

Es werden nur Nachrichten zurückgegeben, deren Label mit der ID übereinstimmt.

historyTypes[]

enum (HistoryType)

Von der Funktion zurückzugebende Verlaufstypen

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 messages in der Antwort sind in der Regel nur die Felder id und threadId ausgefüllt.

nextPageToken

string

Seitentoken zum Abrufen der nächsten Seite der Ergebnisse 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 Postfach des Nutzers. Jede Verlaufsänderung kann mehrere Nachrichten auf unterschiedliche Weise betreffen.

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

string

Die Sequenz-ID des Postfachs.

messages[]

object (Message)

Liste der in diesem Verlauf geänderten Nachrichten. In den Feldern für bestimmte Änderungsarten, z. B. messagesAdded, werden möglicherweise Nachrichten in diesem Feld dupliziert. Wir empfehlen, stattdessen die spezifischen Felder für die Änderungsart zu verwenden.

messagesAdded[]

object (MessageAdded)

Nachrichten, die dem Postfach in diesem Verlaufseintrag hinzugefügt wurden.

messagesDeleted[]

object (MessageDeleted)

Nachrichten, die aus dem Postfach dieses Verlaufseintrags gelöscht, aber nicht in den Papierkorb verschoben wurden.

labelsAdded[]

object (LabelAdded)

Labels, die Nachrichten in diesem Verlaufseintrag hinzugefügt wurden.

labelsRemoved[]

object (LabelRemoved)

Labels von Nachrichten in diesem Verlaufseintrag 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.