Perhatikan perubahan pada resource Peristiwa.
Permintaan
Permintaan HTTP
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
Parameter
Nama parameter | Nilai | Deskripsi |
---|---|---|
Parameter jalur | ||
calendarId |
string |
ID kalender. Untuk mengambil ID kalender, panggil metode calendarList.list. Jika Anda ingin mengakses kalender utama pengguna yang saat ini login, gunakan kata kunci "primary ".
|
Parameter kueri opsional | ||
eventTypes |
string |
Jenis peristiwa resource yang akan diamati. Opsional. Parameter ini dapat diulang beberapa kali untuk melihat resource dari berbagai jenis. Jika tidak disetel, semua jenis peristiwa akan ditampilkan.
Nilai yang dapat diterima adalah:
|
Otorisasi
Permintaan ini memungkinkan otorisasi dengan minimal salah satu cakupan berikut:
Cakupan |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
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 channel ini. | |
token |
string |
String arbitrer yang dikirim ke alamat target dengan setiap notifikasi yang 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 tersebut merujuk ke saluran tempat permintaan Http digunakan untuk mengirimkan pesan. |
|
address |
string |
Alamat tempat notifikasi dikirim untuk saluran 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 604.800 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 |
Mengidentifikasinya sebagai saluran notifikasi yang digunakan untuk memantau perubahan pada resource, yaitu "api#channel ". |
|
id |
string |
UUID atau string unik serupa yang mengidentifikasi channel 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 dipantau. | |
token |
string |
String arbitrer dikirim ke alamat target dengan setiap notifikasi dikirim melalui saluran ini. Opsional. | |
expiration |
long |
Tanggal dan waktu berakhirnya masa berlaku saluran notifikasi, yang dinyatakan sebagai stempel waktu Unix, dalam milidetik. Opsional. |