Events

Calendar API menyediakan berbagai ragam fasilitas acara. Informasi selengkapnya dapat ditemukan di Tentang acara.

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

Representasi resource

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Nama properti Nilai Deskripsi Catatan
anyoneCanAddSelf boolean Apakah ada yang dapat mengundang dirinya sendiri ke acara tersebut (tidak digunakan lagi). Opsional. Nilai defaultnya adalah Salah (False). dapat ditulis
attachments[] list Lampiran file untuk acara.

Untuk mengubah lampiran, parameter permintaan supportsAttachments harus disetel ke true.

Setiap acara dapat memiliki maksimal 25 lampiran,
attachments[].fileId string ID file terlampir. Hanya baca.

Untuk file Google Drive, ini adalah ID entri referensi Files yang sesuai di Drive API.
attachments[].fileUrl string Link URL ke lampiran.

Untuk menambahkan lampiran file Google Drive, gunakan format yang sama seperti di properti alternateLink dari resource Files di Drive API.

Wajib diisi saat menambahkan lampiran.

 dapat ditulis
attachments[].mimeType string Jenis media internet (jenis MIME) dari lampiran.
attachments[].title string Judul lampiran.
attendeesOmitted boolean Apakah peserta mungkin telah dihilangkan dari representasi acara. Saat mengambil peristiwa, ini mungkin karena pembatasan yang ditentukan oleh parameter kueri maxAttendee. Saat memperbarui acara, ini dapat digunakan untuk memperbarui respons peserta saja. Opsional. Nilai defaultnya adalah Salah (False). dapat ditulis
attendees[] list Para tamu acara. Lihat panduan Acara dengan tamu untuk informasi selengkapnya tentang cara menjadwalkan acara dengan pengguna kalender lain. Akun layanan harus menggunakan delegasi tingkat domain untuk mengisi daftar tamu. dapat ditulis
attendees[].additionalGuests integer Jumlah tamu tambahan. Opsional. Defaultnya adalah 0. dapat ditulis
attendees[].comment string Komentar respons peserta. Opsional. dapat ditulis
attendees[].displayName string Nama peserta, jika ada. Opsional. dapat ditulis
attendees[].email string Alamat email peserta, jika ada. Kolom ini harus ada saat menambahkan tamu. Alamat email harus valid, sesuai dengan RFC5322.

Wajib diisi saat menambahkan tamu.

 dapat ditulis
attendees[].id string ID Profil tamu, jika tersedia.
attendees[].optional boolean Apakah peserta ini opsional. Opsional. Nilai defaultnya adalah Salah (False). dapat ditulis
attendees[].organizer boolean Apakah peserta adalah penyelenggara acara. Hanya baca. Nilai defaultnya adalah Salah (False).
attendees[].resource boolean Apakah peserta merupakan resource. Hanya dapat ditetapkan saat tamu ditambahkan ke acara untuk pertama kalinya. Perubahan berikutnya akan diabaikan. Opsional. Nilai defaultnya adalah Salah (False). dapat ditulis
attendees[].responseStatus string Status respons peserta. Kemungkinan nilainya adalah:
  • "needsAction" - Tamu belum menanggapi undangan (disarankan untuk acara baru).
  • "declined" - Tamu telah menolak undangan.
  • "tentative" - Tamu telah menerima undangan untuk sementara.
  • "accepted" - Tamu telah menerima undangan.
 dapat ditulis
attendees[].self boolean Apakah entri ini mewakili kalender tempat salinan acara ini muncul. Hanya baca. Nilai defaultnya adalah Salah (False).
colorId string Warna acara. Ini adalah ID yang merujuk pada entri di bagian event dari definisi warna (lihat endpoint warna). Opsional. dapat ditulis
conferenceData nested object Informasi terkait konferensi, seperti detail konferensi Google Meet. Untuk membuat detail konferensi baru, gunakan kolom createRequest. Untuk mempertahankan perubahan Anda, jangan lupa menetapkan parameter permintaan conferenceDataVersion ke 1 untuk semua permintaan perubahan peristiwa. dapat ditulis
conferenceData.conferenceId string ID konferensi.

