Events: list

Belirtilen takvimdeki etkinlikleri döndürür. Şimdi deneyin.

İ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. Şu anda oturum açmış 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ı.
eventTypes string Döndürülecek etkinlik türleri. İsteğe bağlıdır. Bu parametre, farklı türlerdeki etkinlikleri döndürmek için birden fazla kez tekrarlanabilir. Ayarlanmamışsa tüm etkinlik türlerini döndürür.

Kabul edilen değerler şunlardır:
  • "birthday": Yıllık olarak tekrarlanan, tüm gün süren özel etkinlikler.
  • "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ıtla birlikte sağlanacak iCalendar biçimindeki bir etkinlik kimliğini belirtir. İsteğe bağlıdır. Bir etkinliği iCalendar kimliğine göre aramak istiyorsanız bunu kullanın.
maxAttendees integer Yanıtın dahil edilecek maksimum katılımcı sayısı. Belirtilen sayıda katılımcıdan fazla varsa yalnızca katılımcı döndürülür. İsteğe bağlıdır.
maxResults integer Bir sonuç sayfasında döndürülen maksimum etkinlik sayısı. Sorguyla eşleşen daha fazla etkinlik olsa bile sonuç sayfasındaki etkinlik sayısı bu değerden daha az olabilir veya hiç etkinlik olmayabilir. Eksik sayfalar, yanıttaki boş olmayan bir nextPageToken alanı tarafından algılanabilir. Varsayılan olarak bu değer 250 etkinliktir. Sayfa boyutu hiçbir zaman 2.500 etkinlikten büyük olamaz. İsteğe bağlıdır.
orderBy string Sonuçta döndürülen etkinliklerin sırası. İsteğe bağlıdır. Varsayılan olarak belirtilmemiş, sabit bir sıra kullanılır.

Kabul edilen değerler şunlardır:
  • "startTime": Başlangıç tarihine/saatine göre (artan) sıralayın. Bu özellik yalnızca tek etkinlikler sorgulanırken kullanılabilir (ör. singleEvents parametresi True olduğunda)
  • "updated": Son değiştirilme zamanına göre (artan) sırala.
pageToken string Hangi sonuç sayfasının döndürüleceğini belirten jeton. İsteğe bağlıdır.
privateExtendedProperty string propertyName=value olarak belirtilen genişletilmiş özellik kısıtlaması. Yalnızca özel özelliklerle eşleşir. Bu parametre, belirtilen tüm kısıtlamalarla eşleşen etkinlikleri döndürmek için birden fazla kez tekrarlanabilir.
q string Aşağıdaki 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üzenleyenin displayName
  • düzenleyenin email
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

Bu arama terimleri, çalışma konumu, ofis dışında ve odaklanma zamanı etkinliklerinin tüm görüntüleme başlığı çevirilerinde önceden tanımlanmış anahtar kelimelerle de eşleşir. Örneğin, "Ofis" veya "Bureau" araması officeLocation türündeki çalışma yeri etkinliklerini döndürürken "Ofis dışında" veya "Abwesend" araması ofis dışında etkinliklerini döndürür. İsteğe bağlıdır.
sharedExtendedProperty string propertyName=value olarak belirtilen genişletilmiş özellik kısıtlaması. Yalnızca paylaşılan özelliklerle eşleşir. Bu parametre, belirtilen tüm kısıtlamalarla eşleşen etkinlikleri döndürmek için birden fazla kez tekrarlanabilir.
showDeleted boolean Silinen etkinliklerin (status değeri "cancelled" olan) sonuca dahil edilip edilmeyeceği. Yinelenen etkinliklerin iptal edilen örnekleri (ancak temel yinelenen etkinlik değil), showDeleted ve singleEvents özellikleri False ise yine de dahil edilir. showDeleted ve singleEvents değerleri doğruysa yalnızca silinen etkinliklerin tek seferlik örnekleri (ancak temel alınan düzenli etkinlikler değil) döndürülür. İsteğe bağlıdır. Varsayılan değer False'tur.
showHiddenInvitations boolean Gizli davetlerin sonuca dahil edilip edilmeyeceği. İsteğe bağlıdır. Varsayılan değer False'tur.
singleEvents boolean Düzenli etkinliklerin örnekler halinde genişletilip genişletilmeyeceği ve yalnızca tek seferlik etkinliklerin ve düzenli etkinliklerin örneklerinin döndürülüp döndürülmeyeceği (ancak temel düzenli etkinliklerin kendilerinin döndürülmeyeceği). İsteğe bağlıdır. Varsayılan değer False'tur.
syncToken string Önceki liste isteğinden elde edilen sonuçların son sayfasında döndürülen nextSyncToken alanından alınan jeton. Bu, liste isteğinin sonucunun 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ç kümesinde yer alır ve showDeleted değerinin False olarak ayarlanmasına izin verilmez.
İstemci durumunun tutarlılığını sağlamak için nextSyncToken ile birlikte belirtilemeyen çeşitli sorgu parametreleri vardır.

Bunlar:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
Tanımsız davranışlardan kaçınmak için diğer tüm sorgu parametreleri ilk senkronizasyonla aynı olmalıdır. syncToken süresi dolarsa sunucu 410 GONE yanıt koduyla karşılık verir ve istemci, depolama alanını temizleyip syncToken olmadan tam senkronizasyon gerçekleştirir. Artımlı senkronizasyon hakkında
daha fazla bilgi edinin.
İsteğe bağlıdır. Varsayılan olarak tüm girişler döndürülür.
timeMax datetime Filtrelemek için etkinliğin başlangıç zamanının üst sınırı (hariç). İsteğe bağlıdır. Varsayılan olarak başlangıç zamanına göre filtreleme yapılmaz. Zorunlu saat dilimi uzaklığına sahip bir RFC3339 zaman damgası olmalıdır. Örneğin, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milisaniye belirtilebilir ancak yoksayılır. timeMin ayarlanmışsa timeMax, timeMin değerinden büyük olmalıdır.
timeMin datetime Filtreleme için bir etkinliğin bitiş zamanının alt sınırı (hariç). İsteğe bağlıdır. Varsayılan olarak bitiş zamanına göre filtreleme yapılmaz. Zorunlu saat dilimi uzaklığına sahip bir RFC3339 zaman damgası olmalıdır. Örneğin, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milisaniye belirtilebilir ancak yoksayılır. timeMax ayarlanmışsa timeMin, timeMax değerinden küçük olmalıdır.
timeZone string Yanıtta kullanılan saat dilimi. İsteğe bağlıdır. Varsayılan olarak takvimin saat dilimi kullanılır.
updatedMin datetime Filtrelemek için bir etkinliğin son değiştirilme zamanının (RFC3339 zaman damgası olarak) alt sınırı. Belirtilmesi halinde, bu zamandan beri silinen girişler showDeleted'dan bağımsız olarak her zaman dahil edilir. İsteğe bağlıdır. Varsayılan olarak son değiştirilme zamanına göre filtreleme yapılmaz.

Yetkilendirme

Bu istek, aşağıdaki kapsamların en az biriyle yetkilendirmeye olanak tanır:

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
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

Daha fazla bilgi için kimlik doğrulama ve yetkilendirme sayfasına bakı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ştirilme zamanı (RFC3339 zaman damgası olarak). Salt okunur.
timeZone string Takvimin saat dilimi Salt okunur.
accessRole string Kullanıcının bu takvimdeki 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ının takvime 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ı, takvime okuma ve yazma erişimine sahiptir. Yazma erişimi olan kullanıcılar, gizli etkinlikleri ve etkinlik ayrıntılarını görebilir.
  • "owner": Kullanıcı, takvime yönetici erişimine sahiptir. Bu rol, yazar rolünün tüm izinlerine ek olarak diğer kullanıcıların erişim düzeylerini görme ve değiştirme özelliğine sahiptir.

defaultReminders[] list Kimliği doğrulanmış kullanıcının takvimindeki varsayılan hatırlatıcılar. Bu hatırlatıcılar, bu takvimdeki açıkça geçersiz kılınmayan (ör. reminders.useDefault değeri "Doğru" olarak ayarlanmamış) tüm etkinlikler için geçerlidir.
defaultReminders[].method string Bu hatırlatıcı tarafından kullanılan yöntem. Olası değerler:
  • "email": Hatırlatmalar e-postayla gönderilir.
  • "popup": Hatırlatmalar, kullanıcı arayüzünde pop-up olarak gönderilir.

Hatırlatıcı eklerken gereklidir.

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

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 atlanır. Bu durumda nextSyncToken sağlanır.
items[] list Takvimdeki etkinliklerin listesi.
nextSyncToken string Bu sonuç döndürüldükten sonra değişen girişleri almak için daha sonra kullanılan jeton. Daha fazla sonuç varsa atlanır. Bu durumda nextPageToken sağlanır.

Deneyin.

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