Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Wypróbuj teraz lub zobacz przykład.
Żą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:
Wymagany 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). Wymagany 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 |
notificationSettings |
object |
Powiadomienia, które uwierzytelniony użytkownik otrzymuje z tego kalendarza. | zapisywalny |
notificationSettings.notifications[].method |
string |
Metoda dostarczania powiadomienia. Możliwa wartość:
Wymagany podczas dodawania powiadomienia. |
zapisywalny |
notificationSettings.notifications[].type |
string |
Typ powiadomienia. Możliwe wartości:
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.
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
Korzysta z biblioteki klienta Pythona.
# 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
Używa 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
Aby wywołać tę metodę na podstawie danych na żywo i zobaczyć odpowiedź, użyj narzędzia APIs Explorer.