API Reference

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

Typy zasobów

  1. Acl
  2. CalendarList
  3. Kalendarze
  4. Kanały
  5. Kolory
  6. Zdarzenia
  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.
wstaw POST  /calendars/calendarId/acl Tworzy regułę kontroli dostępu.
list GET  /calendars/calendarId/acl Zwraca reguły na liście kontroli dostępu do kalendarza.
patch PATCH  /calendars/calendarId/acl/ruleId Aktualizuje regułę kontroli dostępu. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie PATCH zużywa 3 jednostki limitu. Zalecamy używanie żądania get, a potem żądania update. Podane wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy, jeśli są określone, zastępują istniejące tablice, co powoduje odrzucenie wszystkich poprzednich elementów tablicy.
aktualizować PUT  /calendars/calendarId/acl/ruleId Aktualizuje regułę kontroli dostępu.
zegarek POST  /calendars/calendarId/acl/watch Obserwuj zmiany w zasobach ACL.

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.
wstaw 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 PATCH zużywa 3 jednostki limitu. Zalecamy używanie żądania get, a potem żądania update. Podane wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy, jeśli są określone, zastępują istniejące tablice, co powoduje odrzucenie wszystkich poprzednich elementów tablicy.
aktualizować 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 zasobach Calendars 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.
wyczyść POST  /calendars/calendarId/clear Czyści kalendarz główny. Ta operacja usuwa wszystkie wydarzenia powiązane z kalendarzem głównym konta.
usuń DELETE  /calendars/calendarId Usuwa kalendarz pomocniczy. Użyj metody calendars.clear, aby usunąć wszystkie wydarzenia z kalendarzy głównych.
get GET  /calendars/calendarId Zwraca metadane kalendarza.
wstaw POST  /calendars Tworzy kalendarz pomocniczy.

Uwierzytelniony użytkownik, który wysłał żądanie, staje się właścicielem danych nowego kalendarza.
patch PATCH  /calendars/calendarId Aktualizuje metadane kalendarza. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie PATCH zużywa 3 jednostki limitu. Zalecamy używanie żądania get, a potem żądania update. Podane wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy, jeśli są określone, zastępują istniejące tablice, co powoduje odrzucenie wszystkich poprzednich elementów tablicy.
aktualizować 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ć oglądać zasoby na tym kanale;

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, używając parametru iCalUID.
import POST  /calendars/calendarId/events/import Importuje wydarzenie. Ta operacja służy do dodawania prywatnej kopii istniejącego wydarzenia do kalendarza. Można importować tylko zdarzenia z wartością eventType równą default.

Wycofane działanie: jeśli zaimportowane zostanie zdarzenie inne niż default, jego typ zostanie zmieniony na default, a wszystkie właściwości specyficzne dla typu zdarzenia zostaną usunięte.
wstaw POST  /calendars/calendarId/events Utworzy wydarzenie.
instancje GET  /calendars/calendarId/events/eventId/instances Zwraca wystąpienia określonego wydarzenia cyklicznego.
list GET  /calendars/calendarId/events Zwraca wydarzenia w określonym kalendarzu.
przenieść POST  /calendars/calendarId/events/eventId/move Przenosi wydarzenie do innego kalendarza, czyli zmienia organizatora wydarzenia. Pamiętaj, że można przenosić tylko zdarzenia default. Nie można przenosić zdarzeń birthday, focusTime, fromGmail, outOfOffice ani workingLocation.

Wymagane parametry zapytania: destination

patch PATCH  /calendars/calendarId/events/eventId Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie PATCH zużywa 3 jednostki limitu. Zalecamy używanie żądania get, a potem żądania update. Podane wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy, jeśli są określone, zastępują istniejące tablice, co powoduje odrzucenie wszystkich poprzednich elementów tablicy.
quickAdd POST  /calendars/calendarId/events/quickAdd Tworzy zdarzenie na podstawie prostego ciągu tekstowego.

Wymagane parametry zapytania: text

aktualizować PUT  /calendars/calendarId/events/eventId Aktualizuje wydarzenie. Ta metoda nie obsługuje semantyki poprawki i zawsze aktualizuje całe zasoby wydarzenia. Aby wykonać częściową aktualizację, wykonaj operację get, a potem operację update, używając tagów ETag, aby zapewnić niepodzielność.
zegarek POST  /calendars/calendarId/events/watch Obserwuj zmiany w zasobach Events.

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 Settings 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 pojedynczego użytkownika.
list GET  /users/me/settings Zwraca wszystkie ustawienia użytkownika uwierzytelnionego.
zegarek POST  /users/me/settings/watch Obserwuj zmiany w zasobach Ustawień.