Freebusy: query

Menampilkan informasi senggang/sibuk untuk serangkaian kalender. Coba sekarang.

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/calendar/v3/freeBusy

Otorisasi

Permintaan ini mengizinkan otorisasi dengan setidaknya satu dari cakupan berikut:

Cakupan
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

Untuk informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Dalam isi permintaan, berikan data dengan struktur berikut:

{
  "timeMin": datetime,
  "timeMax": datetime,
  "timeZone": string,
  "groupExpansionMax": integer,
  "calendarExpansionMax": integer,
  "items": [
    {
      "id": string
    }
  ]
}
Nama properti Nilai Deskripsi Catatan
timeMin datetime Awal interval untuk kueri yang diformat sesuai dengan RFC3339.
timeMax datetime Akhir interval untuk kueri yang diformat sesuai dengan RFC3339.
timeZone string Zona waktu yang digunakan dalam respons. Opsional. Default-nya adalah UTC.
groupExpansionMax integer Jumlah maksimum ID kalender yang akan disediakan untuk satu grup. Opsional. Error akan ditampilkan untuk grup yang anggotanya lebih banyak dari nilai ini. Nilai maksimum adalah 100.
calendarExpansionMax integer Jumlah maksimal kalender yang menyediakan informasi FreeBusy. Opsional. Nilai maksimum adalah 50.
items[] list Daftar kalender dan/atau grup yang akan dikueri.
items[].id string ID kalender atau grup.

Tanggapan

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

{
  "kind": "calendar#freeBusy",
  "timeMin": datetime,
  "timeMax": datetime,
  "groups": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "calendars": [
        string
      ]
    }
  },
  "calendars": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "busy": [
        {
          "start": datetime,
          "end": datetime
        }
      ]
    }
  }
}
Nama properti Nilai Deskripsi Catatan
kind string Jenis resource ("calendar#freeBusy").
timeMin datetime Awal interval.
timeMax datetime Akhir interval.
groups object Perluasan grup.
groups.(key) nested object Daftar kalender yang menjadi anggota grup ini.
groups.(key).errors[] list Error opsional (jika komputasi untuk grup gagal).
groups.(key).errors[].domain string Domain atau kategori umum error.
groups.(key).errors[].reason string Alasan spesifik terjadinya error. Beberapa kemungkinan nilainya adalah:
  • "groupTooBig" - Grup pengguna yang diminta terlalu besar untuk satu kueri.
  • "tooManyCalendarsRequested" - Jumlah kalender yang diminta terlalu besar untuk satu kueri.
  • "notFound" - Resource yang diminta tidak ditemukan.
  • "internalError" - Layanan API mengalami error internal.
Jenis error lain mungkin ditambahkan di masa mendatang, sehingga klien harus menangani dengan baik status error tambahan yang tidak disertakan dalam daftar ini.
groups.(key).calendars[] list Daftar ID kalender dalam grup.
calendars object Daftar informasi senggang/sibuk untuk kalender.
calendars.(key) nested object Perluasan senggang/sibuk untuk satu kalender.
calendars.(key).errors[] list Error opsional (jika komputasi untuk kalender gagal).
calendars.(key).errors[].domain string Domain atau kategori umum error.
calendars.(key).errors[].reason string Alasan spesifik terjadinya error. Beberapa kemungkinan nilainya adalah:
  • "groupTooBig" - Grup pengguna yang diminta terlalu besar untuk satu kueri.
  • "tooManyCalendarsRequested" - Jumlah kalender yang diminta terlalu besar untuk satu kueri.
  • "notFound" - Resource yang diminta tidak ditemukan.
  • "internalError" - Layanan API mengalami error internal.
Jenis error lain mungkin ditambahkan di masa mendatang, sehingga klien harus menangani dengan baik status error tambahan yang tidak disertakan dalam daftar ini.
calendars.(key).busy[] list Daftar rentang waktu saat kalender ini harus dianggap sibuk.
calendars.(key).busy[].start datetime Awal (termasuk) jangka waktu.
calendars.(key).busy[].end datetime Akhir (eksklusif) jangka waktu.

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data live dan lihat responsnya.