Perhatikan perubahan pada resource Setelan.
Permintaan
Permintaan HTTP
POST https://www.googleapis.com/calendar/v3/users/me/settings/watch
Parameter
Nama parameter | Nilai | Deskripsi |
---|
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut:
Cakupan |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.settings.readonly |
Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.
Isi permintaan
Dalam isi permintaan, berikan data dengan struktur berikut:
{ "id": string, "token": string, "type": string, "address": string, "params": { "ttl": string } }
Nama properti | Nilai | Deskripsi | Catatan |
---|---|---|---|
id |
string |
UUID atau string unik serupa yang mengidentifikasi saluran ini. | |
token |
string |
String arbitrer dikirim ke alamat target dengan setiap notifikasi dikirim melalui saluran ini. Opsional. | |
type |
string |
Jenis mekanisme pengiriman yang digunakan untuk saluran ini. Nilai yang valid adalah "web_hook " (atau "webhook "). Kedua nilai mengacu pada saluran tempat permintaan HTTP digunakan untuk mengirimkan pesan. |
|
address |
string |
Alamat yang menjadi tujuan pengiriman notifikasi untuk channel ini. | |
params |
object |
Parameter tambahan yang mengontrol perilaku saluran pengiriman. Opsional. | |
params.ttl |
string |
Time-to-live (waktu aktif) untuk saluran notifikasi dalam hitungan detik. Defaultnya adalah 604800 detik. |
Respons
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "api#channel", "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": long }
Nama properti | Nilai | Deskripsi | Catatan |
---|---|---|---|
kind |
string |
Mengidentifikasi ini sebagai saluran notifikasi yang digunakan untuk memantau perubahan pada resource, yaitu "api#channel ". |
|
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 |
long |
Tanggal dan waktu habis masa berlaku saluran notifikasi, yang dinyatakan sebagai stempel waktu Unix, dalam milidetik. Opsional. |