留意事件资源的更改。
请求
HTTP 请求
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
参数
参数名称 | 值 | 说明 |
---|---|---|
路径参数 | ||
calendarId |
string |
日历标识符。如要检索日历 ID,请调用 calendarList.list 方法。如果您要访问当前登录的用户的主日历,请使用关键字“primary ”。
|
可选的查询参数 | ||
eventTypes |
string |
要监控的资源类型。可选。此参数可以重复多次,以监控不同类型的资源。如果未设置,则返回所有事件类型。
可接受的值:
|
授权
此请求允许进行以下至少一个范围的授权:
范围 |
---|
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 |
如需了解详情,请参阅身份验证和授权页面。
请求正文
在请求正文中,请按以下结构提供数据:
{ "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 时间戳表示,以毫秒为单位。可选。 |