Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Wypróbuj lub zobacz przykład.
Prośba
Żą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 kalendarza głównego aktualnie zalogowanego użytkownika, użyj słowa kluczowego „primary ”.
|
Opcjonalne parametry zapytania | ||
colorRgbFormat |
boolean |
Określa, czy pola foregroundColor i backgroundColor mają być używane do wpisywania kolorów kalendarza (RGB). Jeśli używasz tej funkcji, oparte na indeksie pole colorId zostanie automatycznie ustawione na najlepszą opcję dopasowania. Opcjonalnie. Wartością domyślną jest False (Fałsz).
|
Upoważnienie
To żądanie wymaga autoryzacji w tym zakresie:
Zakres |
---|
https://www.googleapis.com/auth/calendar |
Więcej informacji znajdziesz na stronie uwierzytelniania i autoryzacji.
Treść żądania
W treści żądania podaj zasób Kalendarza 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 opartą na indeksie. Aby ustawić lub zmienić tę właściwość, musisz podać colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. |
z możliwością zapisu |
colorId |
string |
Kolor kalendarza. Jest to identyfikator odnoszący się do wpisu w sekcji calendar definicji kolorów (patrz punkt końcowy kolorów). Ta właściwość jest zastępowana właściwościami backgroundColor oraz foregroundColor i można ją zignorować, jeśli korzystasz z tych właściwości. Opcjonalnie. |
z możliwością zapisu |
defaultReminders[] |
list |
Domyślne przypomnienia dla tego kalendarza dla uwierzytelnionego użytkownika. | z możliwością zapisu |
defaultReminders[].method |
string |
Metoda używana przez to przypomnienie. Możliwe wartości:
Wymagane podczas dodawania przypomnienia. |
z możliwością zapisu |
defaultReminders[].minutes |
integer |
Liczba minut przed rozpoczęciem wydarzenia, na którą powinno zostać aktywowane przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40320 (4 tygodnie w minutach). Wymagane podczas dodawania przypomnienia. |
z możliwością zapisu |
foregroundColor |
string |
Kolor pierwszego planu kalendarza w formacie szesnastkowym „#ffffff ”. Ta właściwość zastępuje właściwość colorId opartą na indeksie. Aby ustawić lub zmienić tę właściwość, musisz podać colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. |
z możliwością zapisu |
notificationSettings |
object |
Powiadomienia o tym kalendarzu wysyłane przez uwierzytelnionego użytkownika. | z możliwością zapisu |
notificationSettings.notifications[].method |
string |
Metoda użyta do dostarczenia powiadomienia. Możliwa wartość to:
Wymagane podczas dodawania powiadomienia. |
z możliwością zapisu |
notificationSettings.notifications[].type |
string |
Typ powiadomienia. Możliwe wartości:
Wymagane podczas dodawania powiadomienia. |
z możliwością zapisu |
selected |
boolean |
Czy zawartość kalendarza wyświetla się w jego interfejsie. Opcjonalnie. Wartością domyślną jest False (Fałsz). | z możliwością zapisu |
summaryOverride |
string |
Podsumowanie ustawione przez uwierzytelniony użytkownik dla tego kalendarza. Opcjonalnie. | z możliwością zapisu |
Odpowiedź
Jeśli operacja się uda, metoda zwróci w treści odpowiedzi zasób Kalendarza.
Przykłady
Uwaga: dostępne dla tej metody przykłady kodu nie odzwierciedlają wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz na stronie z bibliotekami klienta.
Java
Korzysta z biblioteki klienta Java.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.CalendarListEntry; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Retrieve the calendar list entry CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute(); // Make a change calendarListEntry.setColorId("newColorId"); // Update the altered entry CalendarListEntry updatedCalendarListEntry = service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute(); System.out.println(updatedCalendarListEntry.getEtag());
Python
Używa biblioteki klienta dla języka Python.
# First retrieve the calendarListEntry from the API. calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute() calendar_list_entry['colorId'] = 'newColorId' updated_calendar_list_entry = service.calendarList().update( calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute() print created_calendar_list_entry['etag']
PHP
Korzysta z biblioteki klienta PHP.
// First retrieve the calendarListEntry from the API. $calendarListEntry = $service->calendarList->get('calendarId'); $calendarListEntry->setColorId('newColorId'); $updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry); echo $updatedCalendarListEntry->getEtag();
Ruby
Używa biblioteki klienta Ruby.
calendar_list_entry = client.get_calendar_list('calendarId') calendar_list_entry.colorId = 'newColorId' result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry) print result.etag
Wypróbuj
Użyj Eksploratora interfejsów API poniżej, aby wywołać tę metodę na aktywnych danych i zobaczyć odpowiedź.