Events: list

Belirtilen takvimdeki etkinlikleri 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

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.
İsteğe bağlı sorgu parametreleri
alwaysIncludeEmail boolean Kullanımdan kaldırıldı ve yoksayıldı.
eventTypes string Döndürülecek etkinlik türleri. İsteğe bağlı. Bu parametre, farklı türdeki etkinlikleri döndürmek için birden çok kez tekrarlanabilir. Politika ayarlanmazsa tüm etkinlik türlerini döndürür.

Kabul edilen değerler şunlardır:
  • "default": Düzenli etkinlikler.
  • "focusTime": Odaklanma zamanı etkinlikleri.
  • "fromGmail": Gmail'den etkinlikler.
  • "outOfOffice": Ofis dışında etkinlikleri.
  • "workingLocation": Çalışma yeri etkinlikleri.
iCalUID string Yanıtta sağlanacak iCalendar biçiminde bir etkinlik kimliğini belirtir. İsteğe bağlı. Bir etkinliği iCalendar kimliğine göre aramak istiyorsanız bunu kullanın.
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ı. Oluşturulan sayfadaki etkinlik sayısı bu değerden az olabilir veya sorguyla eşleşen daha fazla etkinlik olsa bile hiç etkinlik olmayabilir. Eksik sayfalar, yanıtta boş olmayan bir nextPageToken alanı tarafından algılanabilir. Varsayılan olarak değer 250 etkinliktir. Sayfa boyutu hiçbir zaman 2.500'den fazla etkinlik olamaz. İsteğe bağlı.
orderBy string Sonuçta döndürülen etkinliklerin sırası. İsteğe bağlı. Varsayılan değer, belirtilmemiş ve sabit bir sıradır.

Kabul edilen değerler şunlardır:
  • "startTime": Başlangıç tarihine/saatine göre (artan) sıralayın. Bu seçenek yalnızca tekli etkinlikleri sorgularken (singleEvents parametresi Doğru değerine ayarlanır) kullanılabilir.
  • "updated": Son değiştirme zamanına göre sırala (artan).
pageToken string Döndürülecek sonuç sayfasını belirten jeton. İsteğe bağlı.
privateExtendedProperty string propertyName=value olarak belirtilen genişletilmiş özellik kısıtlaması. Yalnızca özel mülklerle eşleşir. Bu parametre, verilen tüm kısıtlamalarla eşleşen etkinlikleri döndürmek için birden çok kez tekrarlanabilir.
q string Şu alanlarda bu terimlerle eşleşen etkinlikleri bulmak için serbest metin arama terimleri:
  • summary
  • description
  • location
  • katılımcının displayName
  • katılımcının email
  • düzenleyen kullanıcının displayName
  • düzenleyen kullanıcının email
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

Bu arama terimleri, önceden tanımlanmış anahtar kelimeleri çalışma yeri, ofis dışında durumu ve odaklanma zamanı etkinliklerinin tüm görünen başlığı çevirileriyle de eşleştirir. Örneğin, "Ofis" araması veya "Bureau" araması "Ofis dışında" araması yaparken, officeLocation türündeki çalışma yeri etkinliklerini döndürür veya "Abwesend" ofis dışında etkinliklerini döndürür. İsteğe bağlı.
sharedExtendedProperty string propertyName=value olarak belirtilen genişletilmiş özellik kısıtlaması. Yalnızca paylaşılan tesislerle eşleşir. Bu parametre, verilen tüm kısıtlamalarla eşleşen etkinlikleri döndürmek için birden çok kez tekrarlanabilir.
showDeleted boolean Silinen etkinliklerin sonuca dahil edilip edilmeyeceğini (status ile "cancelled" değerine eşittir). Hem showDeleted hem de singleEvents Yanlış değerine ayarlanırsa yinelenen etkinliklerin iptal edilen örnekleri (ancak temel yinelenen etkinliğin değil) dahil edilir. Hem showDeleted hem de singleEvents Doğru değerine ayarlanırsa silinen etkinliklerin yalnızca tek örnekleri (ancak temel yinelenen etkinlikler değil) döndürülür. İsteğe bağlı. Varsayılan değer, Yanlış'tır.
showHiddenInvitations boolean Sonuca gizli davetiyelerin dahil edilip edilmeyeceğini belirler. İsteğe bağlı. Varsayılan değer, Yanlış'tır.
singleEvents boolean Düzenli etkinliklerin örneklere genişletilip içermeyeceği ve yalnızca tek seferlik etkinliklerin ve düzenli etkinliklerin örneklerinin döndürülüp döndürülmeyeceği (temel tekrarlanan etkinliklerin değil). İsteğe bağlı. Varsayılan değer, Yanlış'tır.
syncToken string nextSyncToken alanından alınan jeton, önceki liste isteğinden sonuçların son sayfasında döndürülen jeton. Bu liste isteğinin sonucunun yalnızca o zamandan sonra değişen girişleri içermesini sağlar. Önceki liste isteğinden bu yana silinen tüm etkinlikler, sonuç kümesinde her zaman yer alır ve showDeleted politikasının Yanlış değerine ayarlanmasına izin verilmez.
İstemci durumunun tutarlılığını sağlamak için nextSyncToken ile birlikte belirtilemeyen birkaç sorgu parametresi vardır.

