Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Wypróbuj 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 kalendarza głównego obecnie zalogowanego użytkownika, użyj narzędzia „primary ” słowa kluczowego.
|
Opcjonalne parametry zapytania | ||
colorRgbFormat |
boolean |
Określa, czy do zapisywania kolorów kalendarza (RGB) używać pól 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 Fałsz.
|
Autoryzacja
To żądanie wymaga autoryzacji w tym zakresie:
Zakres |
---|
https://www.googleapis.com/auth/calendar |
Więcej informacji znajdziesz na stronie dotyczącej uwierzytelniania i autoryzacji.
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 opartą na indeksie właściwość colorId . Aby ustawić lub zmienić tę właściwość, musisz określić colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie: |
z możliwością zapisu |
colorId |
string |
Kolor kalendarza. 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 i foregroundColor i można ją zignorować podczas korzystania z tych właściwości. Opcjonalnie: |
z możliwością zapisu |
defaultReminders[] |
list |
Domyślne przypomnienia dla uwierzytelnionego użytkownika dotyczące tego kalendarza. | z możliwością zapisu |
defaultReminders[].method |
string |
Metoda użyta w tym przypomnieniu. Możliwe wartości:
Wymagane przy dodawaniu przypomnienia. |
z możliwością zapisu |
defaultReminders[].minutes |
integer |
Liczba minut przed rozpoczęciem wydarzenia, kiedy powinno wyświetlić się przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40 320 (4 tygodnie w minutach). Wymagane przy dodawaniu przypomnienia. |
z możliwością zapisu |
foregroundColor |
string |
Kolor pierwszego planu kalendarza w formacie szesnastkowym „#ffffff ”. Ta właściwość zastępuje opartą na indeksie właściwość colorId . Aby ustawić lub zmienić tę właściwość, musisz określić colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie: |
z możliwością zapisu |
notificationSettings |
object |
Powiadomienia o tym kalendarzu odbierane przez uwierzytelnionego użytkownika. | z możliwością zapisu |
notificationSettings.notifications[].method |
string |
Metoda użyta do przesłania powiadomienia. Możliwa wartość to:
Wymagane przy dodawaniu powiadomienia. |
z możliwością zapisu |
notificationSettings.notifications[].type |
string |
Typ powiadomienia. Możliwe wartości:
Wymagane przy dodawaniu powiadomienia. |
z możliwością zapisu |
selected |
boolean |
Określa, czy zawartość kalendarza wyświetla się w interfejsie kalendarza. Opcjonalnie: Wartość domyślna to Fałsz. | z możliwością zapisu |
summaryOverride |
string |
Podsumowanie ustawione przez uwierzytelnionego użytkownika dla tego kalendarza. Opcjonalnie: | z możliwością zapisu |
Odpowiedź
Jeśli operacja się uda, metoda zwróci 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
Używa 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 w Pythonie.
# 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
Użyj poniższego eksploratora interfejsów API, aby wywołać tę metodę na bieżących danych i wyświetlić odpowiedź.