CalendarList: list

Menampilkan kalender di daftar kalender pengguna. Coba sekarang.

Permintaan

Permintaan HTTP

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

Parameter

Nama parameter Nilai Deskripsi
Parameter kueri opsional
maxResults integer Jumlah maksimum entri yang ditampilkan di satu halaman hasil. Secara default, nilainya adalah 100 entri. Ukuran halaman tidak boleh lebih dari 250 entri. Opsional.
minAccessRole string Peran akses minimum untuk pengguna dalam entri yang ditampilkan. Opsional. Setelan defaultnya adalah tanpa batasan.

Nilai yang dapat diterima adalah:
  • "freeBusyReader": Pengguna dapat membaca informasi ketersediaan.
  • "owner": Pengguna dapat membaca dan mengubah acara serta daftar kontrol akses.
  • "reader": Pengguna dapat membaca acara yang tidak bersifat pribadi.
  • "writer": Pengguna dapat membaca dan mengubah acara.
  • "writerWithoutPrivateAccess": Pengguna dapat membaca dan mengubah acara, tetapi tidak dapat mengakses acara pribadi.
pageToken string Token yang menentukan halaman hasil yang akan ditampilkan. Opsional.
showDeleted boolean Menentukan apakah akan menyertakan entri daftar kalender yang dihapus dalam hasil. Opsional. Setelan defaultnya adalah False.
showHidden boolean Menentukan apakah akan menampilkan entri tersembunyi. Opsional. Setelan defaultnya adalah False.
showOwnOrganizationOnly boolean Menentukan apakah hanya akan menampilkan kalender yang dimiliki organisasi. Parameter ini hanya berlaku untuk pengguna Google Workspace. Opsional. Setelan defaultnya adalah False.
syncToken string Token yang diperoleh dari kolom nextSyncToken yang ditampilkan di halaman hasil terakhir dari permintaan daftar sebelumnya. Token ini membuat hasil permintaan daftar ini hanya berisi entri yang telah berubah sejak saat itu. Jika hanya kolom khusus baca seperti properti kalender atau ACL yang berubah, entri tidak akan ditampilkan. Semua entri yang dihapus dan disembunyikan sejak permintaan daftar sebelumnya akan selalu ada dalam kumpulan hasil dan Anda tidak diizinkan untuk menetapkan showDeleted maupun showHidden ke False.
Untuk memastikan konsistensi status klien, parameter kueri minAccessRole dan showOwnOrganizationOnly tidak dapat ditentukan bersama dengan nextSyncToken.
Jika syncToken berakhir masa berlakunya, server akan merespons dengan kode respons 410 GONE dan klien harus menghapus penyimpanan serta melakukan sinkronisasi penuh tanpa syncToken.
Pelajari lebih lanjut sinkronisasi inkremental.
Opsional. Setelan defaultnya adalah menampilkan semua entri.

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.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Jangan berikan isi permintaan dengan metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Nama properti Nilai Deskripsi Catatan
kind string Jenis koleksi ("calendar#calendarList").
etag etag ETag koleksi.
nextPageToken string Token yang digunakan untuk mengakses halaman hasil berikutnya. Dihilangkan jika tidak ada hasil lebih lanjut, yang dalam hal ini nextSyncToken akan diberikan.
items[] list Kalender yang ada di daftar kalender pengguna.
nextSyncToken string Token yang digunakan di lain waktu untuk mengambil hanya entri yang telah berubah sejak hasil ini ditampilkan. Dihilangkan jika ada hasil lebih lanjut, yang dalam hal ini nextPageToken akan diberikan.

Cobalah!

Gunakan API Explorer di bawah untuk memanggil metode ini pada data langsung dan melihat responsnya.