REST Resource: channels

リソース: Channel

リソースの変更を監視するために使用される通知チャネル。

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

 このチャンネルでのリソースのモニタリングを停止します。