CalendarList: list

Menampilkan kalender di daftar kalender pengguna. Coba sekarang atau lihat contohnya.

Permintaan

Permintaan HTTP

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

Parameter

Nama parameter Nilai Deskripsi
Parameter kueri opsional
maxResults integer Jumlah maksimum entri yang ditampilkan di satu halaman hasil. Secara default, nilainya adalah 100 entri. Ukuran halaman tidak boleh lebih besar dari 250 entri. Opsional.
minAccessRole string Peran akses minimum untuk pengguna dalam entri yang ditampilkan. Opsional. Setelan defaultnya adalah tidak ada batasan.

Nilai yang dapat diterima adalah:
  • "freeBusyReader": Pengguna dapat membaca informasi senggang/sibuk.
  • "owner": Pengguna dapat membaca dan mengubah peristiwa serta daftar kontrol akses.
  • "reader": Pengguna dapat membaca peristiwa yang tidak bersifat pribadi.
  • "writer": Pengguna dapat membaca dan mengubah peristiwa.
pageToken string Token yang menentukan halaman hasil yang akan ditampilkan. Opsional.
showDeleted boolean Apakah akan menyertakan entri daftar kalender yang dihapus dalam hasil. Opsional. Default-nya adalah Salah.
showHidden boolean Menentukan apakah akan menampilkan entri tersembunyi. Opsional. Default-nya adalah Salah.
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. Jika hanya kolom khusus baca seperti properti kalender atau ACL yang telah berubah, entri tidak akan ditampilkan. Semua entri yang dihapus dan disembunyikan sejak permintaan daftar sebelumnya akan selalu ada dalam set hasil dan tidak diizinkan untuk menetapkan showDeleted atau showHidden ke Salah.
Untuk memastikan konsistensi status klien, parameter kueri minAccessRole tidak dapat ditentukan bersama dengan nextSyncToken.
Jika masa berlaku syncToken berakhir, server akan merespons dengan kode respons 410 GONE dan klien harus menghapus penyimpanannya serta melakukan sinkronisasi penuh tanpa syncToken.
Pelajari lebih lanjut sinkronisasi inkremental.
Opsional. Setelan defaultnya adalah menampilkan semua entri.

Otorisasi

Permintaan ini memerlukan 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.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.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#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Nama properti Nilai Deskripsi Catatan
kind string Jenis koleksi ("calendar#calendarList").
etag etag ETag koleksi.
nextPageToken string Token yang digunakan untuk mengakses halaman berikutnya dari hasil ini. Dihilangkan jika tidak ada hasil lebih lanjut yang tersedia, dalam hal ini nextSyncToken diberikan.
items[] list Kalender yang ada di daftar kalender pengguna.
nextSyncToken string Token yang digunakan pada waktu berikutnya untuk mengambil hanya entri yang telah berubah sejak hasil ini ditampilkan. Dihilangkan jika hasil lebih lanjut tersedia, dalam hal ini nextPageToken diberikan.

Contoh

Catatan: Contoh kode yang tersedia untuk metode ini tidak merepresentasikan semua bahasa pemrograman yang didukung (lihat halaman library klien untuk mengetahui daftar bahasa yang didukung).

Java

Menggunakan library klien Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarList;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate through entries in calendar list
String pageToken = null;
do {
  CalendarList calendarList = service.calendarList().list().setPageToken(pageToken).execute();
  List<CalendarListEntry> items = calendarList.getItems();

  for (CalendarListEntry calendarListEntry : items) {
    System.out.println(calendarListEntry.getSummary());
  }
  pageToken = calendarList.getNextPageToken();
} while (pageToken != null);

Python

Menggunakan library klien Python.

page_token = None
while True:
  calendar_list = service.calendarList().list(pageToken=page_token).execute()
  for calendar_list_entry in calendar_list['items']:
    print calendar_list_entry['summary']
  page_token = calendar_list.get('nextPageToken')
  if not page_token:
    break

PHP

Menggunakan library klien PHP.

$calendarList = $service->calendarList->listCalendarList();

while(true) {
  foreach ($calendarList->getItems() as $calendarListEntry) {
    echo $calendarListEntry->getSummary();
  }
  $pageToken = $calendarList->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $calendarList = $service->calendarList->listCalendarList($optParams);
  } else {
    break;
  }
}

Ruby

Menggunakan library klien Ruby.

page_token = nil
begin
  result = client.list_calendar_lists(page_token: page_token)
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

Cobalah!

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