Belirtilen düzenli etkinliğin örneklerini döndürür. Hemen deneyin veya bir örneği inceleyin.
İ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. Halihazırda giriş yapmış olan 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 |
Kullanımdan kaldırıldı ve yoksayıldı. Gerçek e-posta adresi bulunmasa bile (yani oluşturulan, çalışmayan bir değer sağlanmış olsa bile) düzenleyen, oluşturan ve katılımcı için email alanında bir değer döndürülür.
|
maxAttendees |
integer |
Yanıta dahil edilecek maksimum katılımcı sayısı. Belirtilen katılımcı sayısından 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ı. Değer varsayılan olarak 250 etkinliktir. Sayfa boyutu hiçbir zaman 2.500 etkinlikten büyük olamaz. İsteğe bağlı. |
originalStart |
string |
Örnekteki 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 ile eşittir "cancelled ") sonuca dahil edilip edilmeyeceğini belirler. singleEvents Yanlış değerine ayarlanırsa yinelenen etkinliklerin iptal edilen örnekleri dahil edilir. İsteğe bağlı. False, varsayılan değerdir.
|
timeMax |
datetime |
Bir etkinliğin başlangıç zamanına göre üst sınır (hariç). İsteğe bağlı. Varsayılan ayar, başlangıç zamanına göre filtreleme yapmak değildir. Zorunlu saat dilimi farkına sahip RFC3339 zaman damgası olmalıdır. |
timeMin |
datetime |
Bir etkinliğin bitiş zamanına göre filtreleme için alt sınır (dahil). İsteğe bağlı. Varsayılan ayar, bitiş zamanına göre filtreleme yapmak değildir. Zorunlu saat dilimi farkına sahip 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 |
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#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ştirilme zamanı (RFC3339 zaman damgası olarak). Salt okunur. | |
timeZone |
string |
Takvimin saat dilimi. Salt okunur. | |
accessRole |
string |
Kullanıcının bu takvime yönelik erişim rolü. Salt okunur. Olası değerler:
|
|
defaultReminders[] |
list |
Kimliği doğrulanmış kullanıcının takvimdeki varsayılan hatırlatıcıları. Bu hatırlatıcılar, bu takvimde açıkça geçersiz kılınmayan (ör. reminders.useDefault , Doğru değerine ayarlanmamış) tüm etkinlikler için geçerlidir. |
|
defaultReminders[].method |
string |
Bu hatırlatıcı tarafından kullanılan yöntem. Olası değerler:
Hatırlatıcı eklerken zorunludur. |
yazılabilir |
defaultReminders[].minutes |
integer |
Etkinlik başlamadan önceki, hatırlatıcının tetiklenmesi gereken dakika sayısı. Geçerli değerler 0 ile 40320 arasındadır (dakika cinsinden 4 hafta). Hatırlatıcı eklerken zorunludur. |
yazılabilir |
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 |
Takvimdeki etkinliklerin listesi. | |
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.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ığı 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.
Bu yöntemi canlı verilerde çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın.