Events: import

Mengimpor acara. Operasi ini digunakan untuk menambahkan salinan pribadi 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.

Coba sekarang.

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/import

Parameter

Nama parameter Nilai Deskripsi
Parameter jalur
calendarId string ID kalender. Untuk mengambil ID kalender, panggil metode calendarList.list. Jika Anda ingin mengakses kalender utama pengguna yang saat ini login, gunakan kata kunci "primary".
Parameter kueri opsional
conferenceDataVersion integer Nomor versi data konferensi yang didukung oleh klien API. Versi 0 mengasumsikan tidak ada dukungan data konferensi dan mengabaikan data konferensi di isi peristiwa. Versi 1 mengaktifkan dukungan untuk penyalinan ConferenceData serta untuk membuat konferensi baru menggunakan kolom createRequest dari conferenceData. Defaultnya adalah 0. Nilai yang dapat diterima adalah 0 hingga 1, inklusif.
supportsAttachments boolean Apakah klien API yang melakukan operasi mendukung lampiran acara. Opsional. Defaultnya adalah False.

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut:

Cakupan
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Dalam isi permintaan, berikan Events resource dengan properti berikut:

Nama properti Nilai Deskripsi Catatan
Properti Wajib
end nested object Waktu berakhir (eksklusif) acara. Untuk acara berulang, ini adalah waktu berakhir instance pertama.
iCalUID string ID unik acara sebagaimana didefinisikan dalam RFC5545. ID ini digunakan untuk mengidentifikasi peristiwa secara unik di seluruh sistem kalender dan harus diberikan saat mengimpor peristiwa melalui metode import.

Perhatikan bahwa iCalUID dan id tidak identik dan hanya salah satunya yang boleh diberikan pada saat pembuatan peristiwa. Salah satu perbedaan semantiknya adalah bahwa dalam acara berulang, semua kemunculan satu acara memiliki id yang berbeda, tetapi semuanya memiliki iCalUID yang sama. Untuk mengambil peristiwa menggunakan iCalUID-nya, panggil metode events.list menggunakan parameter iCalUID. Untuk mengambil peristiwa menggunakan id-nya, panggil metode events.get.
start nested object Waktu mulai (inklusif) acara. Untuk acara berulang, ini adalah waktu mulai instance pertama.
Properti Opsional
anyoneCanAddSelf boolean Apakah siapa pun dapat mengundang diri mereka sendiri ke acara (tidak digunakan lagi). Opsional. Defaultnya adalah False. dapat ditulis
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
attendees[] list Peserta acara. Lihat panduan Acara dengan tamu untuk mengetahui informasi selengkapnya tentang cara menjadwalkan acara dengan pengguna kalender lain. Akun layanan harus menggunakan delegasi otoritas 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 tamu, jika tersedia. Opsional. dapat ditulis
attendees[].email string Alamat email peserta, jika tersedia. Kolom ini harus ada saat menambahkan tamu. Alamat email harus valid sesuai dengan RFC5322.

Wajib diisi saat menambahkan tamu.

 dapat ditulis
attendees[].optional boolean Apakah ini adalah tamu opsional. Opsional. Defaultnya adalah False. dapat ditulis
attendees[].resource boolean Apakah peserta adalah resource. Hanya dapat ditetapkan saat tamu ditambahkan ke acara untuk pertama kalinya. Modifikasi berikutnya akan diabaikan. Opsional. Defaultnya adalah False. dapat ditulis
attendees[].responseStatus string Status respons peserta. Nilai yang mungkin adalah:
  • "needsAction" - Tamu belum merespons undangan (direkomendasikan untuk acara baru).
  • "declined" - Tamu telah menolak undangan.
  • "tentative" - Tamu telah menerima undangan untuk sementara.
  • "accepted" - Tamu telah menerima undangan.
 dapat ditulis
attendeesOmitted boolean Apakah tamu mungkin tidak disertakan dalam representasi acara. Saat mengambil peristiwa, hal ini mungkin disebabkan oleh batasan yang ditentukan oleh parameter kueri maxAttendee. Saat memperbarui acara, parameter ini dapat digunakan untuk memperbarui respons peserta saja. Opsional. Defaultnya adalah False. dapat ditulis
colorId string Warna acara. Ini adalah ID yang merujuk ke 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, jangan lupa untuk menyetel parameter permintaan conferenceDataVersion ke 1 untuk semua permintaan modifikasi peristiwa. dapat ditulis
description string Deskripsi acara. Dapat berisi HTML. Opsional. dapat ditulis
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 di timeZone. dapat ditulis
end.timeZone string Zona waktu tempat waktu ditentukan. (Diformat sebagai nama Database Zona Waktu IANA, misalnya "Europe/Zurich".) Untuk acara berulang, kolom ini wajib diisi dan menentukan zona waktu tempat pengulangan diperluas. Untuk acara tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
extendedProperties.private object Properti yang bersifat pribadi untuk salinan acara yang muncul di kalender ini. dapat ditulis
extendedProperties.shared object Properti yang dibagikan di antara salinan acara di kalender tamu lain. dapat ditulis
focusTimeProperties nested object Data acara Waktu Fokus. Digunakan jika eventType adalah focusTime. dapat ditulis
gadget.display string Mode tampilan gadget. Tidak digunakan lagi. Nilai yang mungkin adalah:
  • "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.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. Opsional. Defaultnya adalah True. dapat ditulis
