Calendars

Eine Sammlung aller vorhandenen Kalender. Weitere Informationen finden Sie unter Calendars vs CalendarList.

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

Ressourcendarstellungen

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
Property-Name Wert Beschreibung Hinweise
autoAcceptInvitations boolean Gibt an, ob dieser Kalender Einladungen automatisch annimmt. Nur für Ressourcenkalender gültig.
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.
description string Beschreibung des Kalenders. Optional. Bearbeitbar
etag etag ETag der Ressource.
id string ID des Kalenders. Rufen Sie die Methode calendarList.list() auf, um IDs abzurufen.
kind string Typ der Ressource („calendar#calendar“).
labelProperties nested object In diesem Kalender definierte Label-Eigenschaften. Wenn angegeben, werden die vorhandenen Labelattribute überschrieben. Wenn nichts angegeben ist, bleiben die Labelattribute unverändert. Bearbeitbar
labelProperties.eventLabels[] list In diesem Kalender definierte Terminlabels. Wenn dieses Feld beim Aktualisieren des Kalenders vorhanden ist, werden die vorhandenen Terminlabels ersetzt.

Erweitern Sie die Liste, um ein neues Terminlabel hinzuzufügen, und entfernen Sie Entitäten aus der Liste, um ein Label aus dem Kalender zu löschen.

Jeder Kalender kann maximal 200 Labels haben.

Bearbeitbar
labelProperties.eventLabels[].backgroundColor string Hintergrundfarbe des Labels im Hexadezimalformat, z. B. "#039be5". Termine mit diesem Label werden in dieser Farbe angezeigt. Erforderlich. Bearbeitbar
labelProperties.eventLabels[].id string Die ID des Labels. Optional beim Einfügen eines neuen Labels. Wenn nicht angegeben, wird eine eindeutige ID generiert. Erforderlich, wenn ein Label aktualisiert wird.

Wenn eine ID angegeben wird, muss sie im Kalender eindeutig sein und dem UUID-Format entsprechen.

Bearbeitbar
labelProperties.eventLabels[].name string Der Name des Labels Optional.

Falls angegeben, darf dieser Wert höchstens 50 Zeichen lang sein.

Bearbeitbar
location string Geografischer Standort des Kalenders als Freiformtext. Optional. Bearbeitbar
summary string Titel des Kalenders. Bearbeitbar
timeZone string Die Zeitzone des Kalenders. (Formatiert als Name aus der IANA-Zeitzonendatenbank, z.B. „Europe/Zurich“.) Optional. Bearbeitbar
workingHours object Stellt die Informationen zu den Arbeitszeiten des Nutzers dar. Nur für primäre Kalender von Google Workspace-Nutzern verfügbar. Wenn Sie die Arbeitszeit aktualisieren möchten, muss das gesamte Arbeitszeitobjekt übergeben werden. Wenn nicht angegeben (oder als „null“ oder leeres Objekt übergeben), bleiben die vorhandenen Arbeitszeiten unverändert. Wenn Sie die Arbeitszeit deaktivieren oder den Zeitplan löschen möchten, setzen Sie workingHoursEnabled auf „false“ und lassen Sie availableTimes weg oder übergeben Sie eine leere Liste. Bearbeitbar
workingHours.availableTimes[] list Arbeitszeit Jeder Verfügbarkeitszeitraum stellt den Arbeitszeitblock des Nutzers an einem Tag dar. Bearbeitbar
workingHours.availableTimes[].dayOfWeek string Wochentag Erforderlich. Mögliche Werte sind:
  • „monday“
  • „tuesday“
  • „wednesday“
  • „thursday“
  • „friday“
  • „saturday“
  • „sunday“
Bearbeitbar
workingHours.availableTimes[].periodEnd integer Ende des Zeitraums in Minuten ab Beginn des Tages (exklusiv). Erforderlich. Bearbeitbar
workingHours.availableTimes[].periodStart integer Beginn des Zeitraums in Minuten ab Tagesbeginn (einschließlich). Erforderlich. Bearbeitbar
workingHours.workingHoursEnabled boolean Gibt an, ob die Arbeitszeiten für diesen Kalender aktiviert sind. Kann nicht auf „true“ gesetzt werden, wenn availableTimes leer ist. Bearbeitbar

Methoden

klarer
Löscht einen Hauptkalender. Bei diesem Vorgang werden alle Termine gelöscht, die mit dem primären Kalender eines Kontos verknüpft sind.
Delete
Löscht einen sekundären Kalender. Verwenden Sie „calendars.clear“, um alle Termine in primären Kalendern zu löschen.
get
Gibt Metadaten für einen Kalender zurück.
insert
Erstellt einen sekundären Kalender.

Der authentifizierte Nutzer für die Anfrage wird zum Dateninhaber des neuen Kalenders.

patch
Aktualisiert die Metadaten für einen Kalender. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass für jede Patch-Anfrage drei Kontingenteinheiten verbraucht werden. Verwenden Sie daher am besten 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. Array-Felder überschreiben, falls angegeben, die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
transferOwnership
Überträgt einen sekundären Kalender zwischen Nutzern innerhalb einer Google Workspace-Organisation. Erfordert die Nutzerauthentifizierung mit der Administratorberechtigung Kalender verwalten und einen der folgenden Autorisierungsbereiche:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
Legen Sie in der Anfrage für useAdminAccess true fest. Der sekundäre Kalender muss aktiv sein, damit er übertragen werden kann. Die Übertragung deaktivierter oder gelöschter Kalender wird nicht unterstützt.
update
Aktualisiert die Metadaten für einen Kalender.