REST Resource: channels

资源:频道

用于监视资源更改的通知渠道。

JSON 表示法
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
字段
payload

boolean

指示是否需要载荷的布尔值。可选。

id

string

用于标识此频道的 UUID 或类似的唯一字符串。

resourceId

string

不透明的 ID,用于标识此频道上正在监控的资源。在不同的 API 版本中保持稳定。

resourceUri

string

受监控资源的版本特定标识符。

token

string

传送到目标地址的任意字符串,随通过此渠道传送的每条通知。可选。

expiration

string (int64 format)

通知渠道到期的日期和时间,以 Unix 时间戳的形式表示(以毫秒为单位)。可选。

type

string

此渠道使用的传送机制的类型。有效值为“web_hook”或“webhook”。

address

string

接收此频道的通知的地址。

params

map (key: string, value: string)

控制投放渠道行为的其他参数。可选。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

kind

string

将其标识为用于监视资源更改的通知渠道,即 api#channel

方法

stop

停止通过此频道观看资源。