- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- LabelFilterAction
Configura o actualiza un reloj de notificaciones push en la casilla de correo del usuario determinado.
Solicitud HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
userId |
La dirección de correo electrónico del usuario. Se puede usar el valor especial |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "labelIds": [ string ], "labelFilterAction": enum ( |
Campos | |
---|---|
labelIds[] |
Lista de labelIds para restringir las notificaciones. De forma predeterminada, si no se especifica, se envían todos los cambios. Si se especifica, determina qué etiquetas son necesarias para que se genere una notificación push. |
labelFilterAction |
Se especificó el comportamiento de filtrado de |
labelFilterBehavior |
Se especificó el comportamiento de filtrado de |
topicName |
Un nombre completamente calificado de tema de la API de Google Cloud Pub/Sub para publicar los eventos. Este nombre de tema ya debe existir en Cloud Pub/Sub y debes otorgarle el permiso de “publicación” de Gmail. Por ejemplo, “projects/my-project-identifier/topics/my-topic-name” (con el formato de nombres de temas “v1” de Cloud Pub/Sub). Ten en cuenta que la parte "my-project-identifier" debe coincidir exactamente con tu ID de proyecto de desarrollador de Google (el que ejecuta esta solicitud de observación). |
Cuerpo de la respuesta
Respuesta de observación de notificación push.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ "historyId": string, "expiration": string } |
Campos | |
---|---|
historyId |
El ID del registro del historial actual del buzón. |
expiration |
Cuándo Gmail dejará de enviar notificaciones de actualizaciones del buzón (época en milisegundos) Vuelve a llamar a |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
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
Para obtener más información, consulta la guía de autorización.
LabelFilterAction
Comportamiento de filtrado de la lista labelIds especificada.
Enumeradores | |
---|---|
include |
Solo recibirás notificaciones push para los cambios de mensajes relacionados con los labelIds especificados. |
exclude |
Recibe notificaciones push para todos los cambios en los mensajes, excepto aquellos relacionados con labelIds especificados. |