Dapat digunakan oleh developer untuk memantau konferensi, tidak boleh ditampilkan kepada pengguna.

Nilai ID dibentuk secara berbeda untuk setiap jenis solusi konferensi:

  • eventHangout: ID tidak ditetapkan. (Jenis konferensi ini tidak digunakan lagi.)
  • eventNamedHangout: ID adalah nama Hangout. (Jenis konferensi ini tidak digunakan lagi.)
  • hangoutsMeet: ID adalah kode rapat 10 huruf, misalnya aaa-bbbb-ccc.
  • addOn: ID ditentukan oleh penyedia pihak ketiga.
Opsional.
conferenceData.conferenceSolution nested object Solusi konferensi, seperti Google Meet.

Batalkan setelan untuk konferensi dengan permintaan pembuatan yang gagal.

conferenceSolution dan minimal satu entryPoint, atau createRequest harus ada.
conferenceData.conferenceSolution.iconUri string Ikon yang terlihat oleh pengguna untuk solusi ini.
conferenceData.conferenceSolution.key nested object Kunci yang dapat mengidentifikasi solusi konferensi secara unik untuk acara ini.
conferenceData.conferenceSolution.key.type string Jenis solusi konferensi.

Jika klien menemukan jenis yang tidak dikenal atau kosong, klien harus tetap bisa menampilkan titik entri. Namun, contoh ini harus melarang modifikasi.

