- HTTP-Anfrage
- Pfadparameter
- Anfrageparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- HistoryType
- Verlauf
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- Testen!
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 |
Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert |
Abfrageparameter
Parameter | |
---|---|
maxResults |
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 |
Seitentoken zum Abrufen einer bestimmten Ergebnisseite in der Liste. |
startHistoryId |
Erforderlich. Gibt Verlaufseinträge nach dem angegebenen |
labelId |
Es werden nur Nachrichten zurückgegeben, deren Label mit der ID übereinstimmt. |
historyTypes[] |
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 ( |
Felder | |
---|---|
history[] |
Liste der Verlaufseinträge. Für |
nextPageToken |
Seitentoken zum Abrufen der nächsten Seite der Ergebnisse in der Liste. |
historyId |
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 ( |
Felder | |
---|---|
id |
Die Sequenz-ID des Postfachs. |
messages[] |
Liste der in diesem Verlauf geänderten Nachrichten. In den Feldern für bestimmte Änderungsarten, z. B. |
messagesAdded[] |
Nachrichten, die dem Postfach in diesem Verlaufseintrag hinzugefügt wurden. |
messagesDeleted[] |
Nachrichten, die aus dem Postfach dieses Verlaufseintrags gelöscht, aber nicht in den Papierkorb verschoben wurden. |
labelsAdded[] |
Labels, die Nachrichten in diesem Verlaufseintrag hinzugefügt wurden. |
labelsRemoved[] |
Labels von Nachrichten in diesem Verlaufseintrag entfernt. |
MessageAdded
JSON-Darstellung |
---|
{
"message": {
object ( |
Felder | |
---|---|
message |
|
MessageDeleted
JSON-Darstellung |
---|
{
"message": {
object ( |
Felder | |
---|---|
message |
|
LabelAdded
JSON-Darstellung |
---|
{
"message": {
object ( |
Felder | |
---|---|
message |
|
labelIds[] |
Label-IDs, die der Nachricht hinzugefügt wurden. |
LabelRemoved
JSON-Darstellung |
---|
{
"message": {
object ( |
Felder | |
---|---|
message |
|
labelIds[] |
Label-IDs wurden aus der Nachricht entfernt. |