Events: watch

Procure mudanças nos recursos de Eventos.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
calendarId string Identificador da agenda. Para recuperar IDs de agendas, chame o método calendarList.list. Para acessar a agenda principal do usuário conectado, use "primary" palavra-chave.
Parâmetros de consulta opcionais
eventTypes string Tipos de eventos dos recursos para assistir. Opcional. Esse parâmetro pode ser repetido várias vezes para observar recursos de diferentes tipos. Se não definido, retorna todos os tipos de evento.

Os valores aceitáveis são:
  • "default": eventos regulares.
  • "focusTime": eventos "Horário de concentração".
  • "fromGmail": eventos do Gmail.
  • "outOfOffice": eventos fora do escritório.
  • "workingLocation": eventos do local de trabalho.

Autorização

Essa solicitação permite autorização com pelo menos um dos seguintes escopos:

Escopo
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 mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça os dados com a seguinte estrutura:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
Nome da propriedade Valor Descrição Observações
id string Um UUID ou uma string única semelhante que identifica esse canal.
token string Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por esse canal. Opcional.
type string O tipo de mecanismo de entrega usado para esse canal. Os valores válidos são "web_hook" (ou "webhook"). Ambos os valores se referem a um canal em que as solicitações HTTP são usadas para entregar mensagens.
address string O endereço onde as notificações do canal são entregues.
params object Parâmetros adicionais que controlam o comportamento do canal de entrega. Opcional.
params.ttl string O time to live (em segundos) para o canal de notificação. O padrão é 604.800 segundos.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
Nome da propriedade Valor Descrição Observações
kind string Identifica isso como um canal de notificação usado para observar alterações em um recurso, que é "api#channel".
id string Um UUID ou uma string única semelhante que identifica esse canal.
resourceId string Um ID opaco que identifica o recurso que está sendo monitorado no canal. Estável em diferentes versões da API.
resourceUri string Identificador específico da versão do recurso monitorado.
token string Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por esse canal. Opcional.
expiration long Data e hora da expiração do canal de notificação, expressas como um carimbo de data/hora Unix, em milissegundos. Opcional.