CalendarList

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

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 im Kalender hat. Schreibgeschützt. Mögliche Werte sind: „freeBusyReader“: bietet Lesezugriff auf Verfügbarkeitsinformationen. „reader“: Lesezugriff auf den Kalender Private Termine werden Nutzern mit Leseberechtigung angezeigt. Termindetails werden jedoch ausgeblendet. „writer“ – Lese- und Schreibzugriff auf den Kalender. Private Termine werden für Nutzer mit Schreibberechtigung angezeigt. Termindetails sind sichtbar. „owner“ – Eigentümerschaft des Kalenders Diese Rolle hat alle Berechtigungen der Rolle „Autor“ mit der zusätzlichen Möglichkeit, ACLs aufzurufen und zu bearbeiten.
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
conferenceProperties	nested object	Konferenzeigenschaften für diesen Kalender, z. B. welche Arten von Konferenzen erlaubt sind
conferenceProperties.allowedConferenceSolutionTypes[]	list	Die Arten der 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-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
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. 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
id	string	ID des Kalenders
kind	string	Typ der Ressource („calendar#calendarListEntry“).
location	string	Geografische Position des Kalenders im freien Format. Optional. Schreibgeschützt.
notificationSettings	object	Die Benachrichtigungen, die der authentifizierte Nutzer für diesen Kalender erhält.	Bearbeitbar
notificationSettings.notifications[]	list	Die Liste der Benachrichtigungen, die für diesen Kalender festgelegt wurden.
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
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 Kalenderbenutzeroberflä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	Zeitzone des Kalenders Optional. Schreibgeschützt.

Methoden

Delete

Entfernt einen Kalender aus der Kalenderliste des Nutzers.

erhalten

Gibt einen Kalender aus der Kalenderliste des Nutzers zurück.

Einfügen

Fügt einen 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 vorzugsweise ein get, gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, falls angegeben, überschreiben die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.

Aktualisieren

Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers.

ansehen

Achten Sie auf Änderungen an Kalenderlistenressourcen.