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

受監控資源的版本專屬 ID。

token

string

系統會透過這個管道傳送通知,並將任意字串傳送至目標地址。選用項目。

expiration

string (int64 format)

通知管道的到期日期和時間,以毫秒為單位的 Unix 時間戳記表示。選用項目。

type

string

這個管道使用的傳送機制類型。有效值為「web_hook」或「webhook」。

address

string

這個管道的通知傳送地址。

kind

string

將此識別為用於監控資源變更的通知管道,即 api#channel

方法

stop

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