guestsCanModify boolean Apakah tamu selain penyelenggara dapat mengubah acara. Opsional. Defaultnya adalah False. dapat ditulis
guestsCanSeeOtherGuests boolean Apakah tamu selain penyelenggara dapat melihat siapa saja tamu acara. Opsional. Defaultnya adalah True. dapat ditulis
location string Lokasi geografis acara sebagai teks bebas. Opsional. dapat ditulis
organizer object Penyelenggara acara. Jika penyelenggara juga merupakan tamu, hal ini ditunjukkan dengan entri terpisah di attendees dengan kolom organizer yang ditetapkan ke True. Untuk mengubah penyelenggara, gunakan operasi move. Hanya baca, kecuali saat mengimpor acara. dapat ditulis
organizer.displayName string Nama penyelenggara, jika tersedia. dapat ditulis
organizer.email string Alamat email penyelenggara, jika tersedia. Alamat email harus valid sesuai dengan RFC5322. dapat ditulis
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 di timeZone. dapat ditulis
originalStartTime.timeZone string Zona waktu tempat waktu ditentukan. (Diformat sebagai nama Database Zona Waktu IANA, misalnya "Europe/Zurich".) Untuk acara berulang, kolom ini wajib diisi dan menentukan zona waktu tempat pengulangan diperluas. Untuk acara tunggal, kolom ini bersifat opsional dan menunjukkan zona waktu kustom untuk awal/akhir acara. dapat ditulis
outOfOfficeProperties nested object Data acara tidak di kantor. Digunakan jika eventType adalah outOfOffice. dapat ditulis
recurrence[] list Daftar baris RRULE, EXRULE, RDATE, dan EXDATE untuk acara berulang, seperti yang ditentukan dalam RFC5545. Perhatikan bahwa baris DTSTART dan DTEND tidak diizinkan dalam kolom ini; waktu mulai dan akhir acara ditentukan dalam kolom start dan end. Kolom ini tidak disertakan untuk acara tunggal atau instance acara berulang. dapat ditulis
reminders.overrides[] list Jika acara tidak menggunakan pengingat default, bagian 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 oleh pengingat ini. Nilai yang mungkin 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 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
reminders.useDefault boolean Apakah pengingat default kalender berlaku untuk acara. dapat ditulis
sequence integer Nomor urut sesuai iCalendar. dapat ditulis
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.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 di timeZone. dapat ditulis
start.timeZone string Zona waktu tempat waktu ditentukan. (Diformat sebagai nama Database Zona Waktu IANA, misalnya "Europe/Zurich".) Untuk acara berulang, kolom ini wajib diisi dan menentukan zona waktu tempat 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. Nilai yang mungkin adalah:
  • "confirmed" - Acara dikonfirmasi. Ini adalah status default.
  • "tentative" - Acara sementara dikonfirmasi.
  • "cancelled" - Acara dibatalkan (dihapus). Metode list hanya menampilkan acara yang dibatalkan pada sinkronisasi inkremental (jika syncToken atau updatedMin ditentukan) atau jika tanda showDeleted disetel ke true. Metode get selalu menampilkannya.

    Status dibatalkan mewakili dua status berbeda, bergantung pada jenis peristiwanya:

    1. Pengecualian yang dibatalkan dari acara berulang yang tidak dibatalkan menunjukkan bahwa instance ini tidak boleh lagi ditampilkan kepada pengguna. Klien harus menyimpan peristiwa ini selama masa aktif 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 lain yang dibatalkan mewakili acara yang dihapus. Klien harus menghapus salinan yang disinkronkan secara lokal. Acara yang dibatalkan tersebut pada akhirnya akan hilang, jadi jangan mengandalkan ketersediaannya tanpa batas waktu.

      Peristiwa yang dihapus hanya dijamin memiliki kolom id yang terisi.

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

    Jika penyelenggara acara berubah (misalnya melalui operasi pindah) dan penyelenggara asli tidak ada dalam daftar peserta, acara tersebut akan dibatalkan dan hanya kolom id yang dijamin terisi.

dapat ditulis
summary string Judul acara. dapat ditulis
transparency string Apakah acara memblokir waktu di kalender. Opsional. Nilai yang mungkin adalah:
  • "opaque" - Nilai default. Acara tersebut memblokir waktu di kalender. Tindakan ini sama dengan menyetel Tampilkan saya sebagai ke Sibuk di UI Kalender.
  • "transparent" - Acara tidak memblokir waktu di kalender. Tindakan ini sama dengan menyetel Tampilkan saya sebagai ke Tersedia di UI Kalender.
 dapat ditulis
visibility string Visibilitas acara. Opsional. Nilai yang mungkin 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 bersifat pribadi dan hanya peserta acara yang dapat melihat detail acara.
  • "confidential" - Acara bersifat pribadi. Nilai ini diberikan karena alasan kompatibilitas.
 dapat ditulis

Respons

Jika berhasil, metode ini akan menampilkan resource Acara dalam isi respons.

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data langsung dan melihat responsnya.