Method: users.watch

Configurez ou mettez à jour une surveillance des notifications push sur la boîte de réception de l'utilisateur donné.

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é pour lesquels les notifications doivent être limitées. Par défaut, si aucun paramètre n'est spécifié, toutes les modifications sont appliquées. Si spécifié, indique les libellés requis pour qu'une notification push soit générée.
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. Ce nom de sujet doit déjà exister dans Cloud Pub/Sub, et vous devez déjà avoir accordé à Gmail l'autorisation de "publier". Par exemple, "projects/mon-identifiant-de-projet/topics/mon-nom-de-sujet" (en utilisant le format de dénomination des sujets "v1" de Cloud Pub/Sub).

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

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 de réception.
expiration

string (int64 format)

Date à laquelle Gmail cessera d'envoyer des notifications pour les mises à jour de la boîte de réception (millisecondes de l'ère). Appelez 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 d'autorisation.

LabelFilterAction

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

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