Method: users.watch

Richtet eine Push-Benachrichtigungs-Watch für das angegebene Nutzerpostfach ein oder aktualisiert 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, für die Benachrichtigungen eingeschränkt werden sollen. Standardmäßig werden alle Änderungen übertragen, sofern nichts anderes angegeben ist. Wenn angegeben, wird festgelegt, welche Labels für die Generierung einer Push-Benachrichtigung erforderlich sind.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Das Filterverhalten von labelIds list wurde 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)

Das Filterverhalten von labelIds list wurde angegeben. Dieses Feld ersetzt labelFilterAction. Wenn es festgelegt ist, wird labelFilterAction ignoriert.
topicName

string

Ein vollständig 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 Berechtigung zum Veröffentlichen für das Thema erteilt haben. Beispiel: „projects/my-project-identifier/topics/my-topic-name“ (mit dem Cloud Pub/Sub-Themenbenennungsformat „v1“).

Der Teil „my-project-identifier“ muss genau mit Ihrer Google-Entwicklerprojekt-ID übereinstimmen (der ID, mit der diese Watch-Anfrage ausgeführt wird).

Antworttext

Antworten auf Smartwatch-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 Verlaufsdatensatzes des Postfachs.
expiration

string (int64 format)

Wann Gmail keine Benachrichtigungen mehr für Postfachaktualisierungen sendet (Epochen-Millis). Rufen Sie watch vor diesem Zeitpunkt noch einmal auf, um die Uhr zu erneuern.

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 unter OAuth 2.0 Overview.

LabelFilterAction

Das Filterverhalten der angegebenen Liste „labelIds“ wird beschrieben.

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