SubscriptionChannel

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

JSON 表示法
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
欄位
id

string

用於識別這個頻道的 UUID 或類似的不重複字串。

token

string

傳遞至目標地址的任意字串,且會透過此管道傳送每則通知。選用。

expiration

string (int64 format)

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

type

string

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

address

string

接收此頻道通知的電子郵件地址。

payload

boolean

表示是否想要酬載的布林值。選用。

params

map (key: string, value: string)

控制放送管道行為的其他參數。選用,舉例來說,params.ttl 可指定通知管道的存留時間 (以秒為單位),預設值為 2 小時,存留時間上限則為 2 天。

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

resourceId

string

不識別頻道的 ID 不透明。可在不同的 API 版本之間共用。

resourceUri

string

所查看資源的版本專屬 ID。

kind

string

這會做為通知管道,也就是用於查看資源變更 api#channel 的通知管道。