Kemungkinan nilainya adalah:

  • "eventHangout" untuk Hangouts bagi konsumen (tidak digunakan lagi; acara yang ada mungkin menampilkan jenis solusi konferensi ini, tetapi konferensi baru tidak dapat dibuat)
  • "eventNamedHangout" untuk Hangouts klasik bagi pengguna Google Workspace (tidak digunakan lagi; acara yang ada mungkin menampilkan jenis solusi konferensi ini, tetapi konferensi baru tidak dapat dibuat)
  • "hangoutsMeet" untuk Google Meet (http://meet.google.com)
  • "addOn" untuk penyedia konferensi pihak ketiga

conferenceData.conferenceSolution.name string Nama yang dapat dilihat pengguna dari solusi ini. Tidak dilokalkan.
conferenceData.createRequest nested object Permintaan untuk membuat konferensi baru dan melampirkannya ke acara. Data dihasilkan secara asinkron. Untuk melihat apakah data ada, periksa kolom status.

conferenceSolution dan minimal satu entryPoint, atau createRequest harus ada.
conferenceData.createRequest.conferenceSolutionKey nested object Solusi konferensi, seperti Hangouts atau Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Jenis solusi konferensi.

Jika klien menemukan jenis yang tidak dikenal atau kosong, klien harus tetap bisa menampilkan titik entri. Namun, contoh ini harus melarang modifikasi.

Kemungkinan nilainya adalah:

  • "eventHangout" untuk Hangouts bagi konsumen (tidak digunakan lagi; acara yang ada mungkin menampilkan jenis solusi konferensi ini, tetapi konferensi baru tidak dapat dibuat)
  • "eventNamedHangout" untuk Hangouts klasik bagi pengguna Google Workspace (tidak digunakan lagi; acara yang ada mungkin menampilkan jenis solusi konferensi ini, tetapi konferensi baru tidak dapat dibuat)
  • "hangoutsMeet" untuk Google Meet (http://meet.google.com)
  • "addOn" untuk penyedia konferensi pihak ketiga

conferenceData.createRequest.requestId string ID unik yang dibuat klien untuk permintaan ini.

Klien harus membuat ulang ID ini untuk setiap permintaan baru. Jika ID yang diberikan sama dengan permintaan sebelumnya, permintaan tersebut akan diabaikan.
conferenceData.createRequest.status nested object Status permintaan pembuatan konferensi.
conferenceData.createRequest.status.statusCode string Status saat ini dari permintaan pembuatan konferensi. Hanya baca.

Kemungkinan nilainya adalah:

  • "pending": permintaan pembuatan konferensi masih diproses.
  • "success": permintaan pembuatan konferensi berhasil, titik entri diisi.
  • "failure": permintaan pembuatan konferensi gagal, tidak ada titik entri.

conferenceData.entryPoints[] list Informasi tentang titik entri konferensi individual, seperti URL atau nomor telepon.

Mereka semua harus berada dalam konferensi yang sama.

conferenceSolution dan minimal satu entryPoint, atau createRequest harus ada.
conferenceData.entryPoints[].accessCode string Kode akses untuk mengakses konferensi. Panjang maksimum adalah 128 karakter.

Saat membuat data konferensi baru, isi hanya subset kolom {meetingCode, accessCode, passcode, password, pin} yang sesuai dengan terminologi yang digunakan oleh penyedia konferensi. Hanya kolom terisi yang akan ditampilkan.

Opsional.
conferenceData.entryPoints[].entryPointType string Jenis titik entri konferensi.

Nilai yang dimungkinkan adalah:

  • "video" - bergabung ke konferensi melalui HTTP. Konferensi dapat memiliki nol atau satu titik entri video.
  • "phone" - bergabung ke konferensi dengan menekan nomor telepon. Konferensi dapat memiliki nol atau beberapa titik entri phone.
  • "sip" - bergabung ke konferensi melalui SIP. Konferensi dapat memiliki nol atau satu titik entri sip.
  • "more" - petunjuk bergabung ke konferensi lebih lanjut, misalnya nomor telepon tambahan. Konferensi dapat memiliki nol atau satu titik entri more. Konferensi dengan titik masuk more saja bukanlah konferensi yang valid.

conferenceData.entryPoints[].label string Label untuk URI. Dapat dilihat oleh pengguna akhir. Tidak dilokalkan. Panjang maksimum adalah 512 karakter.

Contoh:

  • untuk video: meet.google.com/aaa-bbbb-ccc
  • untuk phone: +1 123 268 2601
  • untuk sip: 12345678@altostrat.com
  • untuk more: tidak boleh diisi

Opsional.
conferenceData.entryPoints[].meetingCode string Kode rapat untuk mengakses konferensi. Panjang maksimum adalah 128 karakter.

Saat membuat data konferensi baru, isi hanya subset kolom {meetingCode, accessCode, passcode, password, pin} yang sesuai dengan terminologi yang digunakan oleh penyedia konferensi. Hanya kolom terisi yang akan ditampilkan.

Opsional.
conferenceData.entryPoints[].passcode string Kode sandi untuk mengakses konferensi. Panjang maksimum adalah 128 karakter.

Saat membuat data konferensi baru, isi hanya subset kolom {meetingCode, accessCode, passcode, password, pin} yang sesuai dengan terminologi yang digunakan oleh penyedia konferensi. Hanya kolom terisi yang akan ditampilkan.
conferenceData.entryPoints[].password string Sandi untuk mengakses konferensi. Panjang maksimum adalah 128 karakter.

Saat membuat data konferensi baru, isi hanya subset kolom {meetingCode, accessCode, passcode, password, pin} yang sesuai dengan terminologi yang digunakan oleh penyedia konferensi. Hanya kolom terisi yang akan ditampilkan.

Opsional.
conferenceData.entryPoints[].pin string PIN untuk mengakses konferensi. Panjang maksimum adalah 128 karakter.

Saat membuat data konferensi baru, isi hanya subset kolom {meetingCode, accessCode, passcode, password, pin} yang sesuai dengan terminologi yang digunakan oleh penyedia konferensi. Hanya kolom terisi yang akan ditampilkan.

Opsional.
conferenceData.entryPoints[].uri string URI titik entri. Panjang maksimum adalah 1.300 karakter.

Format:

  • untuk skema video, http:, atau https: diperlukan.
  • untuk phone, skema tel: diperlukan. URI harus menyertakan seluruh urutan panggilan (misalnya, tel:+12345678900,,,123456789;1234).
  • untuk sip, skema sip: wajib diisi, misalnya, sip:12345678@myprovider.com.
  • untuk skema more, http:, atau https: diperlukan.

conferenceData.notes string Catatan tambahan (seperti petunjuk dari administrator domain, pemberitahuan hukum) untuk ditampilkan kepada pengguna. Dapat berisi HTML. Panjang maksimum adalah 2.048 karakter. Opsional.
conferenceData.signature string Tanda tangan data konferensi.

Dibuat di sisi server.

Batalkan setelan untuk konferensi dengan permintaan pembuatan yang gagal.

Opsional untuk konferensi dengan permintaan pembuatan yang tertunda.
created datetime Waktu pembuatan peristiwa (sebagai stempel waktu RFC3339). Hanya baca.
creator object Pembuat acara. Hanya baca.
creator.displayName string Nama kreator, jika ada.
creator.email string Alamat email kreator, jika ada.
creator.id string ID Profil kreator, jika tersedia.
creator.self boolean Apakah pembuat sesuai dengan kalender tempat salinan acara ini muncul. Hanya baca. Nilai defaultnya adalah Salah (False).
description string Deskripsi acara. Dapat berisi HTML. Opsional. dapat ditulis
end nested object Waktu berakhir (eksklusif) acara. Untuk acara rutin, ini adalah waktu berakhir acara pertama.
end.date date Tanggal, dalam format "yyyy-mm-dd", jika ini adalah acara sepanjang hari. dapat ditulis
end.dateTime datetime Waktu, sebagai nilai tanggal-waktu gabungan (diformat sesuai dengan RFC3339). Offset zona waktu diperlukan kecuali jika zona waktu ditentukan secara eksplisit dalam timeZone. dapat ditulis
end.timeZone string Zona waktu yang digunakan untuk menentukan waktu. (Diformat sebagai nama Database Zona Waktu IANA, misalnya "Eropa/Zurich".) Untuk acara berulang, kolom ini wajib diisi dan menentukan zona waktu tempat pengulangan diperluas. Untuk peristiwa tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
endTimeUnspecified boolean Apakah waktu berakhir sebenarnya belum ditentukan. Waktu berakhir tetap disediakan untuk alasan kompatibilitas, meskipun atribut ini disetel ke Benar (True). Nilai defaultnya adalah Salah (False).
etag etag ETag resource.
eventType string Jenis acara tertentu. Setelan ini tidak dapat diubah setelah acara dibuat. Kemungkinan nilainya adalah:
  • "default" - Acara reguler atau tidak ditentukan lebih lanjut.
  • "outOfOffice" - Acara tidak di kantor.
  • "focusTime" - Acara waktu fokus.
  • "workingLocation" - Peristiwa lokasi kerja.
 dapat ditulis
extendedProperties object Properti peristiwa yang diperluas.
extendedProperties.private object Properti yang bersifat pribadi untuk salinan acara yang muncul di kalender ini. dapat ditulis
extendedProperties.private.(key) string Nama properti pribadi dan nilai yang sesuai.
extendedProperties.shared object Properti yang dibagikan di antara salinan acara di kalender tamu lain. dapat ditulis
extendedProperties.shared.(key) string Nama properti yang dibagikan dan nilai yang sesuai.
focusTimeProperties nested object Fokus pada data peristiwa Waktu. Digunakan jika eventType adalah focusTime. dapat ditulis
focusTimeProperties.autoDeclineMode string Apakah akan menolak undangan rapat yang tumpang-tindih dengan acara Waktu Fokus. Nilai yang valid adalah declineNone, artinya tidak ada undangan rapat yang ditolak; declineAllConflictingInvitations, artinya semua undangan rapat yang bentrok dengan acara tersebut akan ditolak; dan declineOnlyNewConflictingInvitations, artinya hanya undangan rapat baru yang berkonflik yang datang ketika ada acara Waktu Fokus yang akan ditolak.
focusTimeProperties.chatStatus string Status untuk menandai pengguna di Chat dan produk terkait. Ini dapat berupa available atau doNotDisturb.
focusTimeProperties.declineMessage string Pesan respons untuk disetel apakah acara yang ada atau undangan baru akan otomatis ditolak oleh Kalender.
gadget object Gadget yang memperluas acara ini. Gadget tidak lagi digunakan; struktur ini hanya digunakan untuk menampilkan metadata kalender ulang tahun.
gadget.display string Mode tampilan gadget. Tidak digunakan lagi. Kemungkinan nilainya adalah:
  • "icon" - Gadget akan ditampilkan di samping judul acara dalam tampilan kalender.
  • "chip" - Gadget akan ditampilkan saat acara diklik.
 dapat ditulis
gadget.height integer Tinggi gadget dalam piksel. Tinggi harus berupa bilangan bulat yang lebih besar dari 0. Opsional. Tidak digunakan lagi. dapat ditulis
gadget.preferences object Preferensi. dapat ditulis
gadget.preferences.(key) string Nama preferensi dan nilai yang sesuai.
gadget.title string Judul gadget. Tidak digunakan lagi. dapat ditulis
gadget.type string Jenis gadget. Tidak digunakan lagi. dapat ditulis
gadget.width integer Lebar gadget dalam piksel. Lebar harus berupa bilangan bulat yang lebih besar dari 0. Opsional. Tidak digunakan lagi. dapat ditulis
guestsCanInviteOthers boolean Apakah peserta selain penyelenggara dapat mengundang orang lain ke acara tersebut. Opsional. Nilai defaultnya adalah Benar. dapat ditulis
guestsCanModify boolean Apakah tamu selain penyelenggara dapat mengubah acara. Opsional. Nilai defaultnya adalah Salah (False). dapat ditulis
guestsCanSeeOtherGuests boolean Apakah tamu selain penyelenggara dapat melihat siapa peserta acara. Opsional. Nilai defaultnya adalah Benar. dapat ditulis
iCalUID string ID unik peristiwa seperti yang ditetapkan dalam RFC5545. ID ini digunakan untuk mengidentifikasi acara secara unik di seluruh sistem kalender dan harus diberikan saat mengimpor acara melalui metode import.

Perhatikan bahwa iCalUID dan id tidak identik dan hanya salah satunya yang harus disediakan pada waktu pembuatan peristiwa. Satu perbedaan dalam semantik adalah bahwa dalam peristiwa berulang, semua kemunculan satu peristiwa memiliki id yang berbeda, sedangkan semuanya memiliki iCalUID yang sama. Untuk mengambil peristiwa menggunakan iCalUID, panggil metode events.list menggunakan parameter iCalUID. Untuk mengambil peristiwa menggunakan id, panggil metode events.get.
id string ID peristiwa yang tidak jelas. Saat membuat acara tunggal atau berulang baru, Anda dapat menentukan ID-nya. Tanda pengenal yang diberikan harus mengikuti aturan berikut:
  • karakter yang diizinkan dalam ID adalah yang digunakan dalam encoding base32hex, yaitu huruf kecil a-v dan angka 0-9.Lihat bagian 3. 1.2 dalam RFC2938.
  • panjang ID harus antara 5 dan 1.024 karakter
  • ID harus unik per kalender
Karena sifat sistem yang terdistribusi secara global, kami tidak dapat menjamin bahwa konflik ID akan terdeteksi pada saat pembuatan acara. Untuk meminimalkan risiko tabrakan, sebaiknya gunakan algoritma UUID yang telah ditetapkan seperti yang dijelaskan dalam RFC4122.

Jika Anda tidak menentukan ID, ID tersebut akan dibuat oleh server secara otomatis.

Perhatikan bahwa icalUID dan id tidak identik dan hanya salah satunya yang harus disediakan pada waktu pembuatan peristiwa. Satu perbedaan dalam semantik adalah bahwa dalam peristiwa berulang, semua kemunculan satu peristiwa memiliki id yang berbeda, sedangkan semuanya memiliki icalUID yang sama.

 dapat ditulis
kind string Jenis resource ("calendar#event").
location string Lokasi geografis acara dalam bentuk teks bentuk bebas. Opsional. dapat ditulis
locked boolean Apakah ini adalah salinan acara yang terkunci dan tidak ada perubahan yang dapat dilakukan pada kolom acara utama "summary", "description", "location", "start", "end", atau "repeat". Nilai defaultnya adalah Salah (False). Hanya-Baca.
organizer object Penyelenggara acara. Jika penyelenggara juga merupakan tamu, hal ini ditunjukkan dengan entri terpisah di attendees dengan kolom organizer yang disetel ke Benar (True). Untuk mengubah penyelenggara, gunakan operasi pemindahan. Hanya baca, kecuali saat mengimpor acara. dapat ditulis
organizer.displayName string Nama penyelenggara, jika ada. dapat ditulis
organizer.email string Alamat email penyelenggara, jika tersedia. Alamat email harus valid, sesuai dengan RFC5322. dapat ditulis
organizer.id string ID Profil penyelenggara, jika tersedia.
organizer.self boolean Apakah penyelenggara sesuai dengan kalender tempat salinan acara ini muncul. Hanya baca. Nilai defaultnya adalah Salah (False).
originalStartTime nested object Untuk kejadian berulang, ini adalah waktu saat acara ini akan dimulai sesuai dengan data pengulangan dalam acara berulang yang diidentifikasi oleh repeatEventId. Hal ini secara unik mengidentifikasi instance dalam rangkaian peristiwa berulang meskipun instance dipindahkan ke waktu yang berbeda. Tidak dapat diubah.
originalStartTime.date date Tanggal, dalam format "yyyy-mm-dd", jika ini adalah acara sepanjang hari. dapat ditulis
originalStartTime.dateTime datetime Waktu, sebagai nilai tanggal-waktu gabungan (diformat sesuai dengan RFC3339). Offset zona waktu diperlukan kecuali jika zona waktu ditentukan secara eksplisit dalam timeZone. dapat ditulis
originalStartTime.timeZone string Zona waktu yang digunakan untuk menentukan waktu. (Diformat sebagai nama Database Zona Waktu IANA, misalnya "Eropa/Zurich".) Untuk acara berulang, kolom ini wajib diisi dan menentukan zona waktu tempat pengulangan diperluas. Untuk peristiwa tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
outOfOfficeProperties nested object Data peristiwa tidak di kantor. Digunakan jika eventType adalah outOfOffice. dapat ditulis
outOfOfficeProperties.autoDeclineMode string Apakah akan menolak undangan rapat yang tumpang-tindih dengan acara Tidak di kantor. Nilai yang valid adalah declineNone, artinya tidak ada undangan rapat yang ditolak; declineAllConflictingInvitations, artinya semua undangan rapat yang bertentangan dengan acara tersebut akan ditolak; dan declineOnlyNewConflictingInvitations, artinya hanya undangan rapat baru yang berkonflik yang datang ketika hadir acara Tidak di kantor yang akan ditolak.
outOfOfficeProperties.declineMessage string Pesan respons untuk disetel apakah acara yang ada atau undangan baru akan otomatis ditolak oleh Kalender.
privateCopy boolean Jika disetel ke Benar (True), Penyebaran peristiwa akan dinonaktifkan. Perhatikan bahwa ini tidak sama dengan Properti peristiwa pribadi. Opsional. Tidak dapat diubah. Nilai defaultnya adalah Salah (False).
recurrence[] list Daftar baris RRules, EXRules, RDATE, dan EXDATE untuk acara rutin, sebagaimana ditentukan dalam RFC5545. Perhatikan bahwa baris DTSTART dan DTEND tidak diizinkan di kolom ini. Waktu mulai dan berakhir acara ditentukan di kolom start dan end. Kolom ini dihilangkan untuk acara tunggal atau acara rutin. dapat ditulis
recurringEventId string Untuk acara rutin, ini adalah id acara rutin yang mencakup instance ini. Tidak dapat diubah.
reminders object Informasi tentang pengingat peristiwa untuk pengguna yang diautentikasi.
reminders.overrides[] list Jika acara tidak menggunakan pengingat default, ini akan mencantumkan pengingat khusus untuk acara tersebut, atau, jika tidak disetel, menunjukkan bahwa tidak ada pengingat yang disetel untuk acara ini. Jumlah maksimum pengingat penggantian adalah 5. dapat ditulis
reminders.overrides[].method string Metode yang digunakan pengingat ini. Kemungkinan nilainya adalah:
  • "email" - Pengingat dikirim melalui email.
  • "popup" - Pengingat dikirim melalui pop-up UI.

Wajib diisi saat menambahkan pengingat.

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

Wajib diisi saat menambahkan pengingat.

 dapat ditulis
reminders.useDefault boolean Apakah pengingat default kalender berlaku untuk acara. dapat ditulis
sequence integer Nomor urut sesuai iKalender. dapat ditulis
source object Sumber tempat peristiwa dibuat. Misalnya, halaman web, pesan email, atau dokumen apa pun yang dapat diidentifikasi melalui URL dengan skema HTTP atau HTTPS. Hanya dapat dilihat atau diubah oleh pembuat acara.
source.title string Judul sumber; misalnya judul halaman web atau subjek email. dapat ditulis
source.url string URL sumber yang mengarah ke resource. Skema URL harus berupa HTTP atau HTTPS. dapat ditulis
start nested object Waktu mulai (inklusif) acara. Untuk acara rutin, ini adalah waktu mulai kejadian pertama.
start.date date Tanggal, dalam format "yyyy-mm-dd", jika ini adalah acara sepanjang hari. dapat ditulis
start.dateTime datetime Waktu, sebagai nilai tanggal-waktu gabungan (diformat sesuai dengan RFC3339). Offset zona waktu diperlukan kecuali jika zona waktu ditentukan secara eksplisit dalam timeZone. dapat ditulis
start.timeZone string Zona waktu yang digunakan untuk menentukan waktu. (Diformat sebagai nama Database Zona Waktu IANA, misalnya "Eropa/Zurich".) Untuk acara berulang, kolom ini wajib diisi dan menentukan zona waktu tempat pengulangan diperluas. Untuk peristiwa tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
status string Status peristiwa. Opsional. Kemungkinan nilainya adalah:
  • "confirmed" - Acara sudah dikonfirmasi. Ini adalah status default.
  • "tentative" - Acara ini dikonfirmasi untuk sementara.
  • "cancelled" - Acara dibatalkan (dihapus). Metode list menampilkan peristiwa yang dibatalkan hanya pada sinkronisasi inkremental (saat syncToken atau updatedMin ditentukan) atau jika flag showDeleted disetel ke true. Metode get selalu menampilkannya.

    Status dibatalkan mewakili dua status yang berbeda bergantung pada jenis peristiwa:

    1. Pengecualian yang dibatalkan untuk acara berulang yang belum dibatalkan menunjukkan bahwa instance ini tidak akan ditampilkan lagi kepada pengguna. Klien harus menyimpan peristiwa ini selama masa aktif acara berulang induk.

      Pengecualian yang dibatalkan hanya dijamin memiliki nilai untuk kolom id, recurringEventId, dan originalStartTime yang terisi. Kolom lainnya mungkin kosong.

    2. Semua acara lainnya yang dibatalkan mewakili acara yang dihapus. Klien harus menghapus salinan yang disinkronkan secara lokal. Acara yang dibatalkan tersebut pada akhirnya akan hilang, jadi jangan berharap bahwa acara tersebut tersedia tanpa batas waktu.

      Peristiwa yang dihapus hanya dijamin memiliki kolom id yang terisi.

    Di kalender penyelenggara, acara yang dibatalkan akan tetap menampilkan detail acara (ringkasan, lokasi, dll.) sehingga acara tersebut dapat dipulihkan (batal dihapus). Demikian pula, acara yang mengundang pengguna dan yang dihapus secara manual akan terus menyediakan detailnya. Namun, permintaan sinkronisasi inkremental dengan showDeleted yang disetel ke salah (false) tidak akan menampilkan detail ini.

    Jika acara mengubah penyelenggaranya (misalnya melalui operasi pemindahan) dan penyelenggara asli tidak ada dalam daftar tamu, acara tersebut akan meninggalkan acara yang dibatalkan dengan hanya kolom id yang dijamin akan terisi.

dapat ditulis
summary string Judul acara. dapat ditulis
transparency string Apakah acara memblokir waktu di kalender. Opsional. Kemungkinan nilainya adalah:
  • "opaque" - Nilai default. Acara tersebut memblokir waktu di kalender. Ini sama dengan menyetel Tampilkan sebagai ke Sibuk di UI Kalender.
  • "transparent" - Acara tidak memblokir waktu di kalender. Ini sama dengan menyetel Tampilkan sebagai ke Tersedia di UI Kalender.
 dapat ditulis
updated datetime Waktu terakhir perubahan peristiwa (sebagai stempel waktu RFC3339). Hanya baca.
visibility string Visibilitas peristiwa. Opsional. Kemungkinan nilainya adalah:
  • "default" - Menggunakan visibilitas default untuk acara di kalender. Nilai ini merupakan default.
  • "public" - Acara bersifat publik dan detail acara dapat dilihat oleh semua pembaca kalender.
  • "private" - Acara ini bersifat pribadi dan hanya tamu acara yang dapat melihat detail acara.
  • "confidential" - Acara ini bersifat pribadi. Nilai ini diberikan karena alasan kompatibilitas.
 dapat ditulis
workingLocationProperties nested object Data peristiwa lokasi kerja. dapat ditulis
workingLocationProperties.customLocation object Jika ada, menentukan bahwa pengguna bekerja dari lokasi kustom. dapat ditulis
workingLocationProperties.customLocation.label string Label tambahan opsional untuk informasi tambahan. dapat ditulis
workingLocationProperties.homeOffice any value Jika ada, menyatakan bahwa pengguna bekerja di rumah. dapat ditulis
workingLocationProperties.officeLocation object Jika ada, menyatakan bahwa pengguna bekerja dari kantor. dapat ditulis
workingLocationProperties.officeLocation.buildingId string ID gedung opsional. ID ini harus merujuk ID gedung di database Resource organisasi. dapat ditulis
workingLocationProperties.officeLocation.deskId string ID desktop opsional. dapat ditulis
workingLocationProperties.officeLocation.floorId string ID lantai opsional. dapat ditulis
workingLocationProperties.officeLocation.floorSectionId string ID bagian lantai opsional. dapat ditulis
workingLocationProperties.officeLocation.label string Nama kantor yang ditampilkan di klien Seluler dan Web Kalender. Sebaiknya Anda merujuk nama gedung di database Resource organisasi. dapat ditulis
workingLocationProperties.type string Jenis lokasi kerja. Kemungkinan nilainya adalah:
  • "homeOffice" - Pengguna bekerja di rumah.
  • "officeLocation" - Pengguna sedang bekerja dari kantor.
  • "customLocation" - Pengguna bekerja dari lokasi kustom.
Detail apa pun ditentukan di sub-kolom nama yang ditentukan, tetapi kolom ini mungkin tidak ada jika kosong. Kolom lainnya akan diabaikan.

Wajib diisi saat menambahkan properti lokasi kerja.

 dapat ditulis

Metode

hapus
Menghapus acara.
dapatkan
Menampilkan acara berdasarkan ID Google Kalendernya. Untuk mengambil peristiwa menggunakan ID iKalender-nya, panggil metode events.list menggunakan parameter iCalUID.
import
Mengimpor acara. 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
Membuat peristiwa.
instance
Menampilkan instance dari acara rutin yang ditentukan.
list
Menampilkan acara di kalender yang ditentukan.
pindahkan
Memindahkan acara ke kalender lain, misalnya mengubah penyelenggara acara. Perhatikan bahwa hanya peristiwa default yang dapat dipindahkan; peristiwa outOfOffice, focusTime, dan workingLocation tidak dapat dipindahkan.
patch
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
Membuat peristiwa berdasarkan string teks sederhana.
perbarui
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
Perhatikan perubahan pada resource Acara.