Perhatikan perubahan pada resource Acara.
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 dari pengguna yang saat ini sudah login, gunakan kata kunci "primary ".
|
Parameter kueri opsional | ||
eventTypes |
string |
Jenis acara sumber daya untuk ditonton. Opsional. Parameter ini dapat diulang beberapa kali untuk mengamati resource dari berbagai jenis. Jika tidak disetel, semua jenis peristiwa akan ditampilkan.
Nilai yang dapat diterima adalah:
|
Otorisasi
Permintaan ini memungkinkan 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.events.readonly |
https://www.googleapis.com/auth/calendar.events |
Untuk 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 dikirimkan ke alamat target dengan setiap notifikasi yang dikirimkan 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 pada saluran yang menggunakan permintaan Http untuk mengirim pesan. |
|
address |
string |
Alamat tujuan notifikasi dikirim untuk channel ini. | |
params |
object |
Parameter tambahan yang mengontrol perilaku saluran penayangan. Opsional. | |
params.ttl |
string |
Waktu aktif dalam detik untuk saluran notifikasi. 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 channel 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 yang dikirimkan ke alamat target dengan setiap notifikasi yang dikirimkan melalui saluran ini. Opsional. | |
expiration |
long |
Tanggal dan waktu berakhirnya saluran notifikasi, yang dinyatakan sebagai stempel waktu Unix, dalam milidetik. Opsional. |