Method: users.watch

Configurer ou mettre à jour une surveillance des notifications push dans la boîte aux lettres de l'utilisateur spécifié.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userId

string

Adresse e-mail de l'utilisateur. La valeur spéciale me peut être utilisée pour indiquer l'utilisateur authentifié.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Champs
labelIds[]

string

Liste des ID de libellés pour lesquels les notifications doivent être limitées. Par défaut, si aucune option n'est spécifiée, toutes les modifications sont déployées. Si cette option est spécifiée, elle indique les libellés requis pour générer une notification push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Comportement de filtrage de labelIds list spécifié. Ce champ a été abandonné, car il entraînait un comportement incorrect dans certains cas. Utilisez plutôt labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Comportement de filtrage de labelIds list spécifié. Ce champ remplace labelFilterAction. S'il est défini, labelFilterAction est ignoré.
topicName

string

Nom de sujet de l'API Google Cloud Pub/Sub complet dans lequel publier les événements. Le nom de ce sujet doit déjà exister dans Cloud Pub/Sub et vous devez déjà avoir accordé à Gmail l'autorisation de publication sur ce sujet. Par exemple, "projects/my-project-identifier/topics/my-topic-name" (en utilisant le format de nommage des sujets Cloud Pub/Sub "v1").

Notez que la partie "my-project-identifier" doit correspondre exactement à l'ID de votre projet Google Developer (celui qui exécute cette demande de surveillance).

Corps de la réponse

Réponse à une notification push sur une montre.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "historyId": string,
  "expiration": string
}
Champs
historyId

string

ID de l'enregistrement de l'historique actuel de la boîte aux lettres.
expiration

string (int64 format)

Date à laquelle Gmail cessera d'envoyer des notifications concernant les mises à jour de la boîte aux lettres (en millisecondes depuis l'époque). Appelez watch à nouveau avant cette heure pour renouveler la montre.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

LabelFilterAction

Comportement de filtrage de la liste labelIds spécifié.

Enums
include Ne recevoir des notifications push que pour les modifications de messages liées aux labelIds spécifiés.
exclude Recevez des notifications push pour toutes les modifications apportées aux messages, à l'exception de celles liées aux labelIds spécifiés.