CalendarList: insert

Fügt einen vorhandenen Kalender in die Kalenderliste des Nutzers ein. Jetzt testen oder Beispiel ansehen

Anfragen

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Optionale Suchparameter
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 am besten passende Option gesetzt. Optional. Die Standardeinstellung ist "False".

Autorisierung

Für diese Anfrage ist eine Autorisierung in folgendem Umfang 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:

Attributname Wert Beschreibung Hinweise
Erforderliche Properties
id string ID des Kalenders
Optionale Attribute
backgroundColor string Die Hauptfarbe des Kalenders im Hexadezimalformat "#0088aa". Diese Eigenschaft ersetzt die indexbasierte Eigenschaft 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. Diese ID verweist auf einen Eintrag im Abschnitt calendar der Farbdefinition (siehe Farbendpunkt). Dieses Attribut wird durch das Attribut backgroundColor und foregroundColor ersetzt und kann bei Verwendung dieser Attribute 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-Fenster auf der Benutzeroberfläche gesendet.

Erforderlich beim Hinzufügen einer Erinnerung.

 Bearbeitbar
defaultReminders[].minutes integer Anzahl der Minuten vor dem Termin, an dem 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". Diese Eigenschaft ersetzt die indexbasierte Eigenschaft 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 aus 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 Methode, mit der die Benachrichtigung gesendet wird. Möglicher Wert ist:
  • „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 wird gesendet, wenn ein neuer Termin in den Kalender eingetragen wird.
  • „eventChange“ – Benachrichtigung wird gesendet, wenn ein Ereignis geändert wird.
  • „eventCancellation“ – Benachrichtigung wird gesendet, wenn ein Ereignis abgesagt wird.
  • „eventResponse“: Die Benachrichtigung wird gesendet, wenn ein Teilnehmer auf die Einladung antwortet.
  • „agenda“ – Eine Terminübersicht mit den Ereignissen des Tages (am Morgen gesendet).

Erforderlich beim Hinzufügen einer Benachrichtigung.

 Bearbeitbar
selected boolean Gibt an, ob der Kalenderinhalt in der Kalenderbenutzeroberflä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();

// Create a new calendar list entry
CalendarListEntry calendarListEntry = new CalendarListEntry();
calendarListEntry.setId("calendarId");

// Insert the new calendar list entry
CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute();

System.out.println(createdCalendarListEntry.getSummary());

Python

Verwendet die Python-Clientbibliothek.

calendar_list_entry = {
    'id': 'calendarId'
}

created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute()

print created_calendar_list_entry['summary']

PHP

Verwendet die PHP-Clientbibliothek.

$calendarListEntry = new Google_Service_Calendar_CalendarListEntry();
$calendarListEntry->setId("calendarId");

$createdCalendarListEntry = $service->calendarList->insert($calendarListEntry);

echo $createdCalendarListEntry->getSummary();

Ruby

Verwendet die Ruby-Clientbibliothek.

entry = Google::Apis::CalendarV3::CalendarListEntry.new(
 id: 'calendarId'
)

result = client.insert_calendar_list(entry)
print result.summary

Testen!

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