CalendarList

Die Sammlung von Kalendern in der Kalenderliste des Nutzers. Siehe auch Kalender im Vergleich zu CalendarList.

Am Ende dieser Seite finden Sie eine Liste der Methoden für diese Ressource.

Ressourcendarstellungen

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
Property-Name Wert Beschreibung Hinweise
accessRole string Die effektive Zugriffsrolle, die der authentifizierte Nutzer für den Kalender hat. Schreibgeschützt. Mögliche Werte:
  • „freeBusyReader“: Ermöglicht den Lesezugriff auf Informationen zur Verfügbarkeit.
  • „reader“: Ermöglicht den Lesezugriff auf den Kalender. Private Termine werden Nutzern mit Lesezugriff angezeigt, Termindetails sind jedoch ausgeblendet.
  • „writer“: Gewährt Lese‑ und Schreibzugriff auf den Kalender. Private Termine werden Nutzern mit Schreibzugriff angezeigt und Termindetails sind sichtbar.
  • „owner“: Ermöglicht dem Administrator Zugriff auf den Kalender. Diese Rolle hat alle Berechtigungen der Rolle „Autor“ und kann zusätzlich die Zugriffsebenen anderer Nutzer aufrufen und ändern.

backgroundColor string Die Hauptfarbe des Kalenders im Hexadezimalformat „#0088aa“. Diese Property ersetzt die indexbasierte Property 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 colors-Endpunkt). Diese Property wird durch die Properties backgroundColor und foregroundColor ersetzt und kann ignoriert werden, wenn diese Properties verwendet werden. Optional. Bearbeitbar
conferenceProperties nested object Konferenzeigenschaften für diesen Kalender, z. B. welche Arten von Konferenzen zulässig sind.
conferenceProperties.allowedConferenceSolutionTypes[] list Die Arten von Konferenzlösungen, die für diesen Kalender unterstützt werden.

Die möglichen Werte sind:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Optional.
dataOwner string Die E-Mail-Adresse des Inhabers des Kalenders. Nur für sekundäre Kalender festgelegt. Schreibgeschützt.
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:
  • „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 des Termins, 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
deleted boolean Gibt an, ob dieser Kalender-Listeneintrag aus der Kalenderliste gelöscht wurde. Schreibgeschützt. Optional. Die Standardeinstellung ist "False".
description string Beschreibung des Kalenders. Optional. Schreibgeschützt.
etag etag ETag der Ressource.
foregroundColor string Die Vordergrundfarbe des Kalenders im Hexadezimalformat „#ffffff“. Diese Property ersetzt die indexbasierte Property 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 ist der Wert true. Bearbeitbar
id string Kennung des Kalenders.
kind string Typ der Ressource („calendar#calendarListEntry“).
location string Geografischer Standort des Kalenders als Freiformtext. Optional. Schreibgeschützt.
notificationSettings object Die Benachrichtigungen, die der authentifizierte Nutzer für diesen Kalender erhält. Bearbeitbar
notificationSettings.notifications[] list Die Liste der für diesen Kalender festgelegten Benachrichtigungen.
notificationSettings.notifications[].method string Die Methode, mit der die Benachrichtigung zugestellt wurde. 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:
  • „eventCreation“: Benachrichtigung, die gesendet wird, wenn ein neuer Termin in den Kalender eingetragen wird.
  • „eventChange“: Benachrichtigung, die gesendet wird, wenn ein Termin 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 antwortet.
  • „agenda“: Eine Agenda mit den Ereignissen des Tages (wird morgens gesendet).

Erforderlich beim Hinzufügen einer Benachrichtigung.

 Bearbeitbar
primary boolean Gibt an, ob der Kalender der primäre Kalender des authentifizierten Nutzers ist. Schreibgeschützt. Optional. Die Standardeinstellung ist "False".
selected boolean Gibt an, ob die Kalenderinhalte in der Kalender-Benutzeroberfläche angezeigt werden. Optional. Die Standardeinstellung ist "False". Bearbeitbar
summary string Titel des Kalenders. Schreibgeschützt.
summaryOverride string Die Zusammenfassung, die der authentifizierte Nutzer für diesen Kalender festgelegt hat. Optional. Bearbeitbar
timeZone string Die Zeitzone des Kalenders. Optional. Schreibgeschützt.

Methoden

Delete
Entfernt einen Kalender aus der Kalenderliste des Nutzers.
get
Gibt einen Kalender aus der Kalenderliste des Nutzers zurück.
insert
Fügt einen vorhandenen Kalender in die Kalenderliste des Nutzers ein.
list
Gibt die Kalender in der Kalenderliste des Nutzers zurück.
patch
Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass für jede Patch-Anfrage drei Kontingenteinheiten verbraucht werden. Verwenden Sie daher lieber ein get gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Array-Felder überschreiben, sofern angegeben, die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
Aktualisieren
Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers.
Smartwatch
Nach Änderungen an CalendarList-Ressourcen suchen.