API Reference

Referensi API ini disusun 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. Peristiwa
  7. Senggang/sibuk
  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.
dapatkan GET  /calendars/calendarId/acl/ruleId Menampilkan aturan kontrol akses.
sisipkan 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 memakai tiga unit kuota; lebih suka menggunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan tetap tidak berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; tindakan ini akan menghapus elemen array sebelumnya.
perbarui PUT  /calendars/calendarId/acl/ruleId Memperbarui aturan kontrol akses.
smartwatch POST  /calendars/calendarId/acl/watch Perhatikan perubahan pada resource ACL.

CalendarList

Untuk detail Resource CalendarList, lihat halaman representasi fasilitas.

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.
dapatkan GET  /users/me/calendarList/calendarId Menampilkan kalender dari daftar kalender pengguna.
sisipkan POST  /users/me/calendarList Menyisipkan kalender yang sudah ada ke 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 memakai tiga unit kuota; lebih suka menggunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan tetap tidak berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; tindakan ini akan menghapus elemen array sebelumnya.
perbarui PUT  /users/me/calendarList/calendarId Memperbarui kalender yang ada di daftar kalender pengguna.
smartwatch POST  /users/me/calendarList/watch Perhatikan perubahan pada fasilitas CalendarList.

Kalender

Untuk detail Fasilitas Kalender, lihat halaman representasi fasilitas.

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 Calendar.clear untuk menghapus semua acara di kalender utama.
dapatkan GET  /calendars/calendarId Menampilkan metadata untuk kalender.
sisipkan POST  /calendars Membuat kalender sekunder.
patch PATCH  /calendars/calendarId Memperbarui metadata untuk kalender. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch memakai tiga unit kuota; lebih suka menggunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan tetap tidak berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; tindakan ini akan menghapus elemen array sebelumnya.
perbarui PUT  /calendars/calendarId Memperbarui metadata untuk kalender.

Channel

Untuk detail Resource Saluran, lihat halaman representasi resource.

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

Warna

Untuk 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
dapatkan GET  /colors Menampilkan definisi warna untuk kalender dan acara.

Acara

Untuk 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.
dapatkan GET  /calendars/calendarId/events/eventId Menampilkan acara berdasarkan ID Google Kalendernya. Untuk mengambil peristiwa menggunakan ID iKalender-nya, panggil metode events.list menggunakan parameter iCalUID.
import POST  /calendars/calendarId/events/import Mengimpor peristiwa. Operasi ini digunakan untuk menambahkan salinan pribadi dari 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 khusus jenis peristiwa yang mungkin dimilikinya akan dihapus.

sisipkan POST  /calendars/calendarId/events Membuat peristiwa.
instance GET  /calendars/calendarId/events/eventId/instances Menampilkan instance peristiwa berulang yang ditentukan.
list GET  /calendars/calendarId/events Menampilkan acara pada kalender yang ditentukan.
pindahkan POST  /calendars/calendarId/events/eventId/move Memindahkan acara ke kalender lain, yaitu mengubah penyelenggara acara. Perhatikan bahwa hanya peristiwa default yang dapat dipindahkan; peristiwa outOfOffice, focusTime, workingLocation, dan fromGmail tidak dapat dipindahkan.

Parameter kueri yang diperlukan: destination

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

Parameter kueri yang diperlukan: text

perbarui PUT  /calendars/calendarId/events/eventId Memperbarui acara. Metode ini tidak mendukung semantik patch dan selalu mengupdate seluruh resource peristiwa. Untuk melakukan update sebagian, lakukan get yang diikuti dengan update menggunakan etag untuk memastikan atomicity.
smartwatch POST  /calendars/calendarId/events/watch Perhatikan perubahan pada resource Acara.

Senggang/sibuk

Untuk mengetahui detail Resource Senggang, 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 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
dapatkan GET  /users/me/settings/setting Menampilkan satu setelan pengguna.
list GET  /users/me/settings Menampilkan semua setelan pengguna untuk pengguna yang diautentikasi.
smartwatch POST  /users/me/settings/watch Perhatikan perubahan pada resource Setelan.