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 pozycji. Rozmiar strony nie może przekraczać 250 pozycji. Opcjonalnie.
minAccessRole string Minimalna rola dostępu użytkownika w zwróconych wpisach. Opcjonalnie. Domyślnie nie ma ograniczeń.

Akceptowane wartości:
  • „freeBusyReader”: użytkownik może odczytywać informacje o stanie Wolny/Zajęty.
  • „owner”: użytkownik może odczytywać i modyfikować zdarzenia 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, ale nie ma dostępu do wydarzeń prywatnych.
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 wpisy na liście kalendarzy. Opcjonalnie. Wartość domyślna to False (fałsz).
showHidden boolean Określa, czy wyświetlać ukryte wpisy. Opcjonalnie. Wartość domyślna to False (fałsz).
syncToken string Token uzyskany z pola nextSyncToken zwróconego na ostatniej stronie wyników z 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 zestawie wyników. Nie można ustawić wartości showDeleted ani showHidden na False.
Aby zapewnić spójność stanu klienta, nie można podać parametru zapytania minAccessRole razem 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 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 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#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 tego wyniku. Pomijany, jeśli nie ma więcej wyników. W takim przypadku podawany jest znak 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 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ź.