Bunlar:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
Tanımlanmamış davranıştan kaçınmak için diğer tüm sorgu parametreleri ilk senkronizasyonla aynı olmalıdır. syncToken süresi dolarsa, sunucu bir 410 GONE yanıt koduyla yanıt verir ve istemcinin depolama alanını temizlemesi ve syncToken olmadan tam bir senkronizasyon gerçekleştirmesi gerekir.
Artımlı senkronizasyon hakkında daha fazla bilgi edinin.
İsteğe bağlı. Varsayılan ayar, tüm girişleri döndürmektir.
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ını içeren bir RFC33339 zaman damgası olmalıdır. Örneğin, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milisaniye değeri sağlanabilir ancak yoksayılır. timeMin ayarlanırsa timeMax, timeMin değerinden büyük olmalıdır.
timeMin datetime Etkinliğin filtreleneceği bitiş zamanı için alt sınır (hariç). İsteğe bağlı. Varsayılan olarak bitiş zamanına göre filtreleme yapılmaz. Zorunlu saat dilimi farkını içeren bir RFC33339 zaman damgası olmalıdır. Örneğin, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milisaniye değeri sağlanabilir ancak yoksayılır. timeMax ayarlanırsa timeMin, timeMax değerinden küçük olmalıdır.
timeZone string Yanıtta kullanılan saat dilimi. İsteğe bağlı. Varsayılan olarak takvimin saat dilimi kullanılır.
updatedMin datetime Filtreleme için etkinliğin son değiştirme zamanına (RFC3339 zaman damgası olarak) ait alt sınır. Belirtildiğinde, bu tarihten sonra silinen girişler, showDeleted dikkate alınmaksızın her zaman dahil edilir. İsteğe bağlı. Varsayılan değer, son değiştirme zamanına göre filtreleme yapmamaktı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:
  • "none" - Kullanıcının erişimi yoktur.
  • "freeBusyReader" - Kullanıcı, uygun/meşgul bilgilerine okuma erişimine sahiptir.
  • "reader" - Kullanıcının takvim için okuma erişimi vardır. Gizli etkinlikler, okuyucu erişimi olan kullanıcılara gösterilir ancak etkinlik ayrıntıları gizlenir.
  • "writer" - Kullanıcının takvimde okuma ve yazma erişimi vardır. Gizli etkinlikler, yazma erişimi olan kullanıcılara gösterilir ve etkinlik ayrıntıları gösterilir.
  • "owner" - Takvimin sahipliği kullanıcıya aittir. Bu rol, yazar rolünün tüm izinlerine ek olarak EKL'leri görüntüleyip değiştirme yetkisinin yanı sıra vardır.
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:
  • "email" - Hatırlatıcılar e-postayla gönderilir.
  • "popup" - Hatırlatıcılar, kullanıcı arayüzü pop-up'ı aracılığıyla gönderilir.

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 events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').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().list(calendarId='primary', 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->listEvents('primary');

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->listEvents('primary', $optParams);
  } else {
    break;
  }
}

Ruby

Ruby istemci kitaplığını kullanır.

page_token = nil
begin
  result = client.list_events('primary', 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.