Calendars

Kumpulan semua kalender yang ada. Lihat juga Calendars vs CalendarList.

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

Representasi resource

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
Nama properti Nilai Deskripsi Catatan
autoAcceptInvitations boolean Apakah kalender ini otomatis menerima undangan. Hanya valid untuk kalender fasilitas.
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. Hanya ditetapkan untuk kalender sekunder. Hanya baca.
description string Deskripsi kalender. Opsional. dapat ditulis
etag etag ETag resource.
id string ID kalender. Untuk mengambil ID, panggil metode calendarList.list().
kind string Jenis resource ("calendar#calendar").
labelProperties nested object Properti label yang ditentukan di kalender ini. Jika ditentukan, akan menimpa properti label yang ada. Jika tidak ditentukan, properti label tidak akan berubah. dapat ditulis
labelProperties.eventLabels[] list Label acara yang ditentukan di kalender ini. Jika ada saat memperbarui kalender, label ini akan menggantikan label acara yang ada.

Perluas daftar untuk menambahkan label acara baru, dan hapus entitas dari daftar untuk menghapus label dari kalender.

Setiap kalender dapat memiliki maksimum 200 label.

dapat ditulis
labelProperties.eventLabels[].backgroundColor string Warna latar belakang label dalam format heksadesimal, seperti "#039be5". Acara dengan label ini ditampilkan dalam warna ini. Wajib. dapat ditulis
labelProperties.eventLabels[].id string ID label. Opsional saat menyisipkan label baru. Jika tidak diberikan, ID unik akan dibuat. Wajib diisi saat memperbarui label.

Jika diberikan, ID harus unik dalam kalender dan mengikuti format UUID.

dapat ditulis
labelProperties.eventLabels[].name string Nama label. Opsional.

Jika diberikan, ini harus memiliki maksimal 50 karakter.

dapat ditulis
location string Lokasi geografis kalender sebagai teks bentuk bebas. Opsional. dapat ditulis
summary string Judul kalender. dapat ditulis
timeZone string Zona waktu kalender. (Diformat sebagai nama Database Zona Waktu IANA, misalnya "Europe/Zurich".) Opsional. dapat ditulis
workingHours object Menampilkan informasi tentang jam kerja pengguna. Hanya tersedia untuk kalender utama pengguna Google Workspace. Untuk memperbarui jam kerja, seluruh objek jam kerja harus diteruskan. Jika tidak ditentukan (atau diteruskan sebagai null atau objek kosong), jam kerja yang ada tidak akan berubah. Untuk menonaktifkan jam kerja atau menghapus jadwal, tetapkan workingHoursEnabled ke false (dan hapus availableTimes atau teruskan daftar kosong). dapat ditulis
workingHours.availableTimes[] list Jam kerja. Setiap periode ketersediaan mewakili blok jam kerja pengguna selama satu hari. dapat ditulis
workingHours.availableTimes[].dayOfWeek string Hari. Wajib. Nilai yang memungkinkan adalah:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
dapat ditulis
workingHours.availableTimes[].periodEnd integer Akhir periode, dalam menit dari awal hari, eksklusif. Wajib. dapat ditulis
workingHours.availableTimes[].periodStart integer Awal periode, dalam menit dari awal hari, inklusif. Wajib. dapat ditulis
workingHours.workingHoursEnabled boolean Apakah jam kerja diaktifkan untuk kalender ini. Tidak dapat ditetapkan ke benar jika availableTimes kosong. dapat ditulis

Metode

clear
Menghapus kalender utama. Operasi ini menghapus semua acara yang terkait dengan kalender utama akun.
hapus
Menghapus kalender sekunder. Gunakan calendars.clear untuk menghapus semua acara di kalender utama.
get
Menampilkan metadata untuk kalender.
insert
Membuat kalender sekunder.

Pengguna yang diautentikasi untuk permintaan tersebut dijadikan pemilik data kalender baru.

patch
Memperbarui metadata untuk kalender. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch menggunakan tiga unit kuota; sebaiknya gunakan get diikuti dengan update. Nilai kolom yang Anda tentukan akan menggantikan nilai yang ada. Kolom yang tidak Anda tentukan dalam permintaan akan tetap tidak berubah. Kolom array, jika ditentukan, akan menimpa array yang ada; tindakan ini akan menghapus elemen array sebelumnya.
transferOwnership
Mentransfer kalender sekunder antarpengguna dalam organisasi Google Workspace. Memerlukan autentikasi pengguna dengan hak istimewa administrator Mengelola Kalender, dan salah satu cakupan otorisasi berikut:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
Dalam permintaan, tetapkan useAdminAccess ke true. Kalender sekunder harus aktif agar dapat ditransfer. Mentransfer kalender yang dinonaktifkan atau dihapus tidak didukung.
update
Memperbarui metadata untuk kalender.