API Reference

To materiały referencyjne interfejsu API są uporządkowane według typu zasobu. Każdy typ zasobu ma co najmniej 1 reprezentację danych i co najmniej 1 metodę.

Typy zasobów

  1. ACL
  2. CalendarList
  3. Kalendarze
  4. Kanały
  5. Kolory
  6. Zdarzenia
  7. Wolny/zajęty
  8. Ustawienia

Acl

Szczegółowe informacje o zasobach listy ACL znajdziesz na stronie reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
usuń DELETE  /calendars/calendarId/acl/ruleId Usuwa regułę kontroli dostępu.
pobierz GET  /calendars/calendarId/acl/ruleId Zwraca regułę kontroli dostępu.
wstaw POST  /calendars/calendarId/acl Tworzy regułę kontroli dostępu.
list GET  /calendars/calendarId/acl Zwraca reguły na liście kontroli dostępu kalendarza.
poprawka PATCH  /calendars/calendarId/acl/ruleId Aktualizuje regułę kontroli dostępu. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. Lepiej użyć polecenia get, po którym następuje update. Określone przez Ciebie wartości pól zastępują dotychczasowe wartości. Pola, których w żądaniu nie określisz, nie zostaną zmienione. Pola tablicy (jeśli są określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
aktualizacja PUT  /calendars/calendarId/acl/ruleId Aktualizuje regułę kontroli dostępu.
zegarek POST  /calendars/calendarId/acl/watch Obserwuj zmiany w zasobach listy ACL.

CalendarList

Szczegółowe informacje o zasobie CalendarList znajdziesz na stronie na temat reprezentowania zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
usuń DELETE  /users/me/calendarList/calendarId Usuwa kalendarz z listy kalendarzy użytkownika.
pobierz GET  /users/me/calendarList/calendarId Zwraca kalendarz z listy kalendarzy użytkownika.
wstaw POST  /users/me/calendarList Wstawianie istniejącego kalendarza do listy kalendarzy użytkownika.
list GET  /users/me/calendarList Zwraca kalendarze na liście kalendarzy użytkownika.
poprawka PATCH  /users/me/calendarList/calendarId Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. Lepiej użyć polecenia get, po którym następuje update. Określone przez Ciebie wartości pól zastępują dotychczasowe wartości. Pola, których w żądaniu nie określisz, nie zostaną zmienione. Pola tablicy (jeśli są określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
aktualizacja PUT  /users/me/calendarList/calendarId Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika.
zegarek POST  /users/me/calendarList/watch Obserwuj zmiany w zasobach CalendarList.

Kalendarze

Szczegółowe informacje o zasobie Kalendarzy znajdziesz na stronie na temat reprezentowania zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
wyczyść POST  /calendars/calendarId/clear Czyści kalendarz główny. Ta operacja powoduje usunięcie wszystkich wydarzeń powiązanych z kalendarzem głównym konta.
usuń DELETE  /calendars/calendarId Usuwa kalendarz pomocniczy. Aby wyczyścić wszystkie wydarzenia w kalendarzach głównych, użyj polecenia calendar.clear.
pobierz GET  /calendars/calendarId Zwraca metadane kalendarza.
wstaw POST  /calendars Tworzy kalendarz pomocniczy.
poprawka PATCH  /calendars/calendarId Aktualizuje metadane kalendarza. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. Lepiej użyć polecenia get, po którym następuje update. Określone przez Ciebie wartości pól zastępują dotychczasowe wartości. Pola, których w żądaniu nie określisz, nie zostaną zmienione. Pola tablicy (jeśli są określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
aktualizacja PUT  /calendars/calendarId Aktualizuje metadane kalendarza.

Kanały

Szczegółowe informacje o zasobach na kanałach znajdziesz na stronie reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
zatrzymaj POST  /channels/stop Przestań oglądać zasoby na tym kanale.

Kolory

Szczegółowe informacje o zasobie kolorów znajdziesz na stronie dotyczącej reprezentowania zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
pobierz GET  /colors Zwraca definicje kolorów kalendarzy i wydarzeń.

Wydarzenia

Szczegółowe informacje o zasobie zdarzeń znajdziesz na stronie reprezentacji zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
usuń DELETE  /calendars/calendarId/events/eventId Usuwa wydarzenie.
pobierz GET  /calendars/calendarId/events/eventId Zwraca wydarzenie na podstawie jego identyfikatora Kalendarza Google. Aby pobrać zdarzenie, używając jego identyfikatora iCalendar, wywołaj metodę events.list za pomocą parametru iCalUID.
import POST  /calendars/calendarId/events/import Importuje zdarzenie. Ta operacja pozwala dodać prywatną kopię istniejącego wydarzenia do kalendarza.
wstaw POST  /calendars/calendarId/events Tworzy wydarzenie.
instancje GET  /calendars/calendarId/events/eventId/instances Zwraca wystąpienia określonego wydarzenia cyklicznego.
list GET  /calendars/calendarId/events Zwraca wydarzenia z określonego kalendarza.
przenieś POST  /calendars/calendarId/events/eventId/move Przenosi wydarzenie do innego kalendarza, np. zmienia jego organizatora. Można przenieść tylko wydarzenia typu default. Nie można przenieść wydarzeń outOfOffice, focusTime i workingLocation.

Wymagane parametry zapytania: destination

poprawka PATCH  /calendars/calendarId/events/eventId Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. Lepiej użyć polecenia get, po którym następuje update. Określone przez Ciebie wartości pól zastępują dotychczasowe wartości. Pola, których w żądaniu nie określisz, nie zostaną zmienione. Pola tablicy (jeśli są określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
quickAdd POST  /calendars/calendarId/events/quickAdd Tworzy zdarzenie na podstawie prostego ciągu tekstowego.

Wymagane parametry zapytania: text

aktualizacja PUT  /calendars/calendarId/events/eventId Aktualizuje wydarzenie. Ta metoda nie obsługuje semantyki poprawki i zawsze aktualizuje cały zasób zdarzenia. Aby wykonać częściową aktualizację, wykonaj get, a następnie update, korzystając z tagów w celu zapewnienia atomowości.
zegarek POST  /calendars/calendarId/events/watch Obserwuj zmiany w zasobach wydarzeń.

Wolny/zajęty

Szczegółowe informacje o zasobie związanym ze stanem Wolny/Zajęty znajdziesz na stronie na temat reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
zapytanie POST  /freeBusy Zwraca informacje o stanie Wolny/Zajęty dla określonego zestawu kalendarzy.

Ustawienia

Szczegółowe informacje o zasobie ustawień znajdziesz na stronie Reprezentacja zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne wobec https://www.googleapis.com/calendar/v3, o ile nie zaznaczono inaczej
pobierz GET  /users/me/settings/setting Zwraca ustawienie pojedynczego użytkownika.
list GET  /users/me/settings Zwraca wszystkie ustawienia użytkownika dotyczące uwierzytelnionego użytkownika.
zegarek POST  /users/me/settings/watch Czekaj na zmiany w zasobach ustawień.