CalendarList: list

Kullanıcının takvim listesindeki takvimleri döndürür. Hemen deneyin veya bir örneği inceleyin.

İ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ı. Değer varsayılan olarak 100 giriştir. Sayfa boyutu hiçbir zaman 250 girişten büyük olamaz. İsteğe bağlı.
minAccessRole string Döndürülen girişlerde kullanıcı için minimum erişim rolü. İsteğe bağlı. Varsayılan ayar bir kısıtlama değildir.

Kabul edilen değerler şunlardır:
  • "freeBusyReader": Kullanıcı uygun/meşgul bilgilerini okuyabilir.
  • "owner": Kullanıcı, etkinlikleri okuyup 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 eklenip eklenmeyeceğini belirtir. İsteğe bağlı. False, varsayılan değerdir.
showHidden boolean Gizli girişlerin gösterilip gösterilmeyeceği. İsteğe bağlı. False, varsayılan değerdir.
syncToken string nextSyncToken alanından alınan jeton, önceki liste isteğinden sonuçların son sayfasında döndürülür. Bu işlem, bu liste isteğinin sonucunun yalnızca o tarihten bu yana değişen girişleri içermesini sağlar. Yalnızca 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ç grubunda yer alır ve showDeleted öğesinin showHidden olarak Yanlış değerine 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 istemci depolama alanını temizlemeli ve syncToken olmadan tam senkronizasyon gerçekleştirmelidir.
Artımlı senkronizasyon hakkında daha fazla bilgi edinin.
İsteğe bağlıdır. Varsayılan değer tüm girişleri döndürmektir.

Yetkilendirme

Bu istek, aşağıdaki kapsamlardan 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ını inceleyin.

İstek metni

Bu yöntemi içeren bir 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 Jeton, bu sonucun sonraki sayfasına erişmek için kullanıldı. Başka sonuç yoksa bu durumda yoksayılır, bu durumda nextSyncToken sağlanır.
items[] list Kullanıcının takvim listesinde bulunan takvimler.
nextSyncToken string Jeton daha sonra, bu sonucun döndürülmesinden sonra değişen girişleri almak için kullanılır. Daha fazla sonuç varsa yoksayılı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ığı 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.

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