Zwraca instancje określonego wydarzenia cyklicznego. Wypróbuj go teraz.
Żądanie
Żądanie HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
Parametry
| Nazwa parametru | Wartość | Opis |
|---|---|---|
| Parametry ścieżki | ||
calendarId |
string |
Identyfikator kalendarza. Aby pobrać identyfikatory kalendarzy, wywołaj metodę calendarList.list. Jeśli chcesz uzyskać dostęp do kalendarza głównego aktualnie zalogowanego użytkownika, użyj słowa kluczowego „primary”.
|
eventId |
string |
Identyfikator wydarzenia cyklicznego. |
| Opcjonalne parametry zapytania | ||
alwaysIncludeEmail |
boolean |
Wycofany i ignorowany. Wartość będzie zawsze zwracana w polu email w przypadku organizatora, twórcy i uczestników, nawet jeśli nie jest dostępny żaden prawdziwy adres e-mail (czyli zostanie podana wygenerowana, nieprawidłowa wartość).
|
maxAttendees |
integer |
Maksymalna liczba uczestników, którzy mają być uwzględnieni w odpowiedzi. Jeśli liczba uczestników jest większa niż określona, zwracany jest tylko uczestnik. Opcjonalnie. |
maxResults |
integer |
Maksymalna liczba wydarzeń zwracanych na jednej stronie wyników. Domyślnie jest to 250 wydarzeń. Rozmiar strony nie może być większy niż 2500 wydarzeń. Opcjonalnie. |
originalStart |
string |
Oryginalny czas rozpoczęcia instancji w wyniku. Opcjonalnie. |
pageToken |
string |
Token określający stronę wyników, która ma zostać zwrócona. Opcjonalnie. |
showDeleted |
boolean |
Czy w wynikach mają być uwzględniane usunięte wydarzenia (ze status równym „cancelled”). Anulowane instancje wydarzeń cyklicznych będą nadal uwzględniane, jeśli singleEvents ma wartość False. Opcjonalnie. Domyślną wartością jest False.
|
timeMax |
datetime |
Górna granica (wyłączna) czasu rozpoczęcia wydarzenia, według której ma być filtrowane. Opcjonalnie. Domyślnie nie jest stosowane filtrowanie według czasu rozpoczęcia. Musi to być sygnatura czasowa RFC3339 z obowiązkowym przesunięciem strefy czasowej. |
timeMin |
datetime |
Dolna granica (włącznie) czasu zakończenia wydarzenia, według której ma być filtrowane. Opcjonalnie. Domyślnie nie jest stosowane filtrowanie według czasu zakończenia. Musi to być sygnatura czasowa RFC3339 z obowiązkowym przesunięciem strefy czasowej. |
timeZone |
string |
Strefa czasowa używana w odpowiedzi. Opcjonalnie. Domyślnie jest to strefa czasowa kalendarza. |
Autoryzacja
To żądanie umożliwia autoryzację przy użyciu co najmniej jednego z tych zakresów:
| Zakres |
|---|
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 |
Więcej informacji znajdziesz na stronie dotyczącej uwierzytelniania i autoryzacji.
Treść żądania
W przypadku tej metody nie podawaj treści żądania.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź w poniższym formacie:
{
"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
]
}| Nazwa usługi | Wartość | Opis | Uwagi |
|---|---|---|---|
kind |
string |
Typ kolekcji („calendar#events”). |
|
etag |
etag |
ETag kolekcji. | |
summary |
string |
Nazwa kalendarza. Tylko do odczytu. | |
description |
string |
Opis kalendarza. Tylko do odczytu. | |
updated |
datetime |
Czas ostatniej modyfikacji kalendarza (jako RFC3339). Tylko do odczytu. | |
timeZone |
string |
Strefa czasowa kalendarza. Tylko do odczytu. | |
accessRole |
string |
Rola dostępu użytkownika do tego kalendarza. Tylko do odczytu. Możliwe wartości:
|
|
defaultReminders[] |
list |
Domyślne przypomnienia w kalendarzu dla uwierzytelnionego użytkownika. Te przypomnienia dotyczą wszystkich wydarzeń w tym kalendarzu, które nie mają przypomnień ustawionych w inny sposób (tzn. nie mają ustawionej wartości True dla reminders.useDefault). |
|
defaultReminders[].method |
string |
Metoda używana przez to przypomnienie. Możliwe wartości:
Wymagane podczas dodawania przypomnienia. |
z możliwością zapisu |
defaultReminders[].minutes |
integer |
Liczba minut przed rozpoczęciem wydarzenia, po upływie których ma się pojawić przypomnienie. Prawidłowe wartości to liczby od 0 do 40320 (4 tygodnie w minutach). Wymagane podczas dodawania przypomnienia. |
z możliwością zapisu |
nextPageToken |
string |
Token używany do uzyskiwania dostępu do następnej strony wyników. Pomijany, jeśli nie ma więcej wyników. W takim przypadku podawany jest nextSyncToken. |
|
items[] |
list |
Lista wydarzeń w kalendarzu. | |
nextSyncToken |
string |
Token używany w późniejszym czasie do pobierania tylko tych wpisów, które uległy zmianie od czasu zwrócenia tego wyniku. Pomijany, jeśli dostępne są dalsze wyniki. W takim przypadku podawany jest nextPageToken. |
Wypróbuj
Aby wywołać tę metodę na podstawie rzeczywistych danych i zobaczyć odpowiedź, użyj Eksploratora interfejsów API poniżej.