Method: users.watch

Richte eine Smartwatch für Push-Benachrichtigungen im jeweiligen Postfach des Nutzers ein oder aktualisiere sie.

HTTP-Anfrage

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

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.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Felder
labelIds[]

string

Liste der labelIds, zu denen Benachrichtigungen eingeschränkt werden sollen. Wenn nicht angegeben, werden standardmäßig alle Änderungen übertragen. Wenn angegeben, wird festgelegt, welche Labels zum Generieren einer Push-Benachrichtigung erforderlich sind.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Filterverhalten für labelIds list angegeben. Dieses Feld wurde eingestellt, da es in einigen Fällen zu einem falschen Verhalten geführt hat. Verwenden Sie stattdessen labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Filterverhalten für labelIds list angegeben. Dieses Feld ersetzt labelFilterAction. Wenn festgelegt, wird labelFilterAction ignoriert.
topicName

string

Ein voll qualifizierter Google Cloud Pub/Sub API-Themenname, in dem die Ereignisse veröffentlicht werden sollen. Dieser Themenname muss bereits in Cloud Pub/Sub vorhanden sein und Sie müssen Gmail bereits die Veröffentlichungsberechtigung dafür erteilt haben. Beispiel: „projects/my-project-identifier/topics/my-topic-name“ (unter Verwendung des Namensformats für das Cloud Pub/Sub-Thema „v1“).

Der Teil „my-project-identifier“ muss genau mit der ID des Google-Entwicklerprojekts übereinstimmen, das diese Überwachungsanfrage ausführt.

Antworttext

Smartwatch-Antwort für Push-Benachrichtigungen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "historyId": string,
  "expiration": string
}
Felder
historyId

string

Die ID des aktuellen Verlaufseintrags des Postfachs.
expiration

string (int64 format)

Wann Gmail keine Benachrichtigungen mehr über Postfach-Updates sendet (Epoche (Millis)) Rufe watch vor diesem Zeitpunkt noch einmal an, um die Smartwatch zu verlängern.

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.

LabelFilterAction

Filterverhalten der labelIds-Liste angegeben.

Enums
include Sie erhalten nur Push-Benachrichtigungen für Nachrichtenänderungen, die sich auf die angegebenen labelIds beziehen.
exclude Hiermit erhalten Sie Push-Benachrichtigungen für alle Änderungen von Nachrichten, mit Ausnahme derer, die sich auf die angegebenen labelIds beziehen.