CalendarList

Die Sammlung von Kalendern in der Kalenderliste des Nutzers. Weitere Informationen finden Sie unter Kalender vs. 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 gültige Zugriffsrolle, die der authentifizierte Nutzer für den Kalender hat. Schreibgeschützt. Mögliche Werte sind: „freeBusyReader“ – Bietet Lesezugriff auf Verfügbarkeitsinformationen. „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 Schreibberechtigung angezeigt und Termindetails werden angezeigt. „owner“ – Eigentümer des Kalenders Diese Rolle verfügt über alle Berechtigungen der Rolle „Writer“, bietet zusätzlich die Möglichkeit, ACLs aufzurufen und zu bearbeiten.
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
conferenceProperties	nested object	Konferenzeigenschaften für diesen Kalender, z. B. welche Arten von Konferenzen erlaubt 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 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
deleted	boolean	Gibt an, ob dieser Eintrag in der Kalenderliste aus der Kalenderliste gelöscht wurde. Schreibgeschützt. Optional. Die Standardeinstellung ist "False".
description	string	Beschreibung des Kalenders. Optional. Schreibgeschützt.
etag	etag	Das ETag der Ressource.
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
id	string	ID des Kalenders.
kind	string	Typ der Ressource ("calendar#calendarListEntry").
location	string	Geografischer Standort des Kalenders als Freitext. 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 eingerichteten Benachrichtigungen.
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
primary	boolean	Gibt an, ob der Kalender der Hauptkalender 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

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 jede Patchanfrage drei Kontingenteinheiten verbraucht. verwenden Sie am besten get gefolgt von update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Sofern angegeben, werden die vorhandenen Arrays mit Array-Feldern überschrieben. Dadurch werden alle vorherigen Array-Elemente verworfen.

Update

Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers.

uhr

Achten Sie auf Änderungen an CalendarList-Ressourcen.