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

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