CalendarList: watch

请留意 CalendarList 资源的更改。

请求

HTTP 请求

POST https://www.googleapis.com/calendar/v3/users/me/calendarList/watch

参数

参数名称 说明

授权

此请求需要获得以下至少一个范围的授权:

范围
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

如需了解详情,请参阅身份验证和授权页面。

请求正文

在请求正文中,请按以下结构提供数据:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
属性名称 说明 备注
id string 用于标识此频道的 UUID 或类似的唯一字符串。
token string 传送到目标地址的任意字符串,随通过此渠道传送的每条通知。可选。
type string 此渠道使用的传送机制的类型。有效值为“web_hook”(或“webhook”)。这两个值都指的是使用 HTTP 请求传递消息的渠道。
address string 接收此频道的通知的地址。
params object 控制投放渠道行为的其他参数。可选。
params.ttl string 通知渠道的存留时间(以秒为单位)。默认值为 604800 秒。

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
属性名称 说明 备注
kind string 将其标识为用于监视资源更改的通知渠道,即“api#channel”。
id string 用于标识此频道的 UUID 或类似的唯一字符串。
resourceId string 不透明的 ID,用于标识此频道上正在监控的资源。在不同的 API 版本中保持稳定。
resourceUri string 受监控资源的版本特定标识符。
token string 传送到目标地址的任意字符串,随通过此渠道传送的每条通知。可选。
expiration long 通知渠道到期的日期和时间,以 Unix 时间戳的形式表示(以毫秒为单位)。可选。