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
Acl
Szczegółowe informacje o zasobach ACL znajdziesz na stronie reprezentacji zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że 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. Preferowane są get , po którym następuje update . Określone przez Ciebie wartości pól zastępują obecne. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy (jeśli zostały 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
Informacje o zasobach związanych z listą Kalendarza znajdziesz na stronie dotyczącej reprezentacji zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że 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
|
Wstawia istniejący kalendarz na listę 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. Preferowane są get , po którym następuje update . Określone przez Ciebie wartości pól zastępują obecne. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy (jeśli zostały 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
|
Sprawdź, czy nie zaszły zmiany w zasobach CalendarList. |
Kalendarze
Szczegółowe informacje o zasobach kalendarza znajdziesz na stronie reprezentowania zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że 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. Użyj polecenia calendar.clear do usunięcia wszystkich wydarzeń w kalendarzach głównych. |
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. Preferowane są get , po którym następuje update . Określone przez Ciebie wartości pól zastępują obecne. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy (jeśli zostały 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 kanałów znajdziesz na stronie dotyczącej reprezentacji zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że zaznaczono inaczej | ||
przesiadka |
POST /channels/stop
|
Przestań oglądać zasoby dostępne na tym kanale. |
Kolory
Szczegółowe informacje o zasobach kolorów znajdziesz na stronie reprezentacji zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że zaznaczono inaczej | ||
pobierz |
GET /colors
|
Zwraca definicje kolorów kalendarzy i wydarzeń. |
Wydarzenia
Szczegółowe informacje o zasobach zdarzeń znajdziesz na stronie dotyczącej reprezentacji zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że zaznaczono inaczej | ||
usuń |
DELETE /calendars/calendarId/events/eventId
|
Usuwa wydarzenie. |
pobierz |
GET /calendars/calendarId/events/eventId
|
Zwraca wydarzenie na podstawie jego identyfikatora z Kalendarza Google. Aby pobrać zdarzenie przy użyciu 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. Można importować tylko zdarzenia z eventType o wartości default .Wycofane działanie: jeśli zaimportowane zdarzenie inne niż |
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, tj. zmienia jego organizatora. Można przenieść tylko wydarzenia default . Nie można przenieść wydarzeń outOfOffice , focusTime , workingLocation i fromGmail .
Wymagane parametry zapytania:
|
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. Preferowane są get , po którym następuje update . Określone przez Ciebie wartości pól zastępują obecne. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy (jeśli zostały 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:
|
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 etagów.
|
zegarek |
POST /calendars/calendarId/events/watch
|
Szukaj zmian w zasobach zdarzeń. |
Wolny/zajęty
Szczegółowe informacje o zasobach Wolny/Zajęty znajdziesz na stronie reprezentacji zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że zaznaczono inaczej | ||
zapytanie |
POST /freeBusy
|
Zwraca informacje o stanie Wolny/Zajęty dla określonego zestawu kalendarzy. |
Ustawienia
Szczegółowe informacje o zasobach ustawień znajdziesz na stronie dotyczącej reprezentacji zasobów.
Metoda | Żądanie HTTP | Opis |
---|---|---|
Identyfikatory URI są względne wobec https://www.googleapis.com/calendar/v3, chyba że zaznaczono inaczej | ||
pobierz |
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 dotyczących ustawień. |