Method: users.watch

Configura o actualiza un reloj de notificación push en el buzón de 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. Se puede usar el valor especial me 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

Lista de labelIds sobre los que se deben restringir las notificaciones. De forma predeterminada, si no se especifica, se envían todos los cambios. Si se especifica, determina qué etiquetas se requieren para que se genere una notificación push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

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

enum (LabelFilterAction)

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

string

Un nombre completamente calificado del 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 debe haber otorgado la opción "publish" en Gmail. permiso. Por ejemplo, “proyectos/mi-identificador-de-proyecto/temas/nombre-del-tema” (con el formato de nomenclatura de temas “v1” de Cloud Pub/Sub).

Ten en cuenta que la columna “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 del reloj 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

string

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

string (int64 format)

Cuándo dejará de enviar Gmail las notificaciones de actualizaciones del buzón de correo (épocas en milisegundos). Vuelve a llamar a watch antes de este momento para renovar el reloj.

Alcances 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 labelIds.

Enumeraciones
include Solo recibirás notificaciones push sobre cambios en los mensajes relacionados con los labelIds especificados.
exclude Recibe notificaciones push sobre todos los cambios en los mensajes, excepto los relacionados con los labelIds especificados.