CalendarList

Die Sammlung der Kalender in der Kalenderliste des Nutzers. Weitere Informationen finden Sie unter Kalender und Kalenderliste.

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
    ]
  },
  "autoAcceptInvitations": boolean
}
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, Termindetails sind jedoch nicht verfügbar.
  • "writerWithoutPrivateAccess" – Bietet Lese- und Schreibzugriff auf den Kalender. Private Termine werden Nutzern mit Schreibzugriff ohne Zugriff auf private Termine angezeigt, Termindetails sind jedoch nicht verfügbar.
  • "writer" – Bietet Lese- und Schreibzugriff auf den Kalender. Private Termine werden Nutzern mit Schreibzugriff angezeigt und Termindetails sind sichtbar.
  • "owner" – Bietet Managerzugriff auf den Kalender. Diese Rolle hat alle Berechtigungen der Rolle „writer“ und kann zusätzlich die Zugriffsebenen anderer Nutzer sehen und ändern.

autoAcceptInvitations boolean Gibt an, ob Einladungen für diesen Kalender automatisch angenommen werden. Nur für Ressourcenkalender gültig. Schreibgeschützt.
backgroundColor string Die Hauptfarbe des Kalenders im Hexadezimalformat "#0088aa". Diese Property ersetzt die indexbasierte Property colorId. Wenn Sie diese Property festlegen oder ändern möchten, müssen Sie in den Parametern der Methoden insert, update und patch colorRgbFormat=true angeben. Optional. Bearbeitbar
colorId string Die Farbe des Kalenders. Dies ist eine ID, die auf einen Eintrag im Abschnitt calendar der Farbdefinition verweist (siehe den Endpunkt „colors“). 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.

Mögliche Werte sind:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Optional.
dataOwner string Die E-Mail-Adresse des Inhabers des Kalenders. Nur für sekundäre Kalender festlegen. Schreibgeschützt.
defaultReminders[] list Die Standarderinnerungen, die der authentifizierte Nutzer für diesen Kalender hat. Bearbeitbar
defaultReminders[].method string Die Methode, die von dieser Erinnerung verwendet wird. Mögliche Werte sind:
  • "email" – Erinnerungen werden per E-Mail gesendet.
  • "popup" – Erinnerungen werden über ein UI-Pop-up gesendet.

Erforderlich, wenn eine Erinnerung hinzugefügt wird.

 Bearbeitbar
defaultReminders[].minutes integer Anzahl der Minuten vor Beginn des Termins, zu dem die Erinnerung ausgelöst werden soll. Gültige Werte liegen zwischen 0 und 40320 (4 Wochen in Minuten).

Erforderlich, wenn eine Erinnerung hinzugefügt wird.

 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 Property ersetzt die indexbasierte Property colorId. Wenn Sie diese Property festlegen oder ändern möchten, müssen Sie in den Parametern der Methoden insert, update und patch colorRgbFormat=true 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 ID des Kalenders.
kind string Typ der Ressource („calendar#calendarListEntry“).
location string Geografischer Ort 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 festgelegten Benachrichtigungen.
notificationSettings.notifications[].method string Die Methode, die zum Senden der Benachrichtigung verwendet wird. Der mögliche Wert ist:
  • "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 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 Termineinladung antwortet.
  • "agenda" – Eine Agenda mit den Terminen des Tages (wird morgens gesendet).

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-UI 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 Patch-Anfrage drei Kontingenteinheiten verbraucht. Verwenden Sie stattdessen lieber eine get-Anfrage gefolgt von einer update-Anfrage. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Wenn Sie Arrayfelder angeben, werden die vorhandenen Arrays überschrieben. Alle vorherigen Arrayelemente werden verworfen.
update
Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers.
watch
Auf Änderungen an CalendarList-Ressourcen achten.