Fique de olho nas 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. Se você quiser acessar a agenda principal do usuário conectado, use a palavra-chave primary .
|
Parâmetros de consulta opcionais | ||
eventTypes |
string |
Tipos de eventos de recursos a serem monitorados. Opcional. Esse parâmetro pode ser repetido várias vezes para monitorar recursos de tipos diferentes. Se não for definido, retorna todos os tipos de evento.
Os valores aceitáveis são:
|
Autorização
Esta solicitação permite a 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 string exclusiva semelhante que identifica esse canal. | |
token |
string |
Uma string arbitrária entregue ao endereço de destino com cada notificação enviada 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 enviar mensagens. |
|
address |
string |
O endereço para onde as notificações são enviadas para este canal. | |
params |
object |
Parâmetros adicionais que controlam o comportamento do canal de entrega. Opcional. | |
params.ttl |
string |
O tempo de vida em segundos do canal de notificação. O padrão é 604800 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 detectar mudanças em um recurso, que é "api#channel ". |
|
id |
string |
Um UUID ou string exclusiva semelhante que identifica esse canal. | |
resourceId |
string |
Um ID opaco que identifica o recurso que está sendo assistido neste canal. Estável em diferentes versões da API. | |
resourceUri |
string |
Um identificador específico da versão para o recurso monitorado. | |
token |
string |
Uma string arbitrária entregue ao endereço de destino com cada notificação enviada por esse canal. Opcional. | |
expiration |
long |
Data e hora de expiração do canal de notificação, expressas como um carimbo de data/hora Unix, em milissegundos. Opcional. |