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 del calendario. Para recuperar los IDs de calendario, llama al método calendarList.list. Si deseas acceder al calendario principal del usuario que accedió actualmente, usa la palabra clave "primary".
Parámetros de consulta opcionales
eventTypes string Son los tipos de eventos de los recursos que se deben supervisar. Opcional. Este parámetro se puede repetir varias veces para supervisar recursos de diferentes tipos. Si no se establece, muestra todos los tipos de eventos.

Los valores aceptables son los siguientes:
  • "birthday": Eventos especiales de todo el día con una recurrencia anual.
  • "default": Eventos normales.
  • "focusTime": Eventos de tiempo dedicado.
  • "fromGmail": Eventos de Gmail.
  • "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 permisos:

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
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

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

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporciona los 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 Un UUID o una cadena única similar que identifica este canal.
token string Es una cadena arbitraria que se entrega a la dirección de destino con cada notificación que se envía a través de este canal. Opcional.
type string Es el tipo de mecanismo de publicación que se usa para este canal. Los valores válidos son "web_hook" (o "webhook"). Ambos valores se refieren a un canal en el que se usan solicitudes HTTP para entregar mensajes.
address string Es 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 publicación. Opcional.
params.ttl string Es el tiempo de actividad en segundos para el canal de notificaciones. El valor predeterminado es de 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 Identifica esto como un canal de notificaciones que se usa para detectar cambios en un recurso, que es "api#channel".
id string Un UUID o una cadena única similar que identifica este canal.
resourceId string Un ID opaco que identifica el recurso que se está mirando en este canal. Es estable en diferentes versiones de la API.
resourceUri string Es un identificador específico de la versión para el recurso observado.
token string Es una cadena arbitraria que se entrega a la dirección de destino con cada notificación que se envía a través de este canal. Opcional.
expiration long Es la fecha y hora de vencimiento del canal de notificaciones, expresada como una marca de tiempo de Unix, en milisegundos. Opcional.