CalendarList

Kumpulan kalender dalam daftar kalender pengguna. Lihat juga Calendars vs CalendarList.

Untuk mengetahui daftar metode untuk resource ini, lihat bagian akhir halaman ini.

Representasi resource

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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 yang diautentikasi di kalender. Hanya baca. Kemungkinan nilainya adalah:
  • "freeBusyReader" - Memberikan akses baca ke informasi waktu luang/sibuk.
  • "reader" - Memberikan akses baca ke kalender. Acara pribadi akan muncul bagi pengguna dengan akses pelihat, tetapi detail acara akan disembunyikan.
  • "writer" - Memberikan akses baca dan tulis ke kalender. Acara pribadi akan muncul bagi pengguna dengan akses penulis, dan detail acara akan terlihat.
  • "owner" - Memberikan akses pengelola ke kalender. Peran ini memiliki semua izin peran penulis dengan kemampuan tambahan untuk melihat dan mengubah tingkat akses pengguna lain.

backgroundColor string Warna utama kalender dalam format heksadesimal "#0088aa". Properti ini menggantikan properti colorId berbasis indeks. Untuk menetapkan atau mengubah properti ini, Anda perlu menentukan colorRgbFormat=true dalam parameter metode insert, update, dan patch. Opsional. dapat ditulis
colorId string Warna kalender. Ini adalah ID yang merujuk ke entri di bagian calendar dari 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:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opsional.
dataOwner string Email pemilik kalender. Disetel hanya untuk kalender sekunder. Hanya baca.
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:
  • "email" - Pengingat dikirim melalui email.
  • "popup" - Pengingat dikirim melalui pop-up UI.

Wajib diisi saat menambahkan pengingat.

 dapat ditulis
defaultReminders[].minutes integer Jumlah menit sebelum acara dimulai saat pengingat harus dipicu. Nilai yang valid adalah antara 0 dan 40320 (4 minggu dalam menit).

Wajib diisi saat menambahkan pengingat.

 dapat ditulis
deleted boolean Apakah entri daftar kalender ini telah dihapus dari daftar kalender. Hanya baca. Opsional. Defaultnya adalah False.
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 perlu menentukan colorRgbFormat=true dalam parameter metode insert, update, dan patch. Opsional. dapat ditulis
hidden boolean Apakah kalender telah disembunyikan dari daftar. Opsional. Atribut hanya ditampilkan saat kalender disembunyikan, yang dalam hal ini nilainya adalah true. dapat ditulis
id string ID kalender.
kind string Jenis resource ("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 ditetapkan untuk kalender ini.
notificationSettings.notifications[].method string Metode yang digunakan untuk mengirimkan notifikasi. Nilai yang mungkin adalah:
  • "email" - Notifikasi dikirim melalui email.

Diperlukan saat menambahkan notifikasi.

 dapat ditulis
notificationSettings.notifications[].type string Jenis notifikasi. Kemungkinan nilainya adalah:
  • "eventCreation" - Notifikasi dikirim saat acara baru dimasukkan ke kalender.
  • "eventChange" - Notifikasi dikirim saat acara diubah.
  • "eventCancellation" - Notifikasi yang dikirim saat acara dibatalkan.
  • "eventResponse" - Notifikasi dikirim saat tamu undangan menanggapi undangan acara.
  • "agenda" - Agenda dengan acara hari ini (dikirim pada pagi hari).

Diperlukan saat menambahkan notifikasi.

 dapat ditulis
primary boolean Apakah kalender adalah kalender utama pengguna yang diautentikasi. Hanya baca. Opsional. Defaultnya adalah False.
selected boolean Apakah konten kalender muncul di UI kalender. Opsional. Defaultnya adalah False. 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.
get
Menampilkan kalender dari daftar kalender pengguna.
insert
Menyisipkan kalender yang ada ke dalam daftar kalender pengguna.
list
Menampilkan kalender dalam 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; 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
Memperbarui kalender yang ada di daftar kalender pengguna.
tonton
Memantau perubahan pada resource CalendarList.