CalendarList: update

Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Wypróbuj

Żądanie

Żądanie HTTP

PUT https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId

Parametry

Nazwa parametru Wartość Opis
Parametry ścieżki
calendarId string Identyfikator kalendarza. Aby pobrać identyfikatory kalendarzy, wywołaj metodę calendarList.list. Jeśli chcesz uzyskać dostęp do głównego kalendarza aktualnie zalogowanego użytkownika, użyj słowa kluczowego „primary”.
Parametry opcjonalne zapytania
colorRgbFormat boolean Określa, czy do zapisywania kolorów kalendarza (RGB) mają być używane pola foregroundColor i backgroundColor. Jeśli ta funkcja jest używana, pole colorId oparte na indeksie zostanie automatycznie ustawione na najlepszą opcję dopasowania. Opcjonalnie. Wartość domyślna to False (fałsz).

Autoryzacja

Ta prośba wymaga autoryzacji z co najmniej jednym z tych zakresów:

Zakres
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.calendarlist

Więcej informacji znajdziesz na stronie Uwierzytelnianie i autoryzacja.

Treść żądania

W treści żądania podaj zasób CalendarList z tymi właściwościami:

Nazwa usługi Wartość Opis Uwagi
Właściwości opcjonalne
backgroundColor string Główny kolor kalendarza w formacie szesnastkowym „#0088aa”. Ta właściwość zastępuje właściwość colorId o wartości indeksu. Aby ustawić lub zmienić tę właściwość, musisz podać wartość colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. zapisywalny
colorId string Kolor kalendarza. Jest to identyfikator odnoszący się do wpisu w sekcji calendar definicji kolorów (patrz punkt końcowy colors). Ta właściwość została zastąpiona przez właściwości backgroundColor i foregroundColor, więc można ją zignorować. Opcjonalnie. zapisywalny
defaultReminders[] list Domyślne przypomnienia, które uwierzytelniony użytkownik ma w tym kalendarzu. zapisywalny
defaultReminders[].method string Metoda używana przez ten przypomnienie. Możliwe wartości:
  • „email” – przypomnienia są wysyłane e-mailem.
  • „popup” – przypomnienia są wysyłane przez wyskakujące okienko w interfejsie.

Wymagane podczas dodawania przypomnienia.

 zapisywalny
defaultReminders[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, w których przypomnienie powinno się aktywować. Dozwolone wartości to 0–40 320 (4 tygodnie w minutach).

Wymagane podczas dodawania przypomnienia.

 zapisywalny
foregroundColor string Kolor pierwszego planu kalendarza w formacie szesnastkowym „#ffffff”. Ta właściwość zastępuje właściwość colorId o wartości indeksu. Aby ustawić lub zmienić tę właściwość, musisz podać wartość colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. zapisywalny
hidden boolean Określa, czy kalendarz został ukryty na liście. Opcjonalnie. Atrybut jest zwracany tylko wtedy, gdy kalendarz jest ukryty, a jego wartość to true. zapisywalny
notificationSettings object Powiadomienia, które uwierzytelniony użytkownik otrzymuje z tego kalendarza. zapisywalny
notificationSettings.notifications[].method string Metoda dostarczania powiadomienia. Możliwa wartość:
  • „email” – powiadomienia są wysyłane pocztą e-mail.

Wymagany podczas dodawania powiadomienia.

 zapisywalny
notificationSettings.notifications[].type string Typ powiadomienia. Możliwe wartości:
  • „eventCreation” – powiadomienie wysyłane, gdy w kalendarzu pojawi się nowe wydarzenie.
  • „eventChange” – powiadomienie wysyłane po zmianie zdarzenia.
  • „eventCancellation” – powiadomienie wysyłane po anulowaniu wydarzenia.
  • „eventResponse” – powiadomienie wysłane, gdy uczestnik odpowie na zaproszenie na wydarzenie.
  • „agenda” – agenda z wydarzeniami na dany dzień (wysyłana rano).

Wymagany podczas dodawania powiadomienia.

 zapisywalny
selected boolean czy zawartość kalendarza jest widoczna w interfejsie kalendarza. Opcjonalnie. Wartość domyślna to False (fałsz). zapisywalny
summaryOverride string Podsumowanie ustawione przez uwierzytelnionego użytkownika w tym kalendarzu. Opcjonalnie. zapisywalny

Odpowiedź

Jeśli operacja się powiedzie, zwróci ona zasób CalendarList w treści odpowiedzi.

Wypróbuj

Aby wywołać tę metodę na podstawie danych na żywo i zobaczyć odpowiedź, użyj narzędzia APIs Explorer.