Events: list

Menampilkan acara di kalender yang ditentukan. Coba sekarang.

Permintaan

Permintaan HTTP

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

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
alwaysIncludeEmail boolean Tidak digunakan lagi dan diabaikan.
eventTypes string Jenis peristiwa yang akan ditampilkan. Opsional. Parameter ini dapat diulang beberapa kali untuk menampilkan peristiwa dari berbagai jenis. Jika tidak disetel, akan menampilkan semua jenis peristiwa.

Nilai yang dapat diterima adalah:
  • "birthday": Acara khusus sepanjang hari dengan pengulangan tahunan.
  • "default": Acara rutin.
  • "focusTime": Acara waktu fokus.
  • "fromGmail": Acara dari Gmail.
  • "outOfOffice": Acara tidak di kantor.
  • "workingLocation": Acara lokasi kerja.
iCalUID string Menentukan ID acara dalam format iCalendar yang akan diberikan dalam respons. Opsional. Gunakan ini jika Anda ingin menelusuri acara berdasarkan ID iCalendar-nya.
maxAttendees integer Jumlah maksimum tamu yang akan disertakan dalam respons. Jika jumlah peserta lebih banyak dari yang ditentukan, hanya peserta yang akan ditampilkan. Opsional.
maxResults integer Jumlah maksimum peristiwa yang ditampilkan di satu halaman hasil. Jumlah peristiwa di halaman hasil mungkin kurang dari nilai ini, atau tidak ada sama sekali, meskipun ada lebih banyak peristiwa yang cocok dengan kueri. Halaman yang tidak lengkap dapat dideteksi oleh kolom nextPageToken yang tidak kosong dalam respons. Secara default, nilainya adalah 250 peristiwa. Ukuran halaman tidak boleh lebih besar dari 2.500 peristiwa. Opsional.
orderBy string Urutan peristiwa yang ditampilkan dalam hasil. Opsional. Defaultnya adalah urutan stabil yang tidak ditentukan.

Nilai yang dapat diterima adalah:
  • "startTime": Urutkan berdasarkan tanggal/waktu mulai (menaik). Ini hanya tersedia saat mengkueri satu peristiwa (yaitu parameter singleEvents adalah True)
  • "updated": Urutkan berdasarkan waktu modifikasi terakhir (menaik).
pageToken string Token yang menentukan halaman hasil mana yang akan ditampilkan. Opsional.
privateExtendedProperty string Batasan properti yang diperluas ditentukan sebagai propertyName=value. Hanya cocok dengan properti pribadi. Parameter ini dapat diulang beberapa kali untuk menampilkan peristiwa yang cocok dengan semua batasan yang diberikan.
q string Istilah penelusuran teks bebas untuk menemukan peristiwa yang cocok dengan istilah ini di kolom berikut:
  • summary
  • description
  • location
  • displayName peserta
  • email peserta
  • penyelenggara displayName
  • penyelenggara email
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

Istilah penelusuran ini juga mencocokkan kata kunci yang telah ditentukan sebelumnya dengan semua terjemahan judul tampilan dari acara lokasi kerja, tidak ada di kantor, dan waktu fokus. Misalnya, menelusuri "Kantor" atau "Biro" akan menampilkan acara lokasi kerja berjenis officeLocation, sedangkan menelusuri "Di luar kantor" atau "Abwesend" akan menampilkan acara di luar kantor. Opsional.
sharedExtendedProperty string Batasan properti yang diperluas ditentukan sebagai propertyName=value. Hanya cocok dengan properti bersama. Parameter ini dapat diulang beberapa kali untuk menampilkan peristiwa yang cocok dengan semua batasan yang diberikan.
showDeleted boolean Apakah akan menyertakan peristiwa yang dihapus (dengan status sama dengan "cancelled") dalam hasil. Instance acara berulang yang dibatalkan (tetapi bukan acara berulang yang mendasarinya) akan tetap disertakan jika showDeleted dan singleEvents bernilai False. Jika showDeleted dan singleEvents keduanya bernilai True, hanya satu instance acara yang dihapus (tetapi bukan acara berulang yang mendasarinya) yang ditampilkan. Opsional. Defaultnya adalah False.
showHiddenInvitations boolean Apakah akan menyertakan undangan tersembunyi dalam hasil. Opsional. Defaultnya adalah False.
singleEvents boolean Apakah akan meluaskan acara berulang menjadi instance dan hanya menampilkan acara satu kali dan instance acara berulang, tetapi bukan acara berulang yang mendasarinya. Opsional. Defaultnya adalah False.
syncToken string Token yang diperoleh dari kolom nextSyncToken yang ditampilkan di halaman hasil terakhir dari permintaan daftar sebelumnya. Hal ini membuat hasil permintaan daftar ini hanya berisi entri yang telah berubah sejak saat itu. Semua acara yang dihapus sejak permintaan daftar sebelumnya akan selalu ada di set hasil dan showDeleted tidak boleh disetel ke False.
Ada beberapa parameter kueri yang tidak dapat ditentukan bersama dengan nextSyncToken untuk memastikan konsistensi status klien.

Berikut ini:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
Semua parameter kueri lainnya harus sama seperti untuk sinkronisasi awal guna menghindari perilaku yang tidak terdefinisi. Jika syncToken berakhir, server akan merespons dengan kode respons 410 GONE dan klien harus menghapus penyimpanan serta melakukan sinkronisasi penuh tanpa syncToken.
Pelajari lebih lanjut sinkronisasi inkremental.
Opsional. Defaultnya adalah menampilkan semua entri.
timeMax datetime Batas atas (eksklusif) untuk waktu mulai acara yang akan difilter. Opsional. Setelan defaultnya adalah tidak memfilter menurut waktu mulai. Harus berupa stempel waktu RFC3339 dengan offset zona waktu wajib, misalnya, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milidetik dapat diberikan, tetapi akan diabaikan. Jika timeMin ditetapkan, timeMax harus lebih besar dari timeMin.
timeMin datetime Batas bawah (eksklusif) untuk waktu berakhir acara yang akan difilter. Opsional. Setelan defaultnya adalah tidak memfilter menurut waktu berakhir. Harus berupa stempel waktu RFC3339 dengan offset zona waktu wajib, misalnya, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milidetik dapat diberikan, tetapi akan diabaikan. Jika timeMax disetel, timeMin harus lebih kecil dari timeMax.
timeZone string Zona waktu yang digunakan dalam respons. Opsional. Defaultnya adalah zona waktu kalender.
updatedMin datetime Batas bawah untuk waktu modifikasi terakhir suatu peristiwa (sebagai stempel waktu RFC3339) yang akan difilter. Jika ditentukan, entri yang dihapus sejak waktu ini akan selalu disertakan, terlepas dari showDeleted. Opsional. Defaultnya adalah tidak memfilter menurut waktu perubahan terakhir.

Otorisasi

Permintaan ini memungkinkan otorisasi dengan setidaknya salah satu cakupan berikut:

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

Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Jangan berikan isi permintaan dengan metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
Nama properti Nilai Deskripsi Catatan
kind string Jenis koleksi ("calendar#events").
etag etag ETag koleksi.
summary string Judul kalender. Hanya baca.
description string Deskripsi kalender. Hanya baca.
updated datetime Waktu modifikasi terakhir kalender (sebagai stempel waktu RFC3339). Hanya baca.
timeZone string Zona waktu kalender. Hanya baca.
accessRole string Peran akses pengguna untuk kalender ini. Hanya baca. Kemungkinan nilainya adalah:
  • "none" - Pengguna tidak memiliki akses.
  • "freeBusyReader" - Pengguna memiliki akses baca ke informasi senggang/sibuk.
  • "reader" - Pengguna memiliki akses baca ke kalender. Acara pribadi akan muncul bagi pengguna dengan akses pelihat, tetapi detail acara akan disembunyikan.
  • "writer" - Pengguna memiliki akses baca dan tulis ke kalender. Acara pribadi akan muncul bagi pengguna dengan akses penulis, dan detail acara akan terlihat.
  • "owner" - Pengguna memiliki akses pengelola ke kalender. Peran ini memiliki semua izin peran penulis dengan kemampuan tambahan untuk melihat dan mengubah tingkat akses pengguna lain.

defaultReminders[] list Pengingat default di kalender untuk pengguna yang diautentikasi. Pengingat ini berlaku untuk semua acara di kalender ini yang tidak secara eksplisit menggantikannya (yaitu, tidak menyetel reminders.useDefault ke Benar (True)).
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
nextPageToken string Token yang digunakan untuk mengakses halaman berikutnya dari hasil ini. Dihapus jika tidak ada hasil lebih lanjut, dalam hal ini nextSyncToken diberikan.
items[] list Daftar acara di kalender.
nextSyncToken string Token yang digunakan di lain waktu untuk mengambil hanya entri yang telah berubah sejak hasil ini ditampilkan. Dihapus jika hasil lainnya tersedia, dalam hal ini nextPageToken diberikan.

Cobalah!

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