Settings: watch
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Monitorar as mudanças nos recursos de Configurações.
Solicitação
Solicitação HTTP
POST https://www.googleapis.com/calendar/v3/users/me/settings/watch
Parâmetros
Nome do parâmetro |
Valor |
Descrição |
Autorização
Esta solicitação requer 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.settings.readonly |
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. |
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Settings: watch\n\n| **Note:** Requires [authorization](#auth).\n\nWatch for changes to Settings resources.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/calendar/v3/users/me/settings/watch\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|-------|-------------|\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|--------------------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar.readonly` |\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.settings.readonly` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nIn the request body, supply data with the following structure:\n\n```carbon\n{\n \"id\": string,\n \"token\": string,\n \"type\": string,\n \"address\": string,\n \"params\": {\n \"ttl\": string\n }\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `id` | `string` | A UUID or similar unique string that identifies this channel. | |\n| `token` | `string` | An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. | |\n| `type` | `string` | The type of delivery mechanism used for this channel. Valid values are \"`web_hook`\" (or \"`webhook`\"). Both values refer to a channel where Http requests are used to deliver messages. | |\n| `address` | `string` | The address where notifications are delivered for this channel. | |\n| `params` | `object` | Additional parameters controlling delivery channel behavior. Optional. | |\n| params.`ttl` | `string` | The time-to-live in seconds for the notification channel. Default is 604800 seconds. | |\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"kind\": \"api#channel\",\n \"id\": string,\n \"resourceId\": string,\n \"resourceUri\": string,\n \"token\": string,\n \"expiration\": long\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------|----------|-------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Identifies this as a notification channel used to watch for changes to a resource, which is \"`api#channel`\". | |\n| `id` | `string` | A UUID or similar unique string that identifies this channel. | |\n| `resourceId` | `string` | An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. | |\n| `resourceUri` | `string` | A version-specific identifier for the watched resource. | |\n| `token` | `string` | An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. | |\n| `expiration` | `long` | Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. | |"]]