API Reference

Ta dokumentacja referencyjna interfejsu API jest uporządkowana według typu zasobu. Każdy typ ma co najmniej jedną reprezentację i co najmniej jedną metodę.

Typy zasobów

  1. Acl
  2. CalendarList
  3. Kalendarze
  4. Kanały
  5. Kolory
  6. Wydarzenia
  7. Freebusy
  8. Ustawienia

Acl

Szczegółowe informacje o zasobach Acl znajdziesz na stronie reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/calendar/v3, o ile nie określono inaczej.
usuń DELETE  /calendars/calendarId/acl/ruleId Usuwa regułę kontroli dostępu.
get GET  /calendars/calendarId/acl/ruleId Zwraca regułę kontroli dostępu.
insert POST  /calendars/calendarId/acl Tworzy regułę kontroli dostępu.
list GET  /calendars/calendarId/acl Zwraca reguły na liście kontroli dostępu dla kalendarza.
patch PATCH  /calendars/calendarId/acl/ruleId Zaktualizuje regułę kontroli dostępu. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie zmiany zużywa 3 jednostki limitu; preferuj użycie get, a następnie update. Podane przez Ciebie wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablic, jeśli są określone, zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
update PUT  /calendars/calendarId/acl/ruleId Zaktualizuje regułę kontroli dostępu.
watch POST  /calendars/calendarId/acl/watch Sprawdź, czy zasoby na liście ACL uległy zmianie.

CalendarList

Szczegółowe informacje o zasobach CalendarList znajdziesz na stronie reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/calendar/v3, o ile nie określono inaczej.
usuń DELETE  /users/me/calendarList/calendarId Usuwa kalendarz z listy kalendarzy użytkownika.
get GET  /users/me/calendarList/calendarId Zwraca kalendarz z listy kalendarzy użytkownika.
insert POST  /users/me/calendarList Wstawia istniejący kalendarz na listę kalendarzy użytkownika.
list GET  /users/me/calendarList Zwraca kalendarze z listy kalendarzy użytkownika.
patch 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 zmiany zużywa 3 jednostki limitu; preferuj użycie get, a następnie update. Podane przez Ciebie wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablic, jeśli są określone, zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
update PUT  /users/me/calendarList/calendarId Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika.
watch POST  /users/me/calendarList/watch śledzić zmiany w zasobach CalendarList.

Kalendarze

Szczegółowe informacje o zasobach kalendarza znajdziesz na stronie reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/calendar/v3, o ile nie określono inaczej.
clear POST  /calendars/calendarId/clear Czyści kalendarz główny. Ta operacja usuwa wszystkie wydarzenia powiązane z głównym kalendarzem konta.
usuń DELETE  /calendars/calendarId usuwa kalendarz pomocniczy. Aby usunąć wszystkie wydarzenia z kalendarzy głównych, użyj akcji calendars.clear.
get GET  /calendars/calendarId Zwraca metadane kalendarza.
insert POST  /calendars Tworzy kalendarz pomocniczy.
patch PATCH  /calendars/calendarId Aktualizuje metadane kalendarza. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu; preferuj użycie get, a następnie update. Podane przez Ciebie wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablic, jeśli są określone, zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
update PUT  /calendars/calendarId Aktualizuje metadane kalendarza.

Kanały

Szczegółowe informacje o zasobach Channels znajdziesz na stronie reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/calendar/v3, o ile nie określono inaczej.
stop POST  /channels/stop przestać korzystać z zasobów udostępnianych przez ten kanał;

Kolory

Szczegółowe informacje o zasobach Colors znajdziesz na stronie reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/calendar/v3, o ile nie określono inaczej.
get GET  /colors Zwraca definicje kolorów kalendarzy i wydarzeń.

Wydarzenia

Szczegółowe informacje o zasobach Events znajdziesz na stronie reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/calendar/v3, o ile nie określono inaczej.
usuń DELETE  /calendars/calendarId/events/eventId Usuwa wydarzenie.
get GET  /calendars/calendarId/events/eventId Zwraca wydarzenie na podstawie jego identyfikatora w Kalendarzu Google. Aby pobrać wydarzenie za pomocą identyfikatora iCalendar, wywołaj metodę events.list za pomocą parametru iCalUID.
import POST  /calendars/calendarId/events/import Importuje wydarzenie. Ta operacja służy do dodawania do kalendarza prywatnej kopii istniejącego wydarzenia. Można importować tylko zdarzenia z eventType default.

Wycofane działanie: jeśli importujesz zdarzenie inne niż default, jego typ zostanie zmieniony na default, a wszystkie właściwości specyficzne dla typu zdarzenia zostaną usunięte.

insert POST  /calendars/calendarId/events Utworzy wydarzenie.
instancjach GET  /calendars/calendarId/events/eventId/instances Zwraca wystąpienia określonego wydarzenia cyklicznego.
list GET  /calendars/calendarId/events Zwraca wydarzenia w wybranym kalendarzu.
move POST  /calendars/calendarId/events/eventId/move Przenosi wydarzenie do innego kalendarza, czyli zmienia organizatora wydarzenia. Pamiętaj, że można przenosić tylko zdarzenia default. Zdarzenia birthday, focusTime, fromGmail, outOfOfficeworkingLocation nie można przenosić.

Wymagane parametry zapytania: destination

patch PATCH  /calendars/calendarId/events/eventId Aktualizuje zdarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu; preferuj użycie get, a następnie update. Podane przez Ciebie wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablic, 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

update PUT  /calendars/calendarId/events/eventId Aktualizuje zdarzenie. Ta metoda nie obsługuje semantyki poprawki i zawsze aktualizuje cały zasób zdarzenia. Aby przeprowadzić aktualizację częściową, wykonaj operację get, a następnie operację update, używając etagów, aby zapewnić atomiczność.
watch POST  /calendars/calendarId/events/watch śledzić zmiany w zasobach Zdarzenia.

Wolny/zajęty

Szczegółowe informacje o zasobach Freebusy znajdziesz na stronie reprezentacji zasobu.

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

Ustawienia

Szczegółowe informacje o zasobach ustawień znajdziesz na stronie reprezentacji zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/calendar/v3, o ile nie określono inaczej.
get GET  /users/me/settings/setting Zwraca ustawienie dla jednego użytkownika.
list GET  /users/me/settings Zwraca wszystkie ustawienia użytkownika uwierzytelnionego.
watch POST  /users/me/settings/watch śledzić zmiany w zasobach ustawień.