Method: users.watch

Configura o actualiza una supervisión de notificaciones push en el buzón 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

string

La dirección de correo electrónico del usuario. El valor especial me se puede usar para indicar el usuario autenticado.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Campos
labelIds[]

string

Es una lista de labelIds para restringir las notificaciones. De forma predeterminada, si no se especifica, se envían todos los cambios. Si se especifica, indica qué etiquetas son necesarias para que se genere una notificación push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Se especificó el comportamiento de filtrado de labelIds list. Este campo dejó de estar disponible porque causaba un comportamiento incorrecto en algunos casos. En su lugar, usa labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Se especificó el comportamiento de filtrado de labelIds list. Este campo reemplaza a labelFilterAction. Si se establece, se ignora labelFilterAction.
topicName

string

Es un nombre de tema de la API de Google Cloud Pub/Sub completamente calificado en el que se publicarán los eventos. Este nombre de tema debe existir ya en Cloud Pub/Sub y debes haberle otorgado a Gmail el permiso de "publicación". 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 el ID de tu proyecto de desarrollador de Google (el que ejecuta esta solicitud de reloj).

Cuerpo de la respuesta

Respuesta del reloj a la 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

string

Es el ID del registro de historial actual del buzón de correo.
expiration

string (int64 format)

Indica cuándo Gmail dejará de enviar notificaciones de actualizaciones de buzón (milésimas de época). Vuelve a llamar a watch antes de este tiempo para renovar el reloj.

Permisos de autorización

Se necesita uno de los siguientes permisos 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

Se especificó el comportamiento de filtrado de la lista de labelIds.

Enumeraciones
include Solo recibe notificaciones push para los cambios de mensajes relacionados con los labelIds especificados.
exclude Recibe notificaciones push para todos los cambios de mensajes, excepto los relacionados con los labelIds especificados.