CalendarList: list

Kullanıcının takvim listesindeki takvimleri döndürür. Şimdi deneyin veya bir örneğe göz atın.

İstek

HTTP isteği

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

Parametreler

Parametre adı Değer Açıklama
İsteğe bağlı sorgu parametreleri
maxResults integer Bir sonuç sayfasında döndürülen maksimum giriş sayısı. Varsayılan olarak bu değer 100 giriştir. Sayfa boyutu hiçbir zaman 250'den fazla giriş olamaz. İsteğe bağlı.
minAccessRole string Döndürülen girişlerdeki kullanıcının minimum erişim rolü. İsteğe bağlı. Varsayılan olarak herhangi bir kısıtlama yoktur.

Kabul edilen değerler şunlardır:
  • "freeBusyReader": Kullanıcı uygun/meşgul bilgilerini okuyabilir.
  • "owner": Kullanıcı etkinlikleri okuyabilir, değiştirebilir ve kontrol listelerine erişebilir.
  • "reader": Kullanıcı, gizli olmayan etkinlikleri okuyabilir.
  • "writer": Kullanıcı, etkinlikleri okuyabilir ve değiştirebilir.
pageToken string Döndürülecek sonuç sayfasını belirten jeton. İsteğe bağlı.
showDeleted boolean Silinen takvim listesi girişlerinin sonuca dahil edilip edilmeyeceğini belirler. İsteğe bağlı. Varsayılan değer, Yanlış'tır.
showHidden boolean Gizli girişlerin gösterilip gösterilmeyeceğini belirler. İsteğe bağlı. Varsayılan değer, Yanlış'tır.
syncToken string nextSyncToken alanından alınan jeton, önceki liste isteğinden sonuçların son sayfasında döndürülen jeton. Bu liste isteğinin sonucunun yalnızca o zamandan sonra değişen girişleri içermesini sağlar. Takvim özellikleri veya EKL'ler gibi salt okunur alanlar değiştiyse giriş döndürülmez. Önceki liste isteğinden bu yana silinen ve gizlenen tüm girişler, her zaman sonuç kümesinde yer alır. showDeleted ve showHidden öğelerinin de Yanlış olarak ayarlanmasına izin verilmez.
İstemci durumu tutarlılığını sağlamak için minAccessRole sorgu parametresi, nextSyncToken ile birlikte belirtilemez.
syncToken süresi dolarsa, sunucu 410 GONE yanıt koduyla yanıt verir ve istemcinin depolama alanını temizlemesi ve syncToken olmadan tam senkronizasyon gerçekleştirmesi gerekir.
Artımlı senkronizasyon hakkında daha fazla bilgi edinin.
İsteğe bağlı. Varsayılan ayar, tüm girişleri döndürmektir.

Yetkilendirme

Bu istek, aşağıdaki kapsamların en az biriyle yetkilendirme gerektiriyor:

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

Daha fazla bilgi edinmek için kimlik doğrulama ve yetkilendirme sayfasına göz atın.

İstek içeriği

Bu yöntemle istek gövdesi sağlamayın.

Yanıt

Başarılı olursa bu yöntem, aşağıdaki yapıya sahip bir yanıt gövdesi döndürür:

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Mülk adı Değer Açıklama Notlar
kind string Koleksiyonun türü ("calendar#calendarList").
etag etag Koleksiyonun eTag'i.
nextPageToken string Bu sonucun sonraki sayfasına erişmek için kullanılan jeton. Başka sonuç yoksa atlanır. Bu durumda nextSyncToken sağlanır.
items[] list Kullanıcının takvim listesinde bulunan takvimler.
nextSyncToken string Daha sonra, yalnızca bu sonucun döndürülmesinden bu yana değişen girişleri almak için kullanılan jeton. Başka sonuçlar varsa atlanır. Bu durumda nextPageToken sağlanır.

Örnekler

Not: Bu yöntem için kullanıma sunulan kod örnekleri, desteklenen tüm programlama dillerini kapsamaz (Desteklenen dillerin listesi için istemci kitaplıkları sayfasını inceleyin).

Java

Java istemci kitaplığını kullanır.

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

Python istemci kitaplığını kullanır.

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

PHP istemci kitaplığını kullanır.

$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

Ruby istemci kitaplığını kullanır.

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?

Deneyin!

Canlı verilerde bu yöntemi çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın.