Events: instances

Belirtilen düzenli etkinliğin örneklerini döndürür. Hemen 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 çağırın. Oturum açmış 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 bir e-posta adresi olmasa bile (yani oluşturulmuş, çalışmayan bir değer sağlanacak) etkinliği düzenleyen, oluşturan ve katılımcılar için email alanında her zaman bir değer döndürülü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 olarak bu değer 250 etkinliktir. Sayfa boyutu hiçbir zaman 2.500 etkinlikten büyük 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 Sonuca silinen etkinliklerin (status ile "cancelled" eşittir) eklenip eklenmeyeceğini belirtir. singleEvents Yanlış değerine ayarlanırsa yinelenen etkinliklerin iptal edilmiş örnekleri dahil edilir. İsteğe bağlı. Varsayılan, Yanlış değeridir.
timeMax datetime Etkinlik filtrelemenin 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 RFC3339 zaman damgası olmalıdır.
timeMin datetime Etkinliğin filtreleme ölçütü olarak kullanılacak bitiş zamanının alt sınırı (dahil). İsteğe bağlı. Bitiş zamanına göre filtreleme yapılmaz. Zorunlu saat dilimi farkına sahip bir RFC3339 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 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 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.
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 Bu takvim için kullanıcının erişim rolü. Salt okunur. Olası değerler:
  • "none" - Kullanıcının erişimi yok.
  • "freeBusyReader" - Kullanıcı, uygun/meşgul bilgilerine okuma erişimine sahiptir.
  • "reader" - Kullanıcı takvim için okuma erişimine sahiptir. Gizli etkinlikler, okuyucu erişimi olan kullanıcılara gösterilir ancak etkinlik ayrıntıları gizlenir.
  • "writer" - Kullanıcının takvim için okuma ve yazma erişimi vardır. Gizli etkinlikler, yazar erişimi olan kullanıcılara gösterilir. Etkinlik ayrıntıları ise görünür olur.
  • "owner": Takvimin sahibi kullanıcıdır. Bu rol, yazar rolünün tüm izinlerine sahiptir. Ek olarak, EKL'leri görebilir ve değiştirebilir.
defaultReminders[] list Kimliği doğrulanan kullanıcı için takvimdeki varsayılan hatırlatıcılar. Bu hatırlatıcılar, bu takvimde onları açıkça geçersiz kılmayan (yani, reminders.useDefault değeri Doğru değerine ayarlanmamış) tüm etkinlikler için geçerlidir.
defaultReminders[].method string Bu hatırlatıcının kullandığı yöntem. Olası değerler:
  • "email" - Hatırlatıcılar e-postayla gönderilir.
  • "popup" - Hatırlatıcılar, kullanıcı arayüzü pop-up'ı yoluyla gönderilir.

Hatırlatıcı eklerken zorunludur.

yazılabilir
defaultReminders[].minutes integer Etkinlik başlamadan kaç dakika önce hatırlatıcı tetikleneceğini belirtir. Geçerli değerler 0 ile 40.320 arasındadır (dakika cinsinden 4 hafta).

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 Jeton, yalnızca bu sonuç döndürüldükten sonra değişen girişleri almak için daha sonra kullanılır. Kullanılabilir başka sonuçlar varsa atlanır. Burada 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ı kullanmalıdı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.

Aşağıdaki API Gezgini'ni kullanarak canlı verilerde bu yöntemi çağırın ve yanıtı görün.