Method: users.watch

Richten Sie eine Push-Benachrichtigungs-Uhr für das angegebene Postfach des Nutzers 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. 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. Wenn Sie keine Vorgabe machen, werden alle Änderungen standardmäßig übertragen. Legt fest, welche Labels erforderlich sind, damit eine Push-Benachrichtigung generiert wird.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Filterverhalten von labelIds list angegeben. Dieses Feld wurde eingestellt, da es in einigen Fällen zu fehlerhaftem Verhalten geführt hat. Verwende stattdessen labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

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

string

Ein voll qualifizierter Name des 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 Option "Veröffentlichen" erteilt haben. Berechtigung dafür haben. Beispiel: „projects/my-project-identifier/topics/my-topic-name“ (unter Verwendung des Cloud Pub/Sub-Benennungsformats für das Thema „v1“).

Der Parameter „my-project-identifier“ muss genau mit Ihrer Google-Entwicklerprojekt-ID übereinstimmen (die ID, die diese Überwachungsanfrage ausführt).

Antworttext

Uhrantwort 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 Aktualisierungen des Posteingangs sendet (Epoche Millisekunden). Rufe watch vorher 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 angegebenen LabelIds-Liste.

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