API Reference

Referensi API ini diatur berdasarkan jenis resource. Setiap jenis resource memiliki satu atau beberapa representasi data dan satu atau beberapa metode.

Jenis resource

  1. Acl
  2. CalendarList
  3. Kalender
  4. Saluran
  5. Warna
  6. Acara
  7. Freebusy
  8. Setelan

Acl

Untuk mengetahui detail Resource Acl, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
hapus DELETE  /calendars/calendarId/acl/ruleId Menghapus aturan kontrol akses.
get GET  /calendars/calendarId/acl/ruleId Menampilkan aturan kontrol akses.
insert POST  /calendars/calendarId/acl Membuat aturan kontrol akses.
list GET  /calendars/calendarId/acl Menampilkan aturan dalam daftar kontrol akses untuk kalender.
patch PATCH  /calendars/calendarId/acl/ruleId Memperbarui aturan kontrol akses. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch menggunakan tiga unit kuota; sebaiknya gunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan tidak akan berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; hal ini akan menghapus elemen array sebelumnya.
update PUT  /calendars/calendarId/acl/ruleId Memperbarui aturan kontrol akses.
tonton POST  /calendars/calendarId/acl/watch Memantau perubahan pada resource ACL.

CalendarList

Untuk mengetahui detail Resource CalendarList, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
hapus DELETE  /users/me/calendarList/calendarId Menghapus kalender dari daftar kalender pengguna.
get GET  /users/me/calendarList/calendarId Menampilkan kalender dari daftar kalender pengguna.
insert POST  /users/me/calendarList Menyisipkan kalender yang ada ke dalam daftar kalender pengguna.
list GET  /users/me/calendarList Menampilkan kalender di daftar kalender pengguna.
patch PATCH  /users/me/calendarList/calendarId Memperbarui kalender yang ada di daftar kalender pengguna. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch menggunakan tiga unit kuota; sebaiknya gunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan tidak akan berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; hal ini akan menghapus elemen array sebelumnya.
update PUT  /users/me/calendarList/calendarId Memperbarui kalender yang ada di daftar kalender pengguna.
tonton POST  /users/me/calendarList/watch Memantau perubahan pada resource CalendarList.

Kalender

Untuk mengetahui detail Resource Kalender, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
hapus POST  /calendars/calendarId/clear Menghapus kalender utama. Operasi ini menghapus semua acara yang terkait dengan kalender utama akun.
hapus DELETE  /calendars/calendarId Menghapus kalender sekunder. Gunakan calendars.clear untuk menghapus semua acara di kalender utama.
get GET  /calendars/calendarId Menampilkan metadata untuk kalender.
insert POST  /calendars Membuat kalender sekunder.

Pengguna terautentikasi untuk permintaan tersebut akan menjadi pemilik data kalender baru.
patch PATCH  /calendars/calendarId Memperbarui metadata untuk kalender. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch menggunakan tiga unit kuota; sebaiknya gunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan tidak akan berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; hal ini akan menghapus elemen array sebelumnya.
update PUT  /calendars/calendarId Memperbarui metadata untuk kalender.

Channel

Untuk mengetahui detail Resource Channel, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
stop POST  /channels/stop Berhenti menonton referensi melalui saluran ini.

Warna

Untuk mengetahui detail Resource Warna, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
get GET  /colors Menampilkan definisi warna untuk kalender dan acara.

Acara

Untuk mengetahui detail Resource Peristiwa, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
hapus DELETE  /calendars/calendarId/events/eventId Menghapus acara.
get GET  /calendars/calendarId/events/eventId Menampilkan acara berdasarkan ID Google Kalendernya. Untuk mengambil acara menggunakan ID iCalendar-nya, panggil metode events.list menggunakan parameter iCalUID.
impor POST  /calendars/calendarId/events/import Mengimpor acara. Operasi ini digunakan untuk menambahkan salinan pribadi acara yang ada ke kalender. Hanya peristiwa dengan eventType default yang dapat diimpor.

Perilaku yang tidak digunakan lagi: Jika peristiwa non-default diimpor, jenisnya akan diubah menjadi default dan properti spesifik jenis peristiwa yang mungkin dimilikinya akan dihapus.
insert POST  /calendars/calendarId/events Membuat acara.
instances GET  /calendars/calendarId/events/eventId/instances Menampilkan instance acara berulang tertentu.
list GET  /calendars/calendarId/events Menampilkan acara di kalender yang ditentukan.
move POST  /calendars/calendarId/events/eventId/move Memindahkan acara ke kalender lain, yaitu mengubah penyelenggara acara. Perhatikan bahwa hanya peristiwa default yang dapat dipindahkan; peristiwa birthday, focusTime, fromGmail, outOfOffice, dan workingLocation tidak dapat dipindahkan.

Parameter kueri wajib: destination

patch PATCH  /calendars/calendarId/events/eventId Memperbarui acara. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch menggunakan tiga unit kuota; sebaiknya gunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan tidak akan berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; hal ini akan menghapus elemen array sebelumnya.
quickAdd POST  /calendars/calendarId/events/quickAdd Membuat peristiwa berdasarkan string teks sederhana.

Parameter kueri wajib: text

update PUT  /calendars/calendarId/events/eventId Memperbarui acara. Metode ini tidak mendukung semantik patch dan selalu mengupdate seluruh resource acara. Untuk melakukan update sebagian, lakukan get yang diikuti dengan update menggunakan eTag untuk memastikan atomisitas.
tonton POST  /calendars/calendarId/events/watch Pantau perubahan pada resource Acara.

Senggang/sibuk

Untuk mengetahui detail Resource Freebusy, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
query POST  /freeBusy Menampilkan informasi senggang/sibuk untuk sekumpulan kalender.

Setelan

Untuk mengetahui detail Resource Setelan, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/calendar/v3, kecuali jika dinyatakan lain
get GET  /users/me/settings/setting Menampilkan setelan pengguna tunggal.
list GET  /users/me/settings Menampilkan semua setelan pengguna untuk pengguna terautentikasi.
tonton POST  /users/me/settings/watch Pantau perubahan pada resource Setelan.