Kumpulan kalender di daftar kalender pengguna. Lihat juga Kalender vs CalendarList.
Untuk daftar metode resource ini, lihat bagian akhir halaman ini.
Representasi resource
{ "kind": "calendar#calendarListEntry", "etag": etag, "id": string, "summary": string, "description": string, "location": string, "timeZone": string, "summaryOverride": string, "colorId": string, "backgroundColor": string, "foregroundColor": string, "hidden": boolean, "selected": boolean, "accessRole": string, "defaultReminders": [ { "method": string, "minutes": integer } ], "notificationSettings": { "notifications": [ { "type": string, "method": string } ] }, "primary": boolean, "deleted": boolean, "conferenceProperties": { "allowedConferenceSolutionTypes": [ string ] } }
Nama properti | Nilai | Deskripsi | Catatan |
---|---|---|---|
accessRole |
string |
Peran akses efektif yang dimiliki pengguna terautentikasi pada kalender. Hanya baca. Kemungkinan nilainya adalah:
|
|
backgroundColor |
string |
Warna utama kalender dalam format heksadesimal "#0088aa ". Properti ini menggantikan properti colorId berbasis indeks. Untuk menetapkan atau mengubah properti ini, Anda harus menentukan colorRgbFormat=true dalam parameter metode insert, update, dan patch. Opsional. |
dapat ditulis |
colorId |
string |
Warna kalender. Ini adalah ID yang merujuk pada entri di bagian calendar definisi warna (lihat endpoint warna). Properti ini digantikan oleh properti backgroundColor dan foregroundColor serta dapat diabaikan saat menggunakan properti tersebut. Opsional. |
dapat ditulis |
conferenceProperties |
nested object |
Properti konferensi untuk kalender ini, misalnya jenis konferensi yang diizinkan. | |
conferenceProperties.allowedConferenceSolutionTypes[] |
list |
Jenis solusi konferensi yang didukung untuk kalender ini. Kemungkinan nilainya adalah:
|
|
defaultReminders[] |
list |
Pengingat default yang dimiliki pengguna terautentikasi untuk kalender ini. | dapat ditulis |
defaultReminders[].method |
string |
Metode yang digunakan oleh pengingat ini. Kemungkinan nilainya adalah:
Diperlukan saat menambahkan pengingat. |
dapat ditulis |
defaultReminders[].minutes |
integer |
Jumlah menit sebelum mulainya peristiwa saat pengingat akan dipicu. Nilai yang valid adalah antara 0 dan 40320 (4 minggu dalam menit). Diperlukan saat menambahkan pengingat. |
dapat ditulis |
deleted |
boolean |
Apakah entri daftar kalender ini telah dihapus dari daftar kalender. Hanya baca. Opsional. Default-nya adalah Salah. | |
description |
string |
Deskripsi kalender. Opsional. Hanya baca. | |
etag |
etag |
ETag resource. | |
foregroundColor |
string |
Warna latar depan kalender dalam format heksadesimal "#ffffff ". Properti ini menggantikan properti colorId berbasis indeks. Untuk menetapkan atau mengubah properti ini, Anda harus menentukan colorRgbFormat=true dalam parameter metode insert, update, dan patch. Opsional. |
dapat ditulis |
id |
string |
ID kalender. | |
kind |
string |
Jenis fasilitas ("calendar#calendarListEntry"). | |
location |
string |
Lokasi geografis kalender sebagai teks bentuk bebas. Opsional. Hanya baca. | |
notificationSettings |
object |
Notifikasi yang diterima pengguna terautentikasi untuk kalender ini. | dapat ditulis |
notificationSettings.notifications[] |
list |
Daftar notifikasi yang disetel untuk kalender ini. | |
notificationSettings.notifications[].method |
string |
Metode yang digunakan untuk mengirimkan notifikasi. Kemungkinan nilainya adalah:
Diperlukan saat menambahkan notifikasi. |
dapat ditulis |
notificationSettings.notifications[].type |
string |
Jenis notifikasi. Kemungkinan nilainya adalah:
Diperlukan saat menambahkan notifikasi. |
dapat ditulis |
primary |
boolean |
Apakah kalender tersebut adalah kalender utama pengguna yang diautentikasi. Hanya baca. Opsional. Default-nya adalah Salah. | |
selected |
boolean |
Apakah konten kalender muncul di UI kalender. Opsional. Default-nya adalah Salah. | dapat ditulis |
summary |
string |
Judul kalender. Hanya baca. | |
summaryOverride |
string |
Ringkasan yang telah ditetapkan pengguna terautentikasi untuk kalender ini. Opsional. | dapat ditulis |
timeZone |
string |
Zona waktu kalender. Opsional. Hanya baca. |
Metode
- hapus
- Menghapus kalender dari daftar kalender pengguna.
- dapatkan
- Menampilkan kalender dari daftar kalender pengguna.
- sisipkan
- Menyisipkan kalender yang ada ke daftar kalender pengguna.
- list
- Menampilkan kalender di daftar kalender pengguna.
- patch
- Memperbarui kalender yang ada di daftar kalender pengguna. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch menggunakan tiga unit kuota; lebih suka menggunakan
get
yang diikuti denganupdate
. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tetapkan dalam permintaan tetap tidak berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; tindakan ini akan menghapus elemen array sebelumnya. - pembaruan
- Memperbarui kalender yang ada di daftar kalender pengguna.
- jam tangan
- Perhatikan perubahan pada fasilitas CalendarList.