Method: users.watch

Richten Sie eine Push-Benachrichtigungsuhr für das angegebene Nutzerpostfach ein oder aktualisieren Sie 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. Der spezielle Wert me kann verwendet werden, um den authentifizierten Nutzer anzugeben.

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 Label-IDs, für die Benachrichtigungen eingeschränkt werden sollen. Wenn Sie nichts angeben, werden standardmäßig alle Änderungen übertragen. Wenn angegeben, gibt an, welche Labels für die Generierung einer Push-Benachrichtigung erforderlich sind.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

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

enum (LabelFilterAction)

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

string

Ein vollständig qualifizierter Name eines Google Cloud Pub/Sub API-Themas, 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 „Veröffentlichen“ für dieses 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 der Google-Entwicklerprojekt-ID übereinstimmen, für die diese Beobachtungsanfrage ausgeführt wird.

Antworttext

Antwort auf Push-Benachrichtigungen auf der Smartwatch

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)

Zeitpunkt, zu dem Gmail keine Benachrichtigungen mehr für Mailbox-Aktualisierungen sendet (Epoch-Millisekunden). Rufen Sie vor Ablauf dieses Zeitraums noch einmal watch 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 angegebenen Liste mit Label-IDs.

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