Events: list

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

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ış kullanıcının birincil takvimine erişmek istiyorsanız "primary" anahtar kelimesini kullanın.
İsteğe bağlı sorgu parametreleri
alwaysIncludeEmail boolean Kullanımdan kaldırıldı ve yoksayıldı. Gerçek e-posta adresi bulunmasa bile (ör. oluşturulmuş, çalışmayan bir değer sağlanmış olsa bile) düzenleyen, oluşturan ve katılanlar için email alanında bir değer döndürülür.
eventTypes string Döndürülecek etkinlik türleri. İsteğe bağlı. Olası değerler:
  • "default"
  • "focusTime"
  • "outOfOffice"
  • "workingLocation"
Bu parametre, farklı türlerdeki etkinlikleri döndürmek için birden çok kez tekrarlanabilir. Şu anda bu alan için izin verilen tek değerler şunlardır:
  • ["default", "focusTime", "outOfOffice"]
  • ["default", "focusTime", "outOfOffice", "workingLocation"]
  • ["workingLocation"]
Varsayılan değer ["default", "focusTime", "outOfOffice"]'dir.
Bu dört etkinlik türünün ek kombinasyonları daha sonraki sürümlerde kullanıma sunulacaktır.
iCalUID string Yanıtta sağlanacak iCalendar biçiminde bir etkinlik kimliği belirtir. İsteğe bağlı. Bir etkinliği iCalendar kimliğine göre aramak istiyorsanız bunu kullanın.
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ı. Sonuçta oluşan sayfadaki etkinlik sayısı bu değerden düşük olabilir veya sorguyla eşleşen daha fazla etkinlik olsa bile hiç etkinlik gerçekleşmeyebilir. Eksik sayfalar, yanıttaki boş olmayan nextPageToken alanı tarafından algılanabilir. Değer varsayılan olarak 250 etkinliktir. Sayfa boyutu hiçbir zaman 2.500 etkinlikten büyük olamaz. İsteğe bağlı.
orderBy string Sonuçta döndürülen etkinliklerin sırası. İsteğe bağlı. Varsayılan olarak belirtilmemiş ve kararlı bir sıralama söz konusudur.

Kabul edilen değerler şunlardır:
  • "startTime": Başlangıç tarihi/saatine göre sıralama (artan). Bu özellik yalnızca tek tek etkinlikler sorgulanırken (yani, singleEvents parametresi Doğru değerine ayarlandığında) kullanılabilir
  • "updated": Son değiştirme zamanına göre sıralama (artan).
pageToken string Döndürülecek sonuç sayfasını belirten jeton. İsteğe bağlı.
privateExtendedProperty string Genişletilmiş özellik kısıtlaması propertyName=value olarak belirtilir. Yalnızca gizli mülklerle eşleşir. Bu parametre, belirtilen 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 ücretsiz metin arama terimleri: summary, description, location, katılımcının displayName, katılımcının email. İsteğe bağlı.
sharedExtendedProperty string Genişletilmiş özellik kısıtlaması propertyName=value olarak belirtilir. Yalnızca paylaşılan tesislerle eşleşir. Bu parametre, belirtilen tüm kısıtlamalarla eşleşen etkinlikleri döndürmek için birden çok kez tekrarlanabilir.
showDeleted boolean Silinen etkinliklerin (status ile eşittir "cancelled") sonuca dahil edilip edilmeyeceğini belirtir. showDeleted ve singleEvents False (Yanlış) değerine sahipse yinelenen düzenli etkinliklerin iptal edilmiş örnekleri dahil edilir ancak temeldeki yinelenen etkinlik bu kapsamda yer almaz. Hem showDeleted hem de singleEvents Doğruysa yalnızca silinmiş etkinliklerin tek bir örneği döndürülür (ancak temeldeki yinelenen etkinlikleri döndürmez). İsteğe bağlı. Varsayılan, False değeridir.
showHiddenInvitations boolean Sonuca gizli davetiyeler eklenip eklenmemesi. İsteğe bağlı. Varsayılan, False değeridir.
singleEvents boolean Yinelenen etkinliklerin örneklere genişletilip genişletilmeyeceği ve yalnızca tek seferlik etkinliklerin ve yinelenen etkinliklerin örneklerini döndürüp temel olarak yinelenen etkinliklerin değil mi döndürüleceği. İsteğe bağlı. Varsayılan, False değeridir.
syncToken string nextSyncToken alanından alınan jeton, önceki liste isteğindeki sonuçların son sayfasında döndürüldü. Bu liste isteğinin yalnızca o zamandan beri değişen girişleri içermesini sağlar. Önceki liste isteğinden bu yana silinen tüm etkinlikler her zaman sonuç grubunda yer alır ve showDeleted parametresinin False (Yanlış) değerine ayarlanmasına izin verilmez.
İstemci durumunun tutarlı olmasını sağlamak için nextSyncToken ile birlikte belirtilemeyen birkaç sorgu parametresi bulunur.

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'nın süresi dolarsa sunucu 410 GONE yanıt koduyla yanıt verir ve istemci depolama alanını temizlemeli ve syncToken olmadan tam senkronizasyon gerçekleştirmelidir.
Artımlı senkronizasyon hakkında daha fazla bilgi edinin.
İsteğe bağlı. Varsayılan olarak tüm girişler döndürülür.
timeMax datetime Bir etkinliğin filtreleneceği başlangıç zamanı için üst sınır (hariç). İsteğe bağlı. Varsayılan değer, başlangıç zamanına göre filtreleme yapmak değildir. Zorunlu saat dilimi farkının RFC3339 zaman damgası olması gerekir (ör. 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 Bir etkinliğin bitiş zamanının filtreleneceği 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ın RFC3339 zaman damgası olması gerekir (ör. 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 değer, takvimin saat dilimidir.
updatedMin datetime Filtreleme ölçütü olarak bir etkinliğin son değiştirme zamanının (RFC3339 zaman damgası olarak) alt sınırı. Belirtildiğinde, bu tarihten itibaren silinen girişler showDeleted bağımsız olarak dahil edilir. İsteğe bağlı. Varsayılan ayar, son değişiklik zamanına göre filtreleme yapmak değildir.

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 için kimlik doğrulama ve yetkilendirme sayfasına bakın.

İstek içeriği

Bu yöntemle 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 takvim için erişim rolü. Salt okunur. Olası değerler:
  • "none": Kullanıcının erişimi yok.
  • "freeBusyReader": Kullanıcının uygun/meşgul bilgilerine okuma erişimi vardır.
  • "reader": Kullanıcının takvime okuma erişimi vardır. Özel 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. Özel etkinlikler, yazar erişimi olan kullanıcılara görünür ve etkinlik ayrıntıları görünür.
  • "owner": Kullanıcı, takvimin sahibidir. Bu rol, EKL rolünü görme ve değiştirme yetkisinin yanı sıra yazar rolündeki tüm izinlere sahiptir.
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ılmayan (yani, reminders.useDefault özelliği 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'ı aracılığıyla gönderilir.

Hatırlatıcı eklerken gereklidir.

 yazılabilir
defaultReminders[].minutes integer Hatırlatıcının tetikleneceği etkinliğin başlangıcından önceki dakika sayısı. Geçerli değerler 0 ile 40320 arasındadır (dakika cinsinden 4 hafta).

Hatırlatıcı eklerken gereklidir.

 yazılabilir
nextPageToken string Bu sonucun sonraki sayfasına erişmek için kullanılan jeton. Başka sonuç yoksa (varsa) nextSyncToken sağlanmaz.
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 sonra kullanılan bir jeton. Başka sonuçlar varsa (varsa) nextPageToken çıkarılı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

2.999

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ığı 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.

Bu yöntemi canlı verilerde çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın.