REST Resource: channels

Resource: Channel

Saluran notifikasi yang digunakan untuk memantau perubahan resource.

Representasi JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Kolom
payload

boolean

Nilai Boolean untuk menunjukkan apakah payload diinginkan. Opsional.

id

string

UUID atau string unik serupa yang mengidentifikasi saluran ini.

resourceId

string

ID buram yang mengidentifikasi resource yang sedang ditonton di saluran ini. Stabil di berbagai versi API.

resourceUri

string

ID khusus versi untuk resource yang ditonton.

token

string

String arbitrer dikirim ke alamat target dengan setiap notifikasi dikirim melalui saluran ini. Opsional.

expiration

string (int64 format)

Tanggal dan waktu habis masa berlaku saluran notifikasi, yang dinyatakan sebagai stempel waktu Unix, dalam milidetik. Opsional.

type

string

Jenis mekanisme pengiriman yang digunakan untuk saluran ini. Nilai yang valid adalah "web_hook" atau "webhook".

address

string

Alamat yang menjadi tujuan pengiriman notifikasi untuk channel ini.

params

map (key: string, value: string)

Parameter tambahan yang mengontrol perilaku saluran pengiriman. Opsional.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

Mengidentifikasi ini sebagai saluran notifikasi yang digunakan untuk memantau perubahan pada resource, yaitu api#channel.

Metode

stop

Berhenti menonton resource melalui saluran ini.