Method: users.watch

Configurez ou mettez à jour une surveillance des notifications push sur la boîte aux lettres de l'utilisateur spécifié. Pour en savoir plus, consultez la section Configurer les notifications push dans l'API Gmail.

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 labelIds pour limiter les notifications. Par défaut, si aucune valeur n'est spécifiée, toutes les modifications sont envoyées. Si une valeur est spécifiée, elle détermine 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 est obsolète, 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 d'API Google Cloud Pub/Sub complet pour publier les événements. Ce nom de 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 de sujet "v1" de Cloud Pub/Sub).

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 surveillance).

Corps de la réponse

Réponse de surveillance des notifications 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)

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 avant cette date pour renouveler la surveillance.

Niveaux d'accès 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 d'autorisation.

LabelFilterAction

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

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