REST Resource: channels

資源:Channel

用於監控資源變更的通知管道。

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

此管道使用的放送機制類型。

address

string

接收這個頻道的通知地址。

params

map (key: string, value: string)

控管管道放送行為的其他參數。選用。

這個物件中包含 "key": value 組合的清單,例如:{ "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

這會識別通知,用於查看資源變更通知:api#channel

方法

stop

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