Events: watch

Presta atención a los cambios en los recursos de Eventos.

Solicitud

Solicitud HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta de acceso
calendarId string Es el identificador de calendario. Para obtener los IDs de calendario, llama al método calendarList.list. Si quieres acceder al calendario principal del usuario que accedió, usa la palabra clave "primary".
Parámetros de consulta opcionales
eventTypes string Tipos de eventos de recursos para observar. Opcional. Este parámetro se puede repetir varias veces para observar recursos de diferentes tipos. Si no se establece, se muestran todos los tipos de eventos.

Los valores aceptables son los siguientes:
  • "default": Eventos normales.
  • "focusTime": Eventos de tiempo dedicado.
  • "outOfOffice": Eventos fuera de la oficina.
  • "workingLocation": Eventos de ubicación de trabajo.

Autorización

Esta solicitud permite la autorización con al menos uno de los siguientes alcances:

Alcance
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events

Para obtener más información, consulta la página de autenticación y autorización.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporciona datos con la siguiente estructura:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
Nombre de la propiedad Valor Descripción Notas
id string Es un UUID o una cadena única similar que identifica este canal.
token string Una cadena arbitraria entregada a la dirección de destino con cada notificación entregada a través de este canal. Opcional.
type string Es el tipo de mecanismo de entrega que se usa para este canal. Los valores válidos son "web_hook" (o "webhook"). Ambos valores hacen referencia a un canal en el que se usan solicitudes HTTP para entregar mensajes.
address string La dirección a la que se envían las notificaciones de este canal.
params object Parámetros adicionales que controlan el comportamiento del canal de entrega. Opcional.
params.ttl string El tiempo de actividad en segundos para el canal de notificaciones. El valor predeterminado es 604,800 segundos.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
Nombre de la propiedad Valor Descripción Notas
kind string Lo identifica como un canal de notificaciones que se usa para buscar cambios en un recurso, que es "api#channel".
id string Es un UUID o una cadena única similar que identifica este canal.
resourceId string Un ID opaco que identifica el recurso que se mira en este canal. Es estable en diferentes versiones de API.
resourceUri string Un identificador específico de la versión para el recurso observado.
token string Una cadena arbitraria entregada a la dirección de destino con cada notificación entregada a través de este canal. Opcional.
expiration long Fecha y hora del vencimiento del canal de notificaciones, expresadas como una marca de tiempo de Unix, en milisegundos. Opcional.