REST Resource: channels

资源:频道

用于监控资源变化的通知渠道。

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

map (key: string, value: string)

用于控制交付渠道行为的其他参数。可选。

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

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

相应渠道的通知的传送地址。

kind

string

将此标识为用于监控资源(即 api#channel)更改的通知渠道。

方法

stop

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