Belirtilen düzenli etkinliğin örneklerini 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/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 kullanın. Şu anda giriş yapmış olan kullanıcının birincil takvimine erişmek istiyorsanız "primary " bağlantısını kullanın. anahtar kelime.
|
eventId |
string |
Yinelenen etkinlik tanımlayıcısı. |
İsteğe bağlı sorgu parametreleri | ||
alwaysIncludeEmail |
boolean |
Kullanımdan kaldırıldı ve yoksayıldı. Gerçek bir e-posta adresi olmasa bile düzenleyen, oluşturan ve katılımcılar için her zaman email alanında bir değer döndürülür (ör. oluşturulmuş, çalışmayan bir değer sağlanır).
|
maxAttendees |
integer |
Yanıta eklenecek 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 olarak değer 250 etkinliktir. Sayfa boyutu hiçbir zaman 2.500'den fazla etkinlik olamaz. İsteğe bağlı. |
originalStart |
string |
Sonuçtaki ö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 sonuca dahil edilip edilmeyeceğini (status ile "cancelled " değerine eşittir). singleEvents , Yanlış değerine ayarlanırsa yinelenen etkinliklerin iptal edilen örnekleri yine dahil edilir. İsteğe bağlı. Varsayılan değer, Yanlış'tır.
|
timeMax |
datetime |
Etkinliğin filtreleneceği başlangıç zamanı için üst sınır (hariç). İsteğe bağlı. Varsayılan olarak başlangıç zamanına göre filtreleme yapılmaz. Zorunlu saat dilimi farkına sahip bir RFC33339 zaman damgası olmalıdır. |
timeMin |
datetime |
Etkinliğin filtreleneceği 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ına sahip bir RFC33339 zaman damgası olmalıdır. |
timeZone |
string |
Yanıtta kullanılan saat dilimi. İsteğe bağlı. Varsayılan olarak takvimin saat dilimi kullanılır. |
Yetkilendirme
Bu istek, aşağıdaki kapsamların en az biriyle yetkilendirme sağlar:
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 |
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#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'i. | |
summary |
string |
Takvimin başlığı. Salt okunur. | |
description |
string |
Takvimin açıklaması. Salt okunur. | |
updated |
datetime |
Takvimin son değiştirme zamanı (RFC3339 zaman damgası olarak). Salt okunur. | |
timeZone |
string |
Takvimin saat dilimi. Salt okunur. | |
accessRole |
string |
Kullanıcının bu takvime erişim rolü. Salt okunur. Olası değerler:
|
|
defaultReminders[] |
list |
Kimliği doğrulanmış kullanıcı için takvimdeki varsayılan hatırlatıcılar. Bu hatırlatıcılar, açık bir şekilde geçersiz kılınmayan (reminders.useDefault True (Doğru) değerine ayarlanmamış olan) 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 zorunludur. |
yazılabilir |
defaultReminders[].minutes |
integer |
Etkinlik başlamadan önce hatırlatıcının tetiklenmesi gereken dakika sayısı. Geçerli değerler 0 ile 40.320 (dakika cinsinden 4 hafta) arasındadır. Hatırlatıcı eklerken zorunludur. |
yazılabilir |
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 |
Takvimdeki etkinliklerin listesi. | |
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.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.