Events

Calendar API menyediakan ragam resource acara, informasi selengkapnya dapat ditemukan di Tentang acara.

Untuk 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": {
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Nama properti Nilai Deskripsi Catatan
anyoneCanAddSelf boolean Apakah orang lain dapat mengundang diri mereka sendiri ke acara (tidak digunakan lagi). Opsional. Nilai defaultnya adalah False (Salah). dapat ditulis
attachments[] list Lampiran file untuk acara.

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

Maksimal 25 lampiran per acara,
attachments[].fileId string ID dari file yang dilampirkan. Hanya baca.

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

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

Diperlukan saat menambahkan lampiran.

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

Wajib diisi saat menambahkan tamu.

 dapat ditulis
attendees[].id string ID Profil tamu, jika ada.
attendees[].optional boolean Apakah ini peserta opsional. Opsional. Nilai defaultnya adalah False (Salah). dapat ditulis
attendees[].organizer boolean Apakah tamu acara adalah penyelenggara acara. Hanya baca. Nilai defaultnya adalah False (Salah).
attendees[].resource boolean Apakah tamu adalah sumber daya. Hanya dapat ditetapkan saat tamu ditambahkan ke acara untuk pertama kalinya. Modifikasi berikutnya akan diabaikan. Opsional. Nilai defaultnya adalah False (Salah). dapat ditulis
attendees[].responseStatus string Status respons tamu. Nilainya dapat berupa:
  • "needsAction" - Peserta belum menanggapi undangan (direkomendasikan untuk acara baru).
  • "declined" - Peserta telah menolak undangan.
  • "tentative" - Peserta telah menerima undangan untuk sementara.
  • "accepted" - Peserta telah menerima undangan.
 dapat ditulis
attendees[].self boolean Apakah entri ini mewakili kalender tempat salinan acara ini muncul. Hanya baca. Nilai defaultnya adalah False (Salah).
colorId string Warna peristiwa. Ini adalah ID yang merujuk pada entri di bagian event 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 untuk menyetel 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.

Tidak disetel 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 secara unik mengidentifikasi solusi konferensi untuk acara ini.
conferenceData.conferenceSolution.key.type string Jenis solusi konferensi.

Jika klien menemukan jenis yang tidak dikenali atau kosong, klien tersebut tetap dapat menampilkan titik entri. Namun, tindakan ini harus melarang modifikasi.

Kemungkinan nilainya adalah:

  • "eventHangout" untuk Hangouts bagi konsumen (tidak digunakan lagi; acara yang ada dapat 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 dapat 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 solusi ini yang dapat dilihat pengguna. Tidak dilokalkan.
conferenceData.createRequest nested object Permintaan untuk membuat konferensi baru dan melampirkannya ke acara. Data dibuat 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 dikenali atau kosong, klien tersebut tetap dapat menampilkan titik entri. Namun, tindakan ini harus melarang modifikasi.

Kemungkinan nilainya adalah:

  • "eventHangout" untuk Hangouts bagi konsumen (tidak digunakan lagi; acara yang ada dapat 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 dapat 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 akan diabaikan.
conferenceData.createRequest.status nested object Status permintaan pembuatan konferensi.
conferenceData.createRequest.status.statusCode string Status permintaan pembuatan konferensi saat ini. 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.

Semuanya harus berasal dari 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 subkumpulan kolom {meetingCode, accessCode, passcode, password, pin} yang cocok dengan terminologi yang digunakan penyedia konferensi. Hanya kolom yang terisi yang akan ditampilkan.

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

Nilai yang dimungkinkan adalah:

  • "video" - bergabung dengan 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 dengan konferensi melalui SIP. Konferensi dapat memiliki nol atau satu titik entri sip.
  • "more" - petunjuk bergabung konferensi lebih lanjut, misalnya nomor telepon tambahan. Konferensi dapat memiliki nol atau satu titik entri more. Konferensi dengan titik entri 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 subkumpulan kolom {meetingCode, accessCode, passcode, password, pin} yang cocok dengan terminologi yang digunakan penyedia konferensi. Hanya kolom yang 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 subkumpulan kolom {meetingCode, accessCode, passcode, password, pin} yang cocok dengan terminologi yang digunakan penyedia konferensi. Hanya kolom yang terisi yang akan ditampilkan.
conferenceData.entryPoints[].password string Sandi untuk mengakses konferensi. Panjang maksimum adalah 128 karakter.

Saat membuat data konferensi baru, isi hanya subkumpulan kolom {meetingCode, accessCode, passcode, password, pin} yang cocok dengan terminologi yang digunakan penyedia konferensi. Hanya kolom yang 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 subkumpulan kolom {meetingCode, accessCode, passcode, password, pin} yang cocok dengan terminologi yang digunakan penyedia konferensi. Hanya kolom yang 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: diperlukan, mis., sip:12345678@myprovider.com.
  • untuk skema more, http:, atau https: diperlukan.

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

Dibuat di sisi server.

Tidak disetel 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 tersedia.
creator.email string Alamat email kreator, jika tersedia.
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 False (Salah).
description string Deskripsi acara. Dapat berisi HTML. Opsional. dapat ditulis
end nested object Waktu berakhir (eksklusif) acara. Untuk acara rutin, ini adalah waktu berakhir dari acara pertama.
end.date date Tanggal, dalam format "dd-mm-yyyy", jika ini adalah acara sepanjang hari. dapat ditulis
end.dateTime datetime Waktu, sebagai nilai tanggal dan waktu gabungan (diformat sesuai dengan RFC3339). Offset zona waktu diperlukan kecuali zona waktu secara eksplisit ditentukan di timeZone. dapat ditulis
end.timeZone string Zona waktu tempat waktu ditentukan. (Diformat sebagai nama Database Zona Waktu IANA, mis. "Eropa/Zurich".) Untuk acara rutin, kolom ini wajib diisi dan menentukan zona waktu saat pengulangan diperluas. Untuk acara tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
endTimeUnspecified boolean Apakah waktu berakhir sebenarnya tidak ditentukan. Waktu berakhir masih disediakan untuk alasan kompatibilitas, meskipun atribut ini disetel ke Benar (True). Nilai defaultnya adalah False (Salah).
etag etag ETag resource.
eventType string Jenis peristiwa tertentu. Hanya baca. Nilainya dapat berupa:
  • "default" - Acara reguler atau tidak ditentukan lebih lanjut.
  • "outOfOffice" - Acara tidak di kantor.
  • "focusTime" - Acara waktu fokus.
  • "workingLocation" - Peristiwa lokasi kerja.
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 antara salinan acara di kalender tamu lain. dapat ditulis
extendedProperties.shared.(key) string Nama properti bersama dan nilai yang sesuai.
gadget object Gadget yang memperluas acara ini. Gadget tidak digunakan lagi. Struktur ini hanya digunakan untuk menampilkan metadata kalender ulang tahun.
gadget.display string Mode tampilan gadget. Tidak digunakan lagi. Nilainya dapat berupa:
  • "icon" - Gadget ditampilkan di samping judul acara dalam tampilan kalender.
  • "chip" - Gadget ditampilkan saat peristiwa 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 tamu selain penyelenggara dapat mengundang orang lain ke acara tersebut. Opsional. Defaultnya adalah Benar. dapat ditulis
guestsCanModify boolean Apakah tamu selain penyelenggara dapat mengubah acara. Opsional. Nilai defaultnya adalah False (Salah). dapat ditulis
guestsCanSeeOtherGuests boolean Apakah tamu selain penyelenggara dapat melihat siapa saja peserta acara. Opsional. Defaultnya adalah Benar. dapat ditulis
iCalUID string ID unik peristiwa seperti yang ditetapkan di RFC5545. Atribut ini digunakan untuk mengidentifikasi acara di seluruh sistem kalender secara unik dan harus diberikan saat mengimpor acara melalui metode import.

Perlu diperhatikan bahwa iCalUID dan id tidak identik dan hanya salah satunya yang harus disediakan pada saat pembuatan peristiwa. Satu perbedaan dalam semantiknya adalah bahwa dalam peristiwa berulang, semua kemunculan dari satu peristiwa memiliki id yang berbeda sementara semuanya memiliki iCalUID yang sama. Untuk mengambil peristiwa menggunakan iCalUID-nya, panggil events.list method menggunakan parameter iCalUID. Untuk mengambil peristiwa menggunakan id, panggil metode events.get.
id string ID buram peristiwa. Saat membuat acara tunggal atau berulang baru, Anda dapat menentukan ID-nya. ID yang diberikan harus mengikuti aturan berikut:
  • karakter yang diizinkan di ID adalah yang digunakan dalam encoding base32hex, yaitu huruf kecil a-v dan angka 0-9, lihat bagian 3.1.2 di RFC2938
  • panjang ID harus antara 5 hingga 1024 karakter
  • ID harus unik per kalender
Karena sifat sistem yang terdistribusi secara global, kami tidak dapat menjamin bahwa tabrakan ID akan terdeteksi pada saat pembuatan peristiwa. Untuk meminimalkan risiko konflik, sebaiknya gunakan algoritme UUID yang sudah ada seperti yang dijelaskan di RFC4122.

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

Perlu diperhatikan bahwa icalUID dan id tidak identik dan hanya salah satunya yang harus disediakan pada saat pembuatan peristiwa. Satu perbedaan dalam semantiknya adalah bahwa dalam peristiwa berulang, semua kemunculan dari satu peristiwa memiliki id yang berbeda sementara semuanya memiliki icalUID yang sama.

 dapat ditulis
kind string Jenis resource ("calendar#event").
location string Lokasi geografis peristiwa sebagai teks format bebas. Opsional. dapat ditulis
locked boolean Apakah ini adalah salinan peristiwa yang dikunci tempat tidak ada perubahan yang dapat dilakukan pada kolom peristiwa utama "ringkasan", "deskripsi", "lokasi", "mulai", "akhir", atau "pengulangan". Nilai defaultnya adalah False (Salah). Hanya baca.
organizer object Penyelenggara acara. Jika penyelenggara juga merupakan tamu, hal ini akan ditunjukkan dengan entri terpisah di attendees dengan kolom organizer ditetapkan ke Benar. Untuk mengubah penyelenggara, gunakan operasi pindahkan. Hanya baca, kecuali saat mengimpor peristiwa. dapat ditulis
organizer.displayName string Nama penyelenggara, jika tersedia. dapat ditulis
organizer.email string Alamat email penyelenggara, jika tersedia. Alamat email harus valid sesuai 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 False (Salah).
originalStartTime nested object Untuk kejadian acara rutin, ini adalah waktu saat acara akan dimulai sesuai dengan data pengulangan dalam acara rutin yang diidentifikasi oleh repeatEventId. ID ini secara unik mengidentifikasi instance dalam rangkaian peristiwa berulang meskipun instance dipindahkan ke waktu lain. Tidak dapat diubah.
originalStartTime.date date Tanggal, dalam format "dd-mm-yyyy", jika ini adalah acara sepanjang hari. dapat ditulis
originalStartTime.dateTime datetime Waktu, sebagai nilai tanggal dan waktu gabungan (diformat sesuai dengan RFC3339). Offset zona waktu diperlukan kecuali zona waktu secara eksplisit ditentukan di timeZone. dapat ditulis
originalStartTime.timeZone string Zona waktu tempat waktu ditentukan. (Diformat sebagai nama Database Zona Waktu IANA, mis. "Eropa/Zurich".) Untuk acara rutin, kolom ini wajib diisi dan menentukan zona waktu saat pengulangan diperluas. Untuk acara tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
privateCopy boolean Jika disetel ke Benar (True), propagasi peristiwa dinonaktifkan. Perlu diperhatikan bahwa hal ini tidak sama dengan Properti peristiwa pribadi. Opsional. Tidak dapat diubah. Nilai defaultnya adalah False (Salah).
recurrence[] list Daftar baris Rrule, EXrules, RDATE, dan EXDATE untuk acara rutin, seperti yang ditetapkan dalam RFC5545. Perlu diperhatikan bahwa baris DTSTART dan DTEND tidak diizinkan dalam kolom ini; waktu mulai dan berakhir acara ditentukan di kolom start dan end. Kolom ini dihilangkan untuk satu peristiwa atau instance acara rutin. dapat ditulis
recurringEventId string Untuk instance acara rutin, ini adalah id acara rutin yang memiliki instance ini. Tidak dapat diubah.
reminders object Informasi tentang pengingat acara untuk pengguna terautentikasi.
reminders.overrides[] list Jika acara tidak menggunakan pengingat default, hal ini mencantumkan pengingat khusus untuk acara, atau, jika tidak disetel, menunjukkan bahwa tidak ada pengingat yang ditetapkan untuk acara ini. Jumlah maksimum pengingat penggantian adalah 5. dapat ditulis
reminders.overrides[].method string Metode yang digunakan oleh pengingat ini. Nilainya dapat berupa:
  • "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 acara dimulai saat pengingat harus terpicu. 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 urutan sesuai dengan iCalendar. dapat ditulis
source object Sumber tempat peristiwa dibuat. Misalnya, halaman web, pesan email, atau dokumen apa pun yang dapat diidentifikasi oleh 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 HTTP atau HTTPS. dapat ditulis
start nested object Waktu mulai (inklusif) acara. Untuk acara rutin, ini adalah waktu mulai dari acara pertama.
start.date date Tanggal, dalam format "dd-mm-yyyy", jika ini adalah acara sepanjang hari. dapat ditulis
start.dateTime datetime Waktu, sebagai nilai tanggal dan waktu gabungan (diformat sesuai dengan RFC3339). Offset zona waktu diperlukan kecuali zona waktu secara eksplisit ditentukan di timeZone. dapat ditulis
start.timeZone string Zona waktu tempat waktu ditentukan. (Diformat sebagai nama Database Zona Waktu IANA, mis. "Eropa/Zurich".) Untuk acara rutin, kolom ini wajib diisi dan menentukan zona waktu saat pengulangan diperluas. Untuk acara tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
status string Status acara. Opsional. Nilainya dapat berupa:
  • "confirmed" - Acara dikonfirmasi. Ini adalah status defaultnya.
  • "tentative" - Acara 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 ditetapkan ke true. Metode get selalu menampilkannya.

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

    1. Pengecualian yang dibatalkan dari acara berulang yang tidak dibatalkan menunjukkan bahwa instance ini seharusnya tidak ditampilkan lagi kepada pengguna. Klien harus menyimpan peristiwa ini selama masa pakai acara rutin induk.

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

    2. Semua acara yang dibatalkan lainnya mewakili acara yang dihapus. Klien harus menghapus salinan yang disinkronkan secara lokal. Peristiwa yang dibatalkan tersebut pada akhirnya akan hilang, jadi jangan mengandalkan peristiwa tersebut tersedia tanpa batas.

      Peristiwa yang dihapus hanya dijamin memiliki kolom id yang terisi.

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

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

dapat ditulis
summary string Judul acara. dapat ditulis
transparency string Apakah acara memblokir waktu di kalender. Opsional. Nilainya dapat berupa:
  • "opaque" - Nilai default. Acara memblokir waktu di kalender. Ini sama dengan menyetel Tampilkan saya sebagai ke Sibuk di UI Kalender.
  • "transparent" - Acara tidak memblokir waktu di kalender. Ini sama dengan menyetel Tampilkan saya sebagai ke Tersedia di UI Kalender.
 dapat ditulis
updated datetime Waktu modifikasi terakhir peristiwa (sebagai stempel waktu RFC3339). Hanya baca.
visibility string Visibilitas peristiwa. Opsional. Nilainya dapat berupa:
  • "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 bersifat pribadi dan hanya peserta acara yang dapat melihat detail acara.
  • "confidential" - Acara bersifat pribadi. Nilai ini diberikan untuk alasan kompatibilitas.
 dapat ditulis
workingLocationProperties nested object Data peristiwa Lokasi Kerja. Hanya baca.
workingLocationProperties.customLocation object Jika ada, menentukan bahwa pengguna bekerja dari lokasi kustom.
workingLocationProperties.customLocation.label string Label tambahan opsional untuk informasi tambahan.
workingLocationProperties.homeOffice any value Jika ada, menentukan bahwa pengguna bekerja di rumah.
workingLocationProperties.officeLocation object Jika ada, menentukan bahwa pengguna bekerja dari kantor.
workingLocationProperties.officeLocation.buildingId string ID gedung opsional. Hal ini akan merujuk ke ID gedung dalam database Fasilitas organisasi.
workingLocationProperties.officeLocation.deskId string ID desktop arbitrer opsional.
workingLocationProperties.officeLocation.floorId string ID lantai arbitrer opsional.
workingLocationProperties.officeLocation.floorSectionId string ID bagian lantai arbitrer opsional.
workingLocationProperties.officeLocation.label string Label tambahan opsional untuk informasi tambahan.

Metode

hapus
Menghapus acara.
dapatkan
Menampilkan acara berdasarkan ID Google Kalendernya. Untuk mengambil acara menggunakan ID iCalendar-nya, panggil metode events.list menggunakan parameter iCalUID.
impor
Mengimpor acara. Operasi ini digunakan untuk menambahkan salinan pribadi acara yang ada ke kalender.
masukkan
Membuat peristiwa.
instance
Menampilkan instance dari acara berulang yang ditentukan.
list
Menampilkan acara di kalender tertentu.
pindahkan
Memindahkan acara ke kalender lain, yaitu mengubah penyelenggara acara.
patch [patch]
Memperbarui acara. Metode ini mendukung semantik patch. Perhatikan bahwa setiap permintaan patch menggunakan tiga unit kuota; lebih baik menggunakan get yang diikuti dengan update. Nilai kolom yang Anda tentukan 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 memperbarui seluruh resource peristiwa. Untuk melakukan update sebagian, jalankan get lalu diikuti dengan update menggunakan tag ETag untuk memastikan atomisitas.
tonton
Perhatikan perubahan pada resource Peristiwa.