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

已觀察資源的版本專屬 ID。

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

停止透過這個頻道觀看資源。