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

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