Events: instances

Zwraca wystąpienia określonego wydarzenia cyklicznego. Wypróbuj 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 podstawowego aktualnie zalogowanego użytkownika, użyj słowa kluczowego „primary”.
eventId string Identyfikator wydarzenia cyklicznego.
Opcjonalne parametry zapytania
alwaysIncludeEmail boolean Wycofane i ignorowane. W przypadku organizatora, twórcy i uczestników w polu email zawsze będzie zwracana wartość, nawet jeśli nie jest dostępny prawdziwy adres e-mail (czyli zostanie podana wygenerowana, nieprawidłowa wartość).
maxAttendees integer Maksymalna liczba uczestników do uwzględnienia w odpowiedzi. Jeśli uczestników jest więcej niż określona liczba, zwracany jest tylko uczestnik. Opcjonalnie:
maxResults integer Maksymalna liczba zdarzeń zwracanych na jednej stronie wyników. Domyślna wartość to 250 zdarzeń. Rozmiar strony nigdy nie może przekraczać 2500 zdarzeń. Opcjonalnie:
originalStart string Pierwotny czas rozpoczęcia instancji w wyniku. Opcjonalnie:
pageToken string Token określający, którą stronę wyników należy zwrócić. Opcjonalnie:
showDeleted boolean Określa, czy w wyniku mają być uwzględniane usunięte zdarzenia (w przypadku których parametr status ma wartość „cancelled”). Anulowane wystąpienia wydarzeń cyklicznych będą nadal uwzględniane, jeśli wartość singleEvents to „False”. Opcjonalnie: Wartość domyślna to False (fałsz).
timeMax datetime Górna granica (wyłączna) czasu rozpoczęcia zdarzenia, według której można filtrować. Opcjonalnie: Domyślnie filtrowanie według czasu rozpoczęcia jest wyłączone. Musi to być sygnatura czasowa w formacie RFC3339 z obowiązkowym przesunięciem strefy czasowej.
timeMin datetime Dolna granica (włącznie) czasu zakończenia zdarzenia, według której chcesz filtrować. Opcjonalnie: Domyślnie filtrowanie według czasu zakończenia jest wyłączone. Musi to być sygnatura czasowa w formacie RFC3339 z obowiązkowym przesunięciem strefy czasowej.
timeZone string Strefa czasowa użyta w odpowiedzi. Opcjonalnie: Domyślnie jest to strefa czasowa kalendarza.

Autoryzacja

Ta prośba umożliwia autoryzację w co najmniej jednym 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 Uwierzytelnianie i autoryzacja.

Treść żądania

Nie podawaj treści żądania w przypadku tej metody.

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 Tytuł kalendarza. Tylko do odczytu.
description string Opis kalendarza. Tylko do odczytu.
updated datetime Czas ostatniej modyfikacji kalendarza (sygnatura czasowa w formacie 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:
  • „none” – użytkownik nie ma dostępu.
  • „freeBusyReader” – użytkownik ma dostęp do odczytu informacji o stanie Wolny/Zajęty.
  • „reader” – użytkownik ma dostęp do kalendarza w trybie odczytu. Wydarzenia prywatne będą widoczne dla użytkowników z dostępem do odczytu, ale szczegóły wydarzeń będą ukryte.
  • „writer” – użytkownik ma uprawnienia do odczytu i zapisu w kalendarzu. Wydarzenia prywatne będą widoczne dla użytkowników z uprawnieniami do edycji, a szczegóły wydarzeń będą widoczne.
  • „owner” – użytkownik ma dostęp menedżera do kalendarza. Ta rola ma wszystkie uprawnienia roli autora, a dodatkowo umożliwia wyświetlanie i modyfikowanie poziomów dostępu innych użytkowników.

defaultReminders[] list Domyślne przypomnienia w kalendarzu uwierzytelnionego użytkownika. Te przypomnienia dotyczą wszystkich wydarzeń w tym kalendarzu, które nie mają ich wyraźnie zastąpionych (tzn. nie mają ustawionej wartości reminders.useDefault na „Prawda”).
defaultReminders[].method string Metoda używana przez to przypomnienie. Możliwe wartości:
  • „email” – przypomnienia są wysyłane e-mailem.
  • „popup” – przypomnienia są wysyłane w wyskakującym okienku interfejsu.

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 od 0 do 40 320 (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 tego wyniku. Pomijany, jeśli nie ma więcej wyników. W takim przypadku podawany jest znak 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 momentu zwrócenia tego wyniku. Pomijany, jeśli dostępne są dalsze wyniki. W takim przypadku podawany jest parametr nextPageToken.

Wypróbuj

Użyj narzędzia APIs Explorer poniżej, aby wywołać tę metodę na danych na żywo i zobaczyć odpowiedź.