CalendarList: list

Zwraca kalendarze na liście kalendarzy użytkownika. Wypróbuj teraz.

Żądanie

Żądanie HTTP

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

Parametry

Nazwa parametru Wartość Opis
Opcjonalne parametry zapytania
maxResults integer Maksymalna liczba wpisów zwracanych na jednej stronie wyników. Domyślna wartość to 100 wpisów. Rozmiar strony nie może być większy niż 250 wpisów. Opcjonalnie.
minAccessRole string Minimalna rola dostępu użytkownika w zwracanych wpisach. Opcjonalnie. Domyślnie nie ma ograniczeń.

Akceptowane wartości:
  • „freeBusyReader”: użytkownik może odczytywać informacje o dostępności.
  • „owner”: użytkownik może odczytywać i modyfikować wydarzenia oraz listy kontroli dostępu.
  • „reader”: użytkownik może odczytywać wydarzenia, które nie są prywatne.
  • „writer”: użytkownik może odczytywać i modyfikować wydarzenia.
  • „writerWithoutPrivateAccess”: użytkownik może odczytywać i modyfikować wydarzenia, które nie są prywatne. Użytkownik może odczytywać informacje o dostępności w przypadku wydarzeń prywatnych. Użytkownik nie może modyfikować wydarzeń prywatnych.
pageToken string Token określający stronę wyników, która ma zostać zwrócona. Opcjonalnie.
showDeleted boolean Określa, czy w wynikach mają być uwzględniane usunięte wpisy na liście kalendarzy. Opcjonalnie. Domyślna wartość to False.
showHidden boolean Określa, czy mają być wyświetlane ukryte wpisy. Opcjonalnie. Domyślna wartość to False.
showOwnOrganizationOnly boolean Określa, czy mają być wyświetlane tylko wpisy dotyczące kalendarzy z organizacji. Ten parametr dotyczy tylko użytkowników Google Workspace. Opcjonalnie. Domyślna wartość to False.
syncToken string Token uzyskany z pola nextSyncToken zwróconego na ostatniej stronie wyników poprzedniego żądania listy. Dzięki temu wynik tego żądania listy będzie zawierać tylko wpisy, które uległy zmianie od tego czasu. Jeśli zmieniły się tylko pola tylko do odczytu, takie jak właściwości kalendarza lub listy ACL, wpis nie zostanie zwrócony. Wszystkie wpisy usunięte i ukryte od czasu poprzedniego żądania listy będą zawsze znajdować się w zbiorze wyników. Nie można ustawić wartości False dla parametrów showDeleted ani showHidden.
Aby zapewnić spójność stanu klienta, nie można podać razem parametrów zapytania minAccessRole i showOwnOrganizationOnly z parametrem nextSyncToken.
Jeśli syncToken wygaśnie, serwer odpowie kodem odpowiedzi 410 GONE, a klient powinien wyczyścić pamięć i przeprowadzić pełną synchronizację bez użycia syncToken.
Więcej informacji o synchronizacji przyrostowej
Opcjonalnie. Domyślnie zwracane są wszystkie wpisy.

Autoryzacja

To żądanie wymaga autoryzacji z 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.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.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#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Nazwa usługi Wartość Opis Uwagi
kind string Typ kolekcji („calendar#calendarList”).
etag etag ETag kolekcji.
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 Kalendarze, które znajdują się na liście kalendarzy użytkownika.
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 danych na żywo i zobaczyć odpowiedź, użyj Eksploratora interfejsów API poniżej.