CalendarList

Die Sammlung der Kalender in der Kalenderliste des Nutzers. Weitere Informationen finden Sie unter 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,
  "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 sind:
  • "freeBusyReader": Bietet Lesezugriff auf Informationen zur Verfügbarkeit.
  • "reader": Bietet Lesezugriff auf den Kalender. Private Termine werden Nutzern mit Lesezugriff angezeigt, die Termindetails werden jedoch ausgeblendet.
  • writer“: bietet Lese- und Schreibzugriff auf den Kalender. Private Termine werden Nutzern mit Autorenzugriff angezeigt. Die Termindetails sind sichtbar.
  • "owner": Eigentümer des Kalenders. Diese Rolle verfügt über alle Berechtigungen der Rolle „Autor“ und bietet zusätzlich die Möglichkeit, ACLs aufzurufen und zu bearbeiten.
backgroundColor string Die Hauptfarbe des Kalenders im Hexadezimalformat „#0088aa“. Diese Eigenschaft ersetzt die indexbasierte Eigenschaft colorId. Um dieses Attribut festzulegen oder zu ändern, 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). Dieses Attribut wird durch die Properties backgroundColor und foregroundColor ersetzt und kann ignoriert werden, wenn Sie diese Attribute verwenden. 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.

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 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
deleted boolean Gibt an, ob dieser Kalenderlisteneintrag 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 Eigenschaft ersetzt die indexbasierte Eigenschaft colorId. Um dieses Attribut festzulegen oder zu ändern, 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
id string ID des Kalenders.
kind string Typ der Ressource ("calendar#calendarListEntry").
location string Der geografische Standort des Kalenders im freien Textformat. 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 zum Senden der Benachrichtigung verwendete Methode. Möglicher Wert:
  • email“: Benachrichtigungen werden per E‐Mail gesendet.

Erforderlich, wenn eine Benachrichtigung hinzugefügt wird.

Bearbeitbar
notificationSettings.notifications[].type string Die Art der Benachrichtigung. Mögliche Werte sind:
  • eventCreation“: Benachrichtigung, die gesendet wird, wenn ein neuer Termin im 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 Termineinladung antwortet.
  • agenda“: eine Terminübersicht mit den Terminen des Tages, die am Morgen gesendet wird.

Erforderlich, wenn eine Benachrichtigung hinzugefügt wird.

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 der Kalenderinhalt in der Kalender-Benutzeroberfläche angezeigt wird. 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
Der Kalender wird aus der Kalenderliste des Nutzers entfernt.
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. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise sollte get gefolgt von update verwendet werden. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, sofern angegeben, überschreiben die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
Aktualisieren
Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers.
Smartwatch
Achten Sie auf Änderungen an Kalenderlisten-Ressourcen.