CalendarList: update

Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers. Jetzt testen oder Beispiel ansehen

Anfrage

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Pfadparameter
calendarId string Kalender-ID. Rufen Sie die Methode calendarList.list auf, um Kalender-IDs abzurufen. Wenn Sie auf den primären Kalender des aktuell angemeldeten Nutzers zugreifen möchten, verwenden Sie das Keyword „primary“.
Optionale Suchparameter
colorRgbFormat boolean Gibt an, ob die Kalenderfarben (RGB) in den Feldern foregroundColor und backgroundColor geschrieben werden sollen. Wenn diese Funktion verwendet wird, wird das indexbasierte Feld colorId automatisch auf die am besten passende Option festgelegt. Optional. Die Standardeinstellung ist "False".

Autorisierung

Diese Anfrage erfordert eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Geben Sie im Anfragetext eine CalendarList-Ressource mit den folgenden Eigenschaften an:

Property-Name Wert Beschreibung Hinweise
Optionale Eigenschaften
backgroundColor string Die Hauptfarbe des Kalenders im Hexadezimalformat „#0088aa“. Diese Property ersetzt die indexbasierte Property colorId. Wenn Sie diese Property festlegen oder ändern möchten, müssen Sie colorRgbFormat=true in den Parametern der Methoden insert, update und patch angeben. Optional. Bearbeitbar
colorId string Die Farbe des Kalenders. Dies ist eine ID, die sich auf einen Eintrag im Abschnitt calendar der Farbdefinition bezieht (siehe Farbenendpunkt). Diese Property wird durch die Properties backgroundColor und foregroundColor ersetzt und kann bei Verwendung dieser Properties ignoriert werden. Optional. Bearbeitbar
defaultReminders[] list Die Standarderinnerungen, die der authentifizierte Nutzer für diesen Kalender hat. Bearbeitbar
defaultReminders[].method string Die von dieser Erinnerung verwendete Methode. Mögliche Werte sind:
  • „email“: Erinnerungen werden per E-Mail gesendet.
  • „popup“: Erinnerungen werden über ein Pop-up in der Benutzeroberfläche gesendet.

Erforderlich, wenn Sie eine Erinnerung hinzufügen.

 Bearbeitbar
defaultReminders[].minutes integer Anzahl der Minuten vor Beginn der Veranstaltung, zu der die Erinnerung ausgelöst werden soll. Gültige Werte liegen zwischen 0 und 40.320 (4 Wochen in Minuten).

Erforderlich, wenn Sie eine Erinnerung hinzufügen.

 Bearbeitbar
foregroundColor string Die Vordergrundfarbe des Kalenders im Hexadezimalformat „#ffffff“. Diese Property ersetzt die indexbasierte Property colorId. Wenn Sie diese Property festlegen oder ändern möchten, müssen Sie colorRgbFormat=true in den Parametern der Methoden insert, update und patch angeben. Optional. Bearbeitbar
hidden boolean Gibt an, ob der Kalender aus der Liste ausgeblendet wurde. Optional. Das Attribut wird nur zurückgegeben, wenn der Kalender ausgeblendet ist. In diesem Fall ist der Wert true. Bearbeitbar
notificationSettings object Die Benachrichtigungen, die der authentifizierte Nutzer für diesen Kalender erhält. Bearbeitbar
notificationSettings.notifications[].method string Die Methode, mit der die Benachrichtigung gesendet wurde. Möglicher Wert:
  • „email“: Benachrichtigungen werden per E-Mail gesendet.

Erforderlich, wenn Sie eine Benachrichtigung hinzufügen.

 Bearbeitbar
notificationSettings.notifications[].type string Die Art der Benachrichtigung. Mögliche Werte sind:
  • „eventCreation“: Benachrichtigung, die gesendet wird, wenn ein neuer Termin in den Kalender eingetragen wird.
  • „eventChange“: Benachrichtigung, die gesendet wird, wenn ein Ereignis geändert wird.
  • „eventCancellation“: Benachrichtigung, die gesendet wird, wenn ein Termin abgesagt wird.
  • „eventResponse“: Benachrichtigung, die gesendet wird, wenn ein Teilnehmer auf die Einladung zur Veranstaltung reagiert.
  • „agenda“: Eine Terminübersicht mit den Ereignissen des Tages (wird morgens gesendet).

Erforderlich, wenn Sie eine Benachrichtigung hinzufügen.

 Bearbeitbar
selected boolean Ob die Kalenderinhalte in der Kalender-Benutzeroberfläche angezeigt werden. Optional. Die Standardeinstellung ist "False". Bearbeitbar
summaryOverride string Die Zusammenfassung, die der authentifizierte Nutzer für diesen Kalender festgelegt hat. Optional. Bearbeitbar

Antwort

Bei Erfolg gibt diese Methode eine CalendarList-Ressource im Antworttext zurück.

Beispiele

Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.

Java

Verwendet die Java-Clientbibliothek.

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

Verwendet die Python-Clientbibliothek.

# 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

Verwendet die PHP-Clientbibliothek.

// 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

Verwendet die Ruby-Clientbibliothek.

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

Testen!

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen.