Kullanıcının takvim listesinde bulunan takvimleri döndürür. Hemen deneyin veya örneke 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 değer 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şlerdeki kullanıcı için minimum erişim rolü. İsteğe bağlı. Varsayılan olarak kısıtlama yoktur.
Kabul edilen değerler şunlardır:
|
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 belirtir. İsteğe bağlı. Varsayılan değer False'tır. |
showHidden |
boolean |
Gizli girişlerin gösterilip gösterilmeyeceği. İsteğe bağlı. Varsayılan değer False'tır. |
syncToken |
string |
Önceki liste isteğinden elde edilen sonuçların son sayfasında döndürülen nextSyncToken alanından alınan jeton. Bu liste isteği sonucunda yalnızca o tarihten sonra değişen girişler gösterilir. Yalnızca takvim özellikleri veya ACL'ler gibi salt okunur alanlar değiştiyse giriş döndürülmez. Önceki liste isteğinden sonra silinen ve gizlenen tüm girişler her zaman sonuç kümesinde olur ve showDeleted veya showHidden değerinin False olarak ayarlanmasına izin verilmez. İstemci durumu tutarlılığını sağlamak için minAccessRole sorgu parametresi nextSyncToken ile birlikte belirtilemez. syncToken 'ın süresi dolarsa sunucu 410 GİTTİ yanıt koduyla yanıt verir ve istemci, depolama alanını temizleyip syncToken olmadan tam senkronizasyon yapmalıdır. Artımlı senkronizasyon hakkında daha fazla bilgi edinin. İsteğe bağlı. Varsayılan olarak tüm girişler döndürülür. |
Yetkilendirme
Bu istek için aşağıdaki kapsamlardan en az biri ile yetkilendirme gerekir:
Kapsam |
---|
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 |
Daha fazla bilgi için kimlik doğrulama ve yetkilendirme sayfasına bakın.
İstek içeriği
Bu yöntemle istek gövdesi sağlamayınız.
Yanıt
Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt metni 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'ı. | |
nextPageToken |
string |
Bu sonucun bir 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 |
Bu sonuç döndürüldükten sonra yalnızca değişen girişleri almak için daha sonraki bir zamanda 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.