REST Resource: channels

Referensi: 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 channel ini. Stabil di berbagai versi API.

resourceUri

string

ID khusus versi untuk resource yang diamati.

token

string

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

expiration

string (int64 format)

Tanggal dan waktu akhir masa berlaku saluran notifikasi, dinyatakan dalam stempel waktu Unix, dalam milidetik. Opsional.

type

string

Jenis mekanisme penayangan yang digunakan untuk saluran ini.

address

string

Alamat yang digunakan untuk mengirimkan notifikasi untuk channel ini.

params

map (key: string, value: string)

Parameter tambahan yang mengontrol perilaku saluran penayangan. Opsional.

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

kind

string

Mengidentifikasinya sebagai saluran notifikasi yang digunakan untuk mengamati perubahan pada resource, yaitu api#channel.

Metode

stop

Berhenti menonton resource melalui channel ini.