Belirtilen takvimdeki etkinlikleri 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
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 " 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ı. Bu parametre, farklı türlerdeki etkinlikleri döndürmek için birden çok kez tekrarlanabilir. Ayarlanmazsa tüm etkinlik türlerini döndürür.
Kabul edilen değerler şunlardı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 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ı. Sorguyla eşleşen daha fazla etkinlik olsa bile, sonuçta gösterilen sayfadaki etkinliklerin sayısı bu değerden az olabilir veya hiç olmayabilir. Eksik sayfalar, yanıttaki boş olmayan bir nextPageToken alanı ile 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ı.
|
orderBy |
string |
Sonuçta döndürülen etkinliklerin sırası. İsteğe bağlı. Varsayılan değer belirtilmemiş, sabit bir sıradır.
Kabul edilen değerler şunlardır:
|
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 ö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 |
Aşağıdaki alanlarda bulunan bu terimlerle eşleşen etkinlikleri bulmak için kullanabileceğiniz serbest metin arama terimleri:
Bu arama terimleri, önceden tanımlanmış anahtar kelimeleri çalışma yeri, ofis dışında ve odaklanma zamanı etkinliklerinin tüm görünen başlık çevirileriyle de eşleştirir. Örneğin, "Ofis" veya "Büro" araması |
sharedExtendedProperty |
string |
Genişletilmiş özellik kısıtlaması propertyName=value olarak belirtilir. Yalnızca paylaşılan 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. |
showDeleted |
boolean |
Sonuca silinen etkinliklerin dahil edilip edilmeyeceği (status ile "cancelled " değerine eşittir). showDeleted ve singleEvents Yanlış değerine ayarlanırsa yinelenen etkinliklerin iptal edilmiş örnekleri (ancak temel yinelenen etkinlik değil) yine de dahil edilir. Hem showDeleted hem de singleEvents Doğru değerine ayarlanırsa silinen etkinliklerin yalnızca tekli örnekleri döndürülür (temel yinelenen etkinlikleri değil) döndürülür. İsteğe bağlı. Varsayılan, Yanlış'tır.
|
showHiddenInvitations |
boolean |
Sonuca gizli davetiyelerin dahil edilip edilmeyeceği. İsteğe bağlı. Varsayılan, Yanlış'tır. |
singleEvents |
boolean |
Yinelenen etkinliklerin örneklere genişletilip genişletilmeyeceği ve temeldeki yinelenen etkinliklerin değil, yalnızca tek seferlik etkinlikler ile yinelenen etkinliklerin döndürülüp döndürülmeyeceği. İsteğe bağlı. Varsayılan, Yanlış'tır. |
syncToken |
string |
nextSyncToken alanından alınan jeton, önceki liste isteğine ait sonuçların son sayfasında döndürüldü. 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ç grubunda 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:
syncToken öğesinin süresi dolarsa sunucu bir 410 GONE yanıt koduyla yanıt verir ve istemcinin depolama alanını temizlemesi ve syncToken olmadan tam senkronizasyon gerçekleştirmesi gerekir. 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 |
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ına sahip bir RFC3339 zaman damgası olmalıdır; örneğin, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milisaniyeler sağlanabilir, ancak yoksayılır. timeMin ayarlanırsa timeMax , timeMin değerinden büyük olmalıdır.
|
timeMin |
datetime |
Bir etkinliğin filtreleme 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ına sahip bir RFC3339 zaman damgası olmalıdır; örneğin, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milisaniyeler 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 |
Filtrelemede kullanılacak etkinliğin son değişiklik zamanı için alt sınır (RFC3339 zaman damgası olarak). Belirtildiğinde, bu tarihten sonra silinen girişler, showDeleted dikkate alınmaksızın her zaman dahil edilir. İsteğe bağlı. Varsayılan olarak, son değiştirme zamanına göre filtreleme yapılmaz.
|
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. | |
summary |
string |
Takvimin başlığı. Salt okunurdur. | |
description |
string |
Takvimin açıklaması. Salt okunurdur. | |
updated |
datetime |
Takvimin son değiştirme zamanı (RFC3339 zaman damgası olarak). Salt okunurdur. | |
timeZone |
string |
Takvimin saat dilimi. Salt okunurdur. | |
accessRole |
string |
Bu takvim için kullanıcının erişim rolü. Salt okunurdur. Olası değerler:
|
|
defaultReminders[] |
list |
Kimliği doğrulanmış 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 (reminders.useDefault değeri 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:
Hatırlatıcı eklerken gerekir. |
yazılabilir |
defaultReminders[].minutes |
integer |
Hatırlatıcının, etkinliğin başlamasından kaç dakika önce tetikleneceği. Geçerli değerler 0 ile 40320 arasındadır (dakika cinsinden 4 hafta). Hatırlatıcı eklerken gerekir. |
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. Başka sonuç 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ı 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 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.