Method: users.watch

Configurer ou mettre à jour une montre avec notifications push sur la boîte aux lettres utilisateur donnée.

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 limiter les notifications. Par défaut, si aucune valeur n'est spécifiée, toutes les modifications sont appliquées. Si cette option est spécifiée, elle détermine les libellés requis pour qu'une notification push soit générée.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

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

enum (LabelFilterAction)

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

string

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

Notez que la partie "my-project-identifier" doit correspondre exactement à l'ID de votre projet de développeur Google (celui qui exécute cette requête de visionnage).

Corps de la réponse

Réponse de la montre à une notification push.

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 d'historique actuel de la boîte aux lettres.
expiration

string (int64 format)

Quand Gmail arrête d'envoyer des notifications concernant les modifications de la boîte aux lettres (epoch en millisecondes). Appelez de nouveau watch 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 en savoir plus, consultez le guide relatif aux autorisations.

LabelFilterAction

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

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