Belirtilen düzenli etkinliğin örneklerini döndürür. Hemen deneyin veya örneke göz atın.
İstek
HTTP isteği
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
Parametreler
Parametre adı | Değer | Açıklama |
---|---|---|
Yol parametreleri | ||
calendarId |
string |
Takvim tanımlayıcısı. Takvim kimliklerini almak için calendarList.list yöntemini çağırın. Şu anda oturum açmış kullanıcının birincil takvimine erişmek istiyorsanız "primary " anahtar kelimesini kullanın.
|
eventId |
string |
Düzenli etkinlik tanımlayıcısı. |
İsteğe bağlı sorgu parametreleri | ||
alwaysIncludeEmail |
boolean |
Desteği sonlandırıldı ve yoksayıldı. Gerçek bir e-posta adresi olmasa bile düzenleyen, içerik üretici ve katılımcılar için email alanında her zaman bir değer döndürülür (yani oluşturulan, çalışmayan bir değer sağlanır).
|
maxAttendees |
integer |
Yanıta dahil edilecek maksimum katılımcı sayısı. Belirtilen sayıdan fazla katılımcı varsa yalnızca katılımcı döndürülür. İsteğe bağlı. |
maxResults |
integer |
Bir sonuç sayfasında döndürülen maksimum etkinlik sayısı. Varsayılan değer 250 etkinliktir. Sayfa boyutu hiçbir zaman 2.500 etkinlikten büyük olamaz. İsteğe bağlı. |
originalStart |
string |
Sonuçta örneğin orijinal başlangıç zamanı. İsteğe bağlı. |
pageToken |
string |
Döndürülecek sonuç sayfasını belirten jeton. İsteğe bağlı. |
showDeleted |
boolean |
Silinen etkinliklerin (status "cancelled " değerine eşit olduğunda) sonuca dahil edilip edilmeyeceği. singleEvents False ise yinelenen etkinliklerin iptal edilen örnekleri yine dahil edilir. İsteğe bağlı. Varsayılan değer False'tır.
|
timeMax |
datetime |
Filtre uygulanacak bir etkinliğin başlangıç zamanı için üst sınır (hariç). İsteğe bağlı. Varsayılan olarak başlangıç saatine göre filtreleme yapılmaz. Zorunlu saat dilimi farkı içeren bir RFC3339 zaman damgası olmalıdır. |
timeMin |
datetime |
Filtrelemek için bir etkinliğin bitiş zamanı için alt sınır (dahil). İsteğe bağlı. Varsayılan olarak bitiş zamanına göre filtreleme yapılmaz. Zorunlu saat dilimi farkı içeren bir RFC3339 zaman damgası olmalıdır. |
timeZone |
string |
Yanıtta kullanılan saat dilimi. İsteğe bağlı. Varsayılan ayar, takvimin saat dilimidir. |
Yetkilendirme
Bu istek, aşağıdaki kapsamlardan en az biriyle yetkilendirmeye izin verir:
Kapsam |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.freebusy |
https://www.googleapis.com/auth/calendar.events.owned |
https://www.googleapis.com/auth/calendar.events.owned.readonly |
https://www.googleapis.com/auth/calendar.events.public.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#events", "etag": etag, "summary": string, "description": string, "updated": datetime, "timeZone": string, "accessRole": string, "defaultReminders": [ { "method": string, "minutes": integer } ], "nextPageToken": string, "nextSyncToken": string, "items": [ events Resource ] }
Mülk adı | Değer | Açıklama | Notlar |
---|---|---|---|
kind |
string |
Koleksiyonun türü ("calendar#events "). |
|
etag |
etag |
Koleksiyonun ETag'ı. | |
summary |
string |
Takvim başlığı. Salt okunur. | |
description |
string |
Takvim açıklaması. Salt okunur. | |
updated |
datetime |
Takvimde son değişiklik zamanı (RFC3339 zaman damgası olarak). Salt okunur. | |
timeZone |
string |
Takvimin saat dilimi. Salt okunur. | |
accessRole |
string |
Kullanıcının bu takvim için erişim rolü. Salt okunur. Olası değerler:
|
|
defaultReminders[] |
list |
Kimliği doğrulanmış kullanıcının takvimindeki varsayılan hatırlatıcılar. Bu hatırlatıcılar, bu takvimdeki açıkça geçersiz kılmadıkları (yani reminders.useDefault değeri True olarak ayarlanmamış) tüm etkinlikler için geçerlidir. |
|
defaultReminders[].method |
string |
Bu hatırlatıcının kullandığı yöntem. Olası değerler:
Hatırlatıcı eklerken gereklidir. |
yazılabilir |
defaultReminders[].minutes |
integer |
Hatırlatıcının etkinlikten kaç dakika önce tetiklenmesi gerektiğini belirtir. Geçerli değerler 0 ile 40.320 (dakikada 4 hafta) arasındadır. Hatırlatıcı eklerken gereklidir. |
yazılabilir |
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 |
Takvimdeki etkinliklerin listesi. | |
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.Event; import com.google.api.services.calendar.model.Events; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over the instances of a specific recurring event String pageToken = null; do { Events events = service.events().instances('primary', 'eventId').setPageToken(pageToken).execute(); List<Event> items = events.getItems(); for (Event event : items) { System.out.println(event.getSummary()); } pageToken = events.getNextPageToken(); } while (pageToken != null);
Python
Python istemci kitaplığını kullanır.
page_token = None while True: events = service.events().instances(calendarId='primary', eventId='eventId', pageToken=page_token).execute() for event in events['items']: print event['summary'] page_token = events.get('nextPageToken') if not page_token: break
PHP
PHP istemci kitaplığını kullanır.
$events = $service->events->instances('primary', "eventId"); while(true) { foreach ($events->getItems() as $event) { echo $event->getSummary(); } $pageToken = $events->getNextPageToken(); if ($pageToken) { $optParams = array('pageToken' => $pageToken); $events = $service->events->instances('primary', "eventId", $optParams); } else { break; } }
Ruby
Ruby istemci kitaplığını kullanır.
page_token = nil begin result = client.list_event_instances('primary', 'eventId') 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.