CalendarList: update

Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers. Probieren Sie es jetzt aus oder sehen Sie sich ein Beispiel an.

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 zum Abrufen von Kalender-IDs die Methode calendarList.list auf. Wenn Sie auf den Hauptkalender des derzeit angemeldeten Nutzers zugreifen möchten, verwenden Sie die „primary“ Keyword.
Optionale Abfrageparameter
colorRgbFormat boolean Gibt an, ob die Felder foregroundColor und backgroundColor zum Schreiben der Kalenderfarben (RGB) verwendet werden sollen. Wenn diese Funktion verwendet wird, wird das indexbasierte Feld colorId automatisch auf die beste Übereinstimmungsoption festgelegt. Optional. Die Standardeinstellung ist "False".

Autorisierung

Für diese Anfrage ist eine Autorisierung mit folgendem Bereich erforderlich:

Umfang
https://www.googleapis.com/auth/calendar

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Geben Sie im Anfragetext eine calendarList-Ressource mit den folgenden Attributen an:

Property-Name Wert Beschreibung Hinweise
Optionale Attribute
backgroundColor string Die Hauptfarbe des Kalenders im Hexadezimalformat „#0088aa“. Dieses Attribut ersetzt das indexbasierte Attribut colorId. Wenn Sie diese Eigenschaft 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 Endpunkt für Farben). Diese Eigenschaft wird durch die Attribute backgroundColor und foregroundColor ersetzt und kann bei Verwendung dieser Eigenschaften ignoriert werden. Optional. Bearbeitbar
defaultReminders[] list Die Standarderinnerungen des authentifizierten Nutzers für diesen Kalender. 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-Fenster auf der Benutzeroberfläche gesendet.

Erforderlich beim Hinzufügen einer Erinnerung.

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

Erforderlich beim Hinzufügen einer Erinnerung.

 Bearbeitbar
foregroundColor string Die Vordergrundfarbe des Kalenders im Hexadezimalformat „#ffffff“. Dieses Attribut ersetzt das indexbasierte Attribut colorId. Wenn Sie diese Eigenschaft 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 in der Liste ausgeblendet wurde. Optional. Das Attribut wird nur zurückgegeben, wenn der Kalender ausgeblendet ist. In diesem Fall lautet der Wert true. Bearbeitbar
notificationSettings object Die Benachrichtigungen, die der authentifizierte Nutzer für diesen Kalender erhält. Bearbeitbar
notificationSettings.notifications[].method string Die zum Senden der Benachrichtigung verwendete Methode. Möglicher Wert:
  • „email“ – Benachrichtigungen werden per E-Mail gesendet.

Erforderlich beim Hinzufügen einer Benachrichtigung.

 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 bei Änderung eines Termins gesendet wird.
  • „eventCancellation“ – Benachrichtigung, die beim Absagen eines Termins gesendet wird.
  • „eventResponse“ - Benachrichtigung, die gesendet wird, wenn ein Teilnehmer auf die Termineinladung antwortet.
  • „agenda“ - Eine Terminübersicht mit den Terminen des Tages (am Morgen gesendet)

Erforderlich beim Hinzufügen einer Benachrichtigung.

 Bearbeitbar
selected boolean Gibt an, ob der Kalenderinhalt in der Kalender-Benutzeroberfläche angezeigt wird. Optional. Die Standardeinstellung ist "False". Bearbeitbar
summaryOverride string Die Zusammenfassung, die der authentifizierte Nutzer für diesen Kalender festgelegt hat. Optional. Bearbeitbar

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine calendarList-Ressource im Antworttext zurückgegeben.

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.