Events

Die Calendar API bietet verschiedene Varianten von Terminressourcen. Weitere Informationen finden Sie unter Termine.

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

Ressourcendarstellungen

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Property-Name Wert Beschreibung Hinweise
anyoneCanAddSelf boolean Gibt an, ob jeder sich selbst zum Termin einladen kann (eingestellt). Optional. Die Standardeinstellung ist "False". Bearbeitbar
attachments[] list Dateianhänge für den Termin.

Wenn Sie Anhänge ändern möchten, muss der Anfrageparameter supportsAttachments auf true festgelegt werden.

Pro Termin sind maximal 25 Anhänge zulässig.

attachments[].fileId string ID der angehängten Datei. Schreibgeschützt.

Bei Google Drive-Dateien ist dies die ID des entsprechenden Files-Ressourceneintrags in der Drive API.

attachments[].fileUrl string URL-Link zum Anhang.

Verwenden Sie zum Hinzufügen von Google Drive-Dateianhängen dasselbe Format wie im Attribut alternateLink der Ressource Files in der Drive API.

Erforderlich beim Hinzufügen eines Anhangs.

Bearbeitbar
attachments[].mimeType string Internetmedientyp (MIME-Typ) des Anhangs.
attachments[].title string Titel des Anhangs.
attendeesOmitted boolean Gibt an, ob Teilnehmer in der Darstellung des Termins weggelassen wurden. Beim Abrufen eines Ereignisses kann dies an einer Einschränkung liegen, die durch den Abfrageparameter maxAttendee angegeben wird. Beim Aktualisieren eines Termins kann damit nur die Antwort des Teilnehmers aktualisiert werden. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[] list Die Teilnehmer des Termins. Weitere Informationen zur Planung von Terminen mit anderen Kalendernutzern finden Sie im Leitfaden Termine mit Teilnehmern. Dienstkonten müssen eine domainweite Delegierung von Befugnissen verwenden, um die Teilnehmerliste zu füllen. Bearbeitbar
attendees[].additionalGuests integer Anzahl der zusätzlichen Gäste. Optional. Der Standardwert ist 0. Bearbeitbar
attendees[].comment string Der Kommentar des Teilnehmers. Optional. Bearbeitbar
attendees[].displayName string Der Name des Gastes, falls verfügbar. Optional. Bearbeitbar
attendees[].email string Die E-Mail-Adresse des Gastes, falls verfügbar. Dieses Feld muss vorhanden sein, wenn ein Gast hinzugefügt wird. Es muss eine gültige E-Mail-Adresse gemäß RFC5322 sein.

Erforderlich beim Hinzufügen eines Gastes.

Bearbeitbar
attendees[].id string Die Profil-ID des Teilnehmers, falls verfügbar.
attendees[].optional boolean Gibt an, ob dies ein optionaler Gast ist. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[].organizer boolean Gibt an, ob der Gast der Organisator des Termins ist. Schreibgeschützt. Die Standardeinstellung ist "False".
attendees[].resource boolean Gibt an, ob der Gast eine Ressource ist. Kann nur festgelegt werden, wenn ein Gast zum ersten Mal dem Termin hinzugefügt wird. Nachfolgende Änderungen werden ignoriert. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[].responseStatus string Der Antwortstatus des Gastes. Mögliche Werte sind:
  • "needsAction": Der Teilnehmer hat nicht auf die Einladung geantwortet (für neue Termine empfohlen).
  • "declined": Der Teilnehmer hat die Einladung abgelehnt.
  • "tentative": Der Teilnehmer hat die Einladung vorläufig angenommen.
  • "accepted": Der Teilnehmer hat die Einladung angenommen.
Bearbeitbar
attendees[].self boolean Gibt an, ob dieser Eintrag den Kalender darstellt, in dem diese Kopie des Termins angezeigt wird. Schreibgeschützt. Die Standardeinstellung ist "False".
colorId string Die Farbe des Termins. Dies ist eine ID, die sich auf einen Eintrag im Abschnitt event der Farbdefinition bezieht (siehe Endpunkt für Farben). Optional. Bearbeitbar
conferenceData nested object Informationen zur Konferenz, z. B. Details zu einer Google Meet-Konferenz Verwenden Sie das Feld createRequest, um neue Konferenzdetails zu erstellen. Damit Ihre Änderungen erhalten bleiben, müssen Sie den conferenceDataVersion-Anfrageparameter für alle Anfragen zur Ereignisänderung auf 1 setzen. Bearbeitbar
conferenceData.conferenceId string Die ID der Konferenz.

Kann von Entwicklern verwendet werden, um Konferenzen im Blick zu behalten, sollte Nutzern nicht angezeigt werden.

Der ID-Wert wird für jeden Konferenzlösungstyp unterschiedlich gebildet:

  • eventHangout: ID ist nicht festgelegt. (Dieser Konferenztyp wurde eingestellt.)
  • eventNamedHangout: Die ID ist der Name des Hangouts. (Dieser Konferenztyp wurde eingestellt.)
  • hangoutsMeet: Die ID ist der aus zehn Buchstaben bestehende Besprechungscode, z. B. aaa-bbbb-ccc.
  • addOn: Die ID wird vom Drittanbieter definiert.
Optional.

conferenceData.conferenceSolution nested object Die Konferenzlösung, z. B. Google Meet.

Die Festlegung für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage wurde aufgehoben.

Entweder conferenceSolution und mindestens ein entryPoint- oder createRequest-Wert ist erforderlich.

conferenceData.conferenceSolution.iconUri string Das für den Nutzer sichtbare Symbol für diese Lösung.
conferenceData.conferenceSolution.key nested object Der Schlüssel, der die Konferenzlösung für diese Veranstaltung eindeutig identifizieren kann.
conferenceData.conferenceSolution.key.type string Der Konferenzlösungstyp.

Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollten die Einstiegspunkte weiterhin angezeigt werden können. Änderungen sind jedoch nicht möglich.

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; dieser Konferenzlösungstyp wird möglicherweise in bestehenden Terminen angezeigt, es können aber keine neuen Konferenzen erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace (eingestellt; in bestehenden Terminen wird möglicherweise dieser Konferenzlösungstyp angezeigt; neue Konferenzen können nicht erstellt werden)
  • "hangoutsMeet" für Google Meet (http://meet.google.com)
  • "addOn" für Drittanbieter-Konferenzanbieter

conferenceData.conferenceSolution.name string Der für den Nutzer sichtbare Name dieser Lösung. Nicht lokalisiert.
conferenceData.createRequest nested object Eine Anfrage zum Erstellen einer neuen Konferenz und zum Anhängen an den Termin. Die Daten werden asynchron generiert. Im Feld status sehen Sie, ob die Daten vorhanden sind.

Entweder conferenceSolution und mindestens ein entryPoint- oder createRequest-Wert ist erforderlich.

conferenceData.createRequest.conferenceSolutionKey nested object Die Konferenzlösung, z. B. Hangouts oder Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Der Konferenzlösungstyp.

Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollten die Einstiegspunkte weiterhin angezeigt werden können. Änderungen sind jedoch nicht möglich.

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; dieser Konferenzlösungstyp wird möglicherweise in bestehenden Terminen angezeigt, es können aber keine neuen Konferenzen erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace (eingestellt; in bestehenden Terminen wird möglicherweise dieser Konferenzlösungstyp angezeigt; neue Konferenzen können nicht erstellt werden)
  • "hangoutsMeet" für Google Meet (http://meet.google.com)
  • "addOn" für Drittanbieter-Konferenzanbieter

conferenceData.createRequest.requestId string Die vom Client generierte eindeutige ID für diese Anfrage.

Clients sollten diese ID für jede neue Anfrage neu generieren. Wenn die angegebene ID mit der der vorherigen Anfrage übereinstimmt, wird die Anfrage ignoriert.

conferenceData.createRequest.status nested object Der Status der Anfrage zum Erstellen einer Konferenz.
conferenceData.createRequest.status.statusCode string Der aktuelle Status der Anfrage zum Erstellen einer Konferenz. Schreibgeschützt.

Die möglichen Werte sind:

  • "pending": Die Anfrage zum Erstellen einer Konferenz wird noch verarbeitet.
  • "success": Die Anfrage zum Erstellen der Konferenz war erfolgreich. Die Einstiegspunkte sind ausgefüllt.
  • "failure": Anfrage zum Erstellen der Konferenz ist fehlgeschlagen. Es sind keine Einstiegspunkte vorhanden.

conferenceData.entryPoints[] list Informationen zu einzelnen Konferenzeinstiegspunkten, z. B. URLs oder Telefonnummern.

Alle müssen zur selben Konferenz gehören.

Entweder conferenceSolution und mindestens ein entryPoint- oder createRequest-Wert ist erforderlich.

conferenceData.entryPoints[].accessCode string Der Zugangscode für den Zugriff auf die Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von {meetingCode, accessCode, passcode, password, pin} aus, die mit der Terminologie übereinstimmen, die der Konferenzanbieter verwendet. Es sollten nur die ausgefüllten Felder angezeigt werden.

Optional.

conferenceData.entryPoints[].entryPointType string Der Typ des Konferenzeinstiegspunkts.

Folgende Werte sind möglich:

  • "video": Über HTTP an einer Konferenz teilnehmen. Eine Konferenz kann keinen oder einen video-Einstiegspunkt haben.
  • "phone" – Durch Wählen einer Telefonnummer an einer Konferenz teilnehmen. Eine Konferenz kann keinen oder mehr phone-Einstiegspunkte haben.
  • "sip" – über SIP an einer Konferenz teilnehmen. Eine Konferenz kann keinen oder einen sip-Einstiegspunkt haben.
  • "more": Anleitungen zur Teilnahme an einer Konferenz, z. B. zusätzliche Telefonnummern Eine Konferenz kann keinen oder einen more-Einstiegspunkt haben. Eine Konferenz mit dem Einstiegspunkt more ist keine gültige Konferenz.

conferenceData.entryPoints[].label string Das Label für den URI. Für Endnutzer sichtbar. Nicht lokalisiert. Die maximale Länge beträgt 512 Zeichen.

Beispiele:

  • für video: meet.google.com/aaa-bbbb-ccc
  • für phone: +1 123 268 2601
  • für sip: 12345678@altostrat.com
  • für more: sollte nicht ausgefüllt werden

Optional.

conferenceData.entryPoints[].meetingCode string Der Besprechungscode für die Teilnahme an der Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von {meetingCode, accessCode, passcode, password, pin} aus, die mit der Terminologie übereinstimmen, die der Konferenzanbieter verwendet. Es sollten nur die ausgefüllten Felder angezeigt werden.

Optional.

conferenceData.entryPoints[].passcode string Den Sicherheitscode für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von {meetingCode, accessCode, passcode, password, pin} aus, die mit der Terminologie übereinstimmen, die der Konferenzanbieter verwendet. Es sollten nur die ausgefüllten Felder angezeigt werden.

conferenceData.entryPoints[].password string Das Passwort für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von {meetingCode, accessCode, passcode, password, pin} aus, die mit der Terminologie übereinstimmen, die der Konferenzanbieter verwendet. Es sollten nur die ausgefüllten Felder angezeigt werden.

Optional.

conferenceData.entryPoints[].pin string Die PIN für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von {meetingCode, accessCode, passcode, password, pin} aus, die mit der Terminologie übereinstimmen, die der Konferenzanbieter verwendet. Es sollten nur die ausgefüllten Felder angezeigt werden.

Optional.

conferenceData.entryPoints[].uri string Der URI des Einstiegspunkts. Die maximale Länge beträgt 1.300 Zeichen.

Format:

  • für video, http: oder https: ist erforderlich.
  • Für phone ist tel:-Schema erforderlich. Der URI sollte die gesamte Sequenz der Einwahl enthalten (z.B. tel:+12345678900,,,123456789;1234).
  • Für sip ist das sip:-Schema erforderlich, z.B. sip:12345678@meinanbieter.de.
  • für more, http: oder https: ist erforderlich.

conferenceData.notes string Zusätzliche Hinweise, die dem Nutzer angezeigt werden, z. B. Anweisungen des Domainadministrators oder rechtliche Hinweise. Kann HTML enthalten. Die maximale Länge beträgt 2.048 Zeichen. Optional.
conferenceData.signature string Die Signatur der Konferenzdaten.

Wird serverseitig generiert.

Die Festlegung für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage wurde aufgehoben.

Optional für eine Konferenz mit einer ausstehenden Erstellungsanfrage.

created datetime Erstellungszeit des Ereignisses (als RFC3339-Zeitstempel). Schreibgeschützt.
creator object Der Ersteller der Veranstaltung. Schreibgeschützt.
creator.displayName string Der Name des Creators, falls verfügbar.
creator.email string Die E-Mail-Adresse des Creators, falls verfügbar.
creator.id string Die Profil-ID des Creators, falls verfügbar.
creator.self boolean Gibt an, ob der Ersteller dem Kalender entspricht, in dem diese Kopie des Termins angezeigt wird. Schreibgeschützt. Die Standardeinstellung ist "False".
description string Beschreibung der Veranstaltung. Kann HTML enthalten. Optional. Bearbeitbar
end nested object Die (exklusive) Endzeit des Ereignisses. Bei einem wiederkehrenden Termin ist dies das Ende des ersten Termins.
end.date date Das Datum im Format „jjjj-mm-tt“, wenn es sich um einen ganztägigen Termin handelt. Bearbeitbar
end.dateTime datetime Die Uhrzeit als kombinierter Datum/Uhrzeit-Wert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist ausdrücklich in timeZone angegeben. Bearbeitbar
end.timeZone string Die Zeitzone, in der die Uhrzeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich und gibt die Zeitzone an, in der die Serie erweitert wird. Bei Einzelereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses an. Bearbeitbar
endTimeUnspecified boolean Gibt an, ob das Ende tatsächlich nicht angegeben ist. Aus Kompatibilitätsgründen wird auch dann ein Ende angegeben, wenn dieses Attribut auf „True“ gesetzt ist. Die Standardeinstellung ist "False".
etag etag ETag der Ressource.
eventType string Bestimmter Ereignistyp. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte sind:
  • "default": Ein reguläres Ereignis oder ein nicht näher angegebenes Ereignis.
  • outOfOffice“: Ein Außer-Haus-Termin.
  • focusTime“: ein Fokuszeit-Termin.
  • workingLocation“: ein Arbeitsortereignis.
Derzeit können mit der API nur Ereignisse vom Typ „default“ und „workingLocation“ erstellt werden. In späteren Versionen wird die erweiterte Unterstützung für andere Ereignistypen eingeführt.
Bearbeitbar
extendedProperties object Erweiterte Eigenschaften des Ereignisses.
extendedProperties.private object Eigenschaften, die auf die Kopie des Termins in diesem Kalender beschränkt sind. Bearbeitbar
extendedProperties.private.(key) string Der Name der Privateigenschaft und der entsprechende Wert.
extendedProperties.shared object Eigenschaften, die von Kopien des Termins in den Kalendern anderer Teilnehmer verwendet werden. Bearbeitbar
extendedProperties.shared.(key) string Der Name der gemeinsam genutzten Property und der entsprechende Wert.
focusTimeProperties nested object Fokuszeit-Ereignisdaten. Wird verwendet, wenn eventType den Wert focusTime hat. Bearbeitbar
focusTimeProperties.autoDeclineMode string Gibt an, ob Besprechungseinladungen abgelehnt werden sollen, die sich mit Fokuszeit-Terminen überschneiden. Gültige Werte sind declineNone, was bedeutet, dass keine Besprechungseinladungen abgelehnt werden, declineAllConflictingInvitations – alle in Konflikt stehenden Besprechungseinladungen, die mit dem Termin in Konflikt stehen, und declineOnlyNewConflictingInvitations, was bedeutet, dass nur neue in Konflikt stehende Besprechungseinladungen, die während des Fokuszeit-Termins eingehen, abgelehnt werden.
focusTimeProperties.chatStatus string Der Status zum Markieren des Nutzers in Google Chat und zugehörigen Produkten. Dies kann available oder doNotDisturb sein.
focusTimeProperties.declineMessage string Antwortnachricht, die festgelegt werden soll, wenn ein bestehender Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird.
gadget object Ein Gerät, das diesen Termin verlängert. Gadgets sind veraltet; diese Struktur wird stattdessen nur verwendet, um Metadaten zum Geburtstagskalender zurückzugeben.
gadget.display string Anzeigemodus des Gadgets Veraltet. Mögliche Werte sind:
  • icon“: Das Gadget wird in der Kalenderansicht neben dem Titel des Termins angezeigt.
  • "chip": Das Gadget wird angezeigt, wenn auf den Termin geklickt wird.
Bearbeitbar
gadget.height integer Die Höhe des Gadgets in Pixeln. Die Höhe muss eine Ganzzahl größer als 0 sein. Optional. Veraltet. Bearbeitbar
gadget.preferences object Einstellungen. Bearbeitbar
gadget.preferences.(key) string Der Name der Einstellung und der entsprechende Wert.
gadget.title string Der Titel des Gadgets. Veraltet. Bearbeitbar
gadget.type string Der Typ des Gadgets. Veraltet. Bearbeitbar
gadget.width integer Die Breite des Gadgets in Pixeln. Die Breite muss eine Ganzzahl größer als 0 sein. Optional. Veraltet. Bearbeitbar
guestsCanInviteOthers boolean Gibt an, ob andere Personen als der Organisator andere zum Termin einladen können. Optional. Der Standardwert ist „True“. Bearbeitbar
guestsCanModify boolean Gibt an, ob andere Gäste als der Organisator den Termin ändern können. Optional. Die Standardeinstellung ist "False". Bearbeitbar
guestsCanSeeOtherGuests boolean Gibt an, ob andere Teilnehmer als der Organisator sehen können, wer die Gäste des Termins sind. Optional. Der Standardwert ist „True“. Bearbeitbar
iCalUID string Eindeutige Kennung des Ereignisses gemäß RFC5545. Sie wird verwendet, um Termine in verschiedenen Kalendersystemen eindeutig zu identifizieren, und muss beim Importieren von Terminen über die import-Methode angegeben werden.

Beachten Sie, dass iCalUID und id nicht identisch sind und nur eines davon bei der Erstellung des Ereignisses angegeben werden sollte. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Ereignissen alle Wiederholungen eines Ereignisses unterschiedliche id-Werte haben, obwohl sie alle dieselben iCalUID-Werte haben. Wenn Sie ein Ereignis mithilfe seiner iCalUID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf. Wenn Sie ein Ereignis mithilfe seiner id abrufen möchten, rufen Sie die Methode events.get auf.

id string Intransparente Kennung des Ereignisses. Wenn Sie neue einzelne oder wiederkehrende Termine erstellen, können Sie die zugehörigen IDs angeben. Die angegebenen IDs müssen den folgenden Regeln entsprechen:
  • Für die ID sind die Zeichen in base32hex-Codierung zulässig, d. h. Kleinbuchstaben a–v und Ziffern 0–9, siehe Abschnitt 3.1.2 in RFC2938.
  • Die ID muss zwischen 5 und 1.024 Zeichen lang sein.
  • Die ID muss innerhalb eines Kalenders eindeutig sein.
Da das System weltweit verteilt ist, können wir nicht garantieren, dass ID-Kollisionen zum Zeitpunkt der Ereigniserstellung erkannt werden. Um das Risiko von Konflikten zu minimieren, empfehlen wir die Verwendung eines etablierten UUID-Algorithmus, wie etwa dem in RFC4122 beschriebenen Algorithmus.

Wenn Sie keine ID angeben, wird sie automatisch vom Server generiert.

Beachten Sie, dass icalUID und id nicht identisch sind und nur eines davon bei der Erstellung des Ereignisses angegeben werden sollte. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Ereignissen alle Wiederholungen eines Ereignisses unterschiedliche id-Werte haben, obwohl sie alle dieselben icalUID-Werte haben.

Bearbeitbar
kind string Typ der Ressource („calendar#event“)
location string Der geografische Ort des Ereignisses als Freitext. Optional. Bearbeitbar
locked boolean Gibt an, ob es sich um eine gesperrte Terminkopie handelt, bei der keine Änderungen an den Hauptterminfeldern „summary“, „description“, „location“, „start“, „end“ oder „recurrence“ vorgenommen werden können. Die Standardeinstellung ist "False". Schreibgeschützt.
organizer object Der Organisator des Termins. Wenn der Organisator auch ein Gast ist, wird dies durch einen separaten Eintrag in attendees angezeigt, wobei das Feld organizer auf „True“ gesetzt ist. Mit dem Vorgang Verschieben können Sie den Organisator ändern. Schreibgeschützt, außer beim Importieren eines Termins Bearbeitbar
organizer.displayName string Der Name des Organisators, falls verfügbar. Bearbeitbar
organizer.email string Die E-Mail-Adresse des Organisators, falls verfügbar. Es muss eine gültige E-Mail-Adresse gemäß RFC5322 sein. Bearbeitbar
organizer.id string Die Profil-ID des Organisators, falls verfügbar.
organizer.self boolean Gibt an, ob der Organisator dem Kalender entspricht, in dem diese Kopie des Termins angezeigt wird. Schreibgeschützt. Die Standardeinstellung ist "False".
originalStartTime nested object Bei einem wiederkehrenden Termin ist dies der Zeitpunkt, zu dem dieses Ereignis gemäß den Wiederholungsdaten des wiederkehrenden Termins, der durch „rekehrendEventId“ identifiziert wird, beginnen wird. Damit wird die Instanz innerhalb der wiederkehrenden Terminserie eindeutig identifiziert, auch wenn die Instanz auf eine andere Zeit verschoben wurde. Nicht veränderbar.
originalStartTime.date date Das Datum im Format „jjjj-mm-tt“, wenn es sich um einen ganztägigen Termin handelt. Bearbeitbar
originalStartTime.dateTime datetime Die Uhrzeit als kombinierter Datum/Uhrzeit-Wert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist ausdrücklich in timeZone angegeben. Bearbeitbar
originalStartTime.timeZone string Die Zeitzone, in der die Uhrzeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich und gibt die Zeitzone an, in der die Serie erweitert wird. Bei Einzelereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses an. Bearbeitbar
outOfOfficeProperties nested object Außer-Haus-Termindaten. Wird verwendet, wenn eventType den Wert outOfOffice hat. Bearbeitbar
outOfOfficeProperties.autoDeclineMode string Gibt an, ob Besprechungseinladungen abgelehnt werden sollen, die sich überschneidende Außer-Haus-Termine überschneiden. Gültige Werte sind declineNone, was bedeutet, dass keine Besprechungseinladungen abgelehnt werden; declineAllConflictingInvitations bedeutet, dass alle in Konflikt stehenden Besprechungseinladungen, die mit dem Termin in Konflikt stehen, abgelehnt werden; und declineOnlyNewConflictingInvitations, was bedeutet, dass nur neue in Konflikt stehende Besprechungseinladungen, die eintreffen, während der Außer-Haus-Termin vorhanden ist, abgelehnt werden.
outOfOfficeProperties.declineMessage string Antwortnachricht, die festgelegt werden soll, wenn ein bestehender Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird.
privateCopy boolean Wenn die Richtlinie auf „True“ gesetzt ist, ist die Ereignisweitergabe deaktiviert. Hinweis: Dies ist nicht dasselbe wie Eigenschaften für private Termine. Optional. Nicht veränderbar. Die Standardeinstellung ist "False".
recurrence[] list Liste der RRULE-, EXRULE-, RDATE- und EXDATE-Zeilen für einen wiederkehrenden Termin, wie in RFC5545 angegeben. Beachten Sie, dass DTSTART- und DTEND-Zeilen in diesem Feld nicht zulässig sind. Start- und Endzeit eines Ereignisses werden in den Feldern start und end angegeben. Bei einzelnen Terminen oder wiederkehrenden Terminen wird dieses Feld weggelassen. Bearbeitbar
recurringEventId string Bei einem wiederkehrenden Termin ist dies der id des wiederkehrenden Termins, zu dem diese Instanz gehört. Nicht veränderbar.
reminders object Informationen zu den Terminerinnerungen für den authentifizierten Nutzer.
reminders.overrides[] list Falls für den Termin keine Standarderinnerungen verwendet werden, werden hier die spezifischen Erinnerungen für den Termin angezeigt. Ist dies nicht der Fall, werden für diesen Termin keine Erinnerungen eingerichtet. Es sind maximal fünf Erinnerungen zum Überschreiben. Bearbeitbar
reminders.overrides[].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
reminders.overrides[].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
reminders.useDefault boolean Legt fest, ob die Standarderinnerungen des Kalenders für den Termin gelten. Bearbeitbar
sequence integer Sequenznummer gemäß iCalendar Bearbeitbar
source object Quelle, aus der das Ereignis erstellt wurde. Dies kann beispielsweise eine Webseite, eine E-Mail-Nachricht oder ein anderes Dokument sein, das durch eine URL mit HTTP- oder HTTPS-Schema identifiziert werden kann. Sie ist nur für den Ersteller des Termins sichtbar und kann ihn ändern.
source.title string Titel der Quelle, z. B. der Titel einer Webseite oder der Betreff einer E-Mail. Bearbeitbar
source.url string URL der Quelle, die auf eine Ressource verweist. Das URL-Schema muss HTTP oder HTTPS sein. Bearbeitbar
start nested object Die (inklusive) Startzeit des Ereignisses. Bei wiederkehrenden Terminen ist dies der Beginn des ersten Termins.
start.date date Das Datum im Format „jjjj-mm-tt“, wenn es sich um einen ganztägigen Termin handelt. Bearbeitbar
start.dateTime datetime Die Uhrzeit als kombinierter Datum/Uhrzeit-Wert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist ausdrücklich in timeZone angegeben. Bearbeitbar
start.timeZone string Die Zeitzone, in der die Uhrzeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich und gibt die Zeitzone an, in der die Serie erweitert wird. Bei Einzelereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses an. Bearbeitbar
status string Der Status des Ereignisses. Optional. Mögliche Werte sind:
  • confirmed“: Das Ereignis wurde bestätigt. Dies ist der Standardstatus.
  • "tentative": Der Termin wurde vorläufig bestätigt.
  • cancelled“: Der Termin wurde abgesagt (gelöscht). Die Methode list gibt nur bei inkrementeller Synchronisierung abgebrochene Ereignisse zurück (wenn syncToken oder updatedMin angegeben sind) oder wenn das Flag showDeleted auf true gesetzt ist. Die get-Methode gibt sie immer zurück.

    Der Status „Abgebrochen“ steht je nach Ereignistyp für zwei verschiedene Status:

    1. Stornierte Ausnahmen eines nicht stornierten wiederkehrenden Termins weisen darauf hin, dass diese Instanz dem Nutzer nicht mehr angezeigt werden soll. Kunden sollten diese Ereignisse für die Lebensdauer des wiederkehrenden übergeordneten Ereignisses speichern.

      Für abgebrochene Ausnahmen werden garantiert nur Werte für die Felder id, recurringEventId und originalStartTime ausgefüllt. Die anderen Felder sind möglicherweise leer.

    2. Alle anderen abgesagten Ereignisse sind gelöschte Ereignisse. Kunden sollten ihre lokal synchronisierten Kopien entfernen. Solche abgesagten Ereignisse werden irgendwann nicht mehr verfügbar sein. Sie sollten also nicht unbedingt auf unbestimmte Zeit verfügbar sein.

      Bei gelöschten Ereignissen ist nur garantiert, dass das Feld id ausgefüllt ist.

    Im Kalender des Organisators werden bei abgesagten Terminen weiterhin Termindetails (Zusammenfassung, Ort usw.) angezeigt, sodass sie wiederhergestellt werden können. Auch die Termine, zu denen der Nutzer eingeladen wurde und die er manuell entfernt hat, enthalten weiterhin Details. Bei inkrementellen Synchronisierungsanfragen, bei denen showDeleted auf "false" gesetzt ist, werden diese Details jedoch nicht zurückgegeben.

    Wenn der Organisator eines Termins geändert wird (z. B. mit dem Vorgang move) und der ursprüngliche Organisator nicht in der Teilnehmerliste enthalten ist, bleibt ein abgesagter Termin zurück, bei dem garantiert nur das Feld id ausgefüllt ist.

Bearbeitbar
summary string Titel der Veranstaltung. Bearbeitbar
transparency string Gibt an, ob durch den Termin Zeit im Kalender blockiert wird. Optional. Mögliche Werte sind:
  • "opaque" – Standardwert. Der Termin blockiert jedoch zwar die im Kalender angegebene Zeit. Dies entspricht der Einstellung Anzeigen als in der Google Kalender-Benutzeroberfläche auf Beschäftigt.
  • transparent“: Der Termin blockiert keine Zeit im Kalender. Dies entspricht der Einstellung Anzeigen als in der Kalender-Benutzeroberfläche auf Verfügbar.
Bearbeitbar
updated datetime Zeitpunkt der letzten Änderung des Ereignisses (als RFC3339-Zeitstempel). Schreibgeschützt.
visibility string Sichtbarkeit des Ereignisses. Optional. Mögliche Werte sind:
  • default“: Die Standardsichtbarkeit für Termine im Kalender wird verwendet. „Immer“ ist der Standardwert.
  • "public": Der Termin ist öffentlich und die Termindetails sind für alle Leser des Kalenders sichtbar.
  • "private": Dieser Termin ist privat und nur die Teilnehmer können die Termindetails sehen.
  • confidential“: Dieser Termin ist privat. Dieser Wert wird aus Kompatibilitätsgründen angegeben.
Bearbeitbar
workingLocationProperties nested object Ereignisdaten zum Arbeitsort. Bearbeitbar
workingLocationProperties.customLocation object Gibt an, dass der Nutzer von einem benutzerdefinierten Standort aus arbeitet, falls vorhanden. Bearbeitbar
workingLocationProperties.customLocation.label string Ein optionales zusätzliches Label für zusätzliche Informationen. Bearbeitbar
workingLocationProperties.homeOffice any value Gibt an, dass der Nutzer zu Hause arbeitet, falls vorhanden. Bearbeitbar
workingLocationProperties.officeLocation object Falls vorhanden, wird angegeben, dass der Nutzer im Büro arbeitet. Bearbeitbar
workingLocationProperties.officeLocation.buildingId string Eine optionale Gebäude-ID. Sie sollte auf eine Gebäude-ID in der Ressourcendatenbank der Organisation verweisen. Bearbeitbar
workingLocationProperties.officeLocation.deskId string Eine optionale Desktop-ID. Bearbeitbar
workingLocationProperties.officeLocation.floorId string Eine optionale Etagen-ID. Bearbeitbar
workingLocationProperties.officeLocation.floorSectionId string Eine optionale Etage des Stockwerks. Bearbeitbar
workingLocationProperties.officeLocation.label string Der Büroname, der in den Web- und mobilen Clients von Google Kalender angezeigt wird. Wir empfehlen, in der Ressourcendatenbank der Organisation auf einen Gebäudenamen zu verweisen. Bearbeitbar
workingLocationProperties.type string Typ des Arbeitsorts. Mögliche Werte sind:
  • homeOffice“ – Der Nutzer arbeitet von zu Hause aus.
  • officeLocation“ – Der Nutzer arbeitet im Büro.
  • customLocation“: Der Nutzer arbeitet von einem benutzerdefinierten Standort aus.
Alle Details werden in einem Unterfeld des angegebenen Namens angegeben. Dieses Feld kann jedoch fehlen, wenn es leer ist. Alle anderen Felder werden ignoriert.

Erforderlich beim Hinzufügen von Eigenschaften für den Arbeitsort.

Bearbeitbar

Methoden

delete
Löscht einen Termin.
get
Gibt einen Termin basierend auf seiner Google Kalender-ID zurück. Wenn Sie einen Termin über seine iCalendar-ID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf.
import
Importiert ein Ereignis. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt.
insert
Erstellt einen Termin.
Instanzen
Gibt Instanzen des angegebenen wiederkehrenden Termins zurück.
list
Gibt Termine für den angegebenen Kalender zurück.
Verschieben
Verschiebt einen Termin in einen anderen Kalender, d. h. ändert den Organisator des Termins Hinweis: Nur default-Ereignisse können verschoben werden. outOfOffice-, focusTime- und workingLocation-Ereignisse können nicht verschoben werden.
patch
Aktualisiert einen Termin. 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.
quickAdd
Erstellt ein Ereignis basierend auf einem einfachen Textstring.
Aktualisieren
Aktualisiert einen Termin. Diese Methode unterstützt keine Patchsemantik und aktualisiert immer die gesamte Ereignisressource. Für eine teilweise Aktualisierung führen Sie einen get gefolgt von einem update mit ETags aus, um die Atomarität sicherzustellen.
Smartwatch
Achten Sie auf Änderungen an Ereignisressourcen.