- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- LabelFilterAction
Configurez ou mettez à jour une surveillance des notifications push sur la boîte aux lettres de l'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 |
Adresse e-mail de l'utilisateur. La valeur spéciale |
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 ( |
Champs | |
---|---|
labelIds[] |
Liste des ID de libellé pour lesquels restreindre les notifications. Si aucune valeur n'est spécifiée, toutes les modifications sont envoyées par défaut. Si cette valeur est spécifiée, elle détermine les libellés requis pour qu'une notification push soit générée. |
labelFilterAction |
Comportement de filtrage de |
labelFilterBehavior |
Comportement de filtrage de |
topicName |
Nom complet du sujet de l'API Google Cloud Pub/Sub dans lequel publier les événements. Ce nom de sujet doit déjà exister dans Cloud Pub/Sub, et vous devez avoir déjà accordé le rôle de publication à Gmail. une autorisation dessus. Par exemple, "projects/my-project-identifier/topics/my-topic-name". (en utilisant le format de nommage de sujet Cloud Pub/Sub "v1"). Notez que l'identifiant "my-project-identifier" doit correspondre exactement à l'ID de votre projet Google Developers (celui qui exécute cette requête de surveillance). |
Corps de la réponse
Réponse de la montre à la 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 |
Identifiant de l'enregistrement d'historique actuel de la boîte aux lettres. |
expiration |
Moment où Gmail cesse d'envoyer des notifications pour les mises à jour de la boîte aux lettres (millisecondes epoch). Appelez de nouveau |
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 |
Recevez uniquement des notifications push pour les modifications de messages en lien avec 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. |