Events

Die Kalender API bietet verschiedene Typen 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 Ob jemand 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 durch den Abfrageparameter maxAttendee festgelegten Einschränkung liegen. Wenn Sie einen Termin aktualisieren, können Sie damit nur die Antwort des Teilnehmers aktualisieren. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[] list Die Teilnehmer des Termins. Weitere Informationen zum Planen von Terminen mit anderen Kalendernutzern finden Sie im Leitfaden Termine mit Teilnehmern. Bei Dienstkonten muss die domainweite Befugnisdelegation verwendet werden, 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 Kommentar zur Antwort des Teilnehmers. Optional. Bearbeitbar
attendees[].displayName string Der Name des Teilnehmers, falls verfügbar. Optional. Bearbeitbar
attendees[].email string Die E-Mail-Adresse des Teilnehmers, 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 Teilnehmer ist. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[].organizer boolean Ob der Teilnehmer der Organisator des Termins ist. Schreibgeschützt. Die Standardeinstellung ist "False".
attendees[].resource boolean Gibt an, ob der Teilnehmer 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 Teilnehmers. Mögliche Werte sind:
  • "needsAction": Der Teilnehmer hat nicht auf die Einladung reagiert (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 für den Kalender steht, in dem die 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 zum Erstellen neuer Konferenzdetails das Feld createRequest. Damit Ihre Änderungen erhalten bleiben, müssen Sie den conferenceDataVersion-Anfrageparameter bei allen 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 10 Buchstaben bestehende Besprechungscode, z. B. aaa-bbbb-ccc.
  • addOn: Die ID wird vom Drittanbieter definiert.
Optional.
conferenceData.conferenceSolution nested object Die Konferenzlösung wie Google Meet.

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

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest sind 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 Kunde auf einen unbekannten oder leeren Typ stößt, sollte er dennoch die Einstiegspunkte anzeigen können. Änderungen sind jedoch nicht möglich.

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; bestehende Termine können diesen Konferenzlösungstyp anzeigen, aber neue Konferenzen können nicht erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace-Nutzer (eingestellt; in bestehenden Terminen wird möglicherweise dieser Konferenzlösungstyp angezeigt, neue Konferenzen können aber 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, eine neue Konferenz zu erstellen und an den Termin anzuhängen. Die Daten werden asynchron generiert. Im Feld status sehen Sie, ob Daten vorhanden sind.

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest sind 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 Kunde auf einen unbekannten oder leeren Typ stößt, sollte er dennoch die Einstiegspunkte anzeigen können. Änderungen sind jedoch nicht möglich.

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; bestehende Termine können diesen Konferenzlösungstyp anzeigen, aber neue Konferenzen können nicht erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace-Nutzer (eingestellt; in bestehenden Terminen wird möglicherweise dieser Konferenzlösungstyp angezeigt, neue Konferenzen können aber 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. Stimmt die angegebene ID mit der ID der vorherigen Anfrage überein, 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 einer Konferenz war erfolgreich, die Einstiegspunkte sind ausgefüllt.
  • "failure": Die Anfrage zum Erstellen einer Konferenz ist fehlgeschlagen. Es gibt keine Einstiegspunkte.

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 sind erforderlich.
conferenceData.entryPoints[].accessCode string Den Zugangscode für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen.

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

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

Folgende Werte sind möglich:

  • "video" – Teilnahme an einer Konferenz über HTTP. Eine Konferenz kann keinen oder einen video-Einstiegspunkt haben.
  • "phone" – der Teilnahme an einer Konferenz über eine Telefonnummer. Eine Konferenz kann null oder mehr phone-Einstiegspunkte haben.
  • "sip" – Teilnahme an einer Konferenz über SIP. Eine Konferenz kann keinen oder einen sip-Einstiegspunkt haben.
  • "more": weitere Anweisungen zur Teilnahme an Konferenzen, z. B. zusätzliche Telefonnummern Eine Konferenz kann keinen oder einen more-Einstiegspunkt haben. Eine Konferenz mit nur einem 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 Teilmenge der Felder {meetingCode, accessCode, passcode, password, pin} aus, die mit der vom Konferenzanbieter verwendeten Terminologie übereinstimmen. 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 Teilmenge der Felder {meetingCode, accessCode, passcode, password, pin} aus, die mit der vom Konferenzanbieter verwendeten Terminologie übereinstimmen. Es sollten nur die ausgefüllten Felder angezeigt werden.
conferenceData.entryPoints[].password string Das Passwort 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 Teilmenge der Felder {meetingCode, accessCode, passcode, password, pin} aus, die mit der vom Konferenzanbieter verwendeten Terminologie übereinstimmen. 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 Teilmenge der Felder {meetingCode, accessCode, passcode, password, pin} aus, die mit der vom Konferenzanbieter verwendeten Terminologie übereinstimmen. Es sollten nur die ausgefüllten Felder angezeigt werden.

Optional.
conferenceData.entryPoints[].uri string 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 Einwahlsequenz enthalten (z.B. tel:+12345678900,,,123456789;1234).
  • Für sip ist sip:-Schema erforderlich, z.B. sip:12345678@meinanbieter.de.
  • für more, http: oder https: ist erforderlich.

conferenceData.notes string Zusätzliche Hinweise (z. B. Anweisungen des Domainadministrators, rechtliche Hinweise), die dem Nutzer angezeigt werden sollen. 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 des Termins. 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-Uhrzeitwert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist explizit 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 Wiederholung erweitert wird. Bei einzelnen Ereignissen 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 trotzdem ein Ende angegeben, auch wenn dieses Attribut auf „True“ gesetzt ist. Die Standardeinstellung ist "False".
etag etag Das ETag der Ressource.
eventType string Spezifischer Typ des Ereignisses. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte sind:
  • "default": Ein reguläres Ereignis oder ein nicht weiter angegebenes Ereignis.
  • „outOfOffice“: ein Außer-Haus-Termin.
  • „focusTime“: ein Fokuszeit-Termin.
  • „workingLocation“: Ein Arbeitsortereignis.
 Bearbeitbar
extendedProperties object Erweiterte Attribute 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 des Privatgrundstücks 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 eingehen, während der Fokuszeit-Termin vorhanden ist, 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 vorhandener Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird.
gadget object Ein Gerät, das dieses Ereignis erweitert. Gadgets wurden eingestellt. Diese Struktur wird stattdessen nur verwendet, um Metadaten zum Geburtstagskalender zurückzugeben.
gadget.display string Der Anzeigemodus des Gadgets. Veraltet. Mögliche Werte sind:
  • „icon“: Das Gerät wird in der Kalenderansicht neben dem Titel des Termins angezeigt.
  • "chip": Das Gerät wird angezeigt, wenn auf das Ereignis 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 Personen als der Organisator den Termin bearbeiten können. Optional. Die Standardeinstellung ist "False". Bearbeitbar
guestsCanSeeOtherGuests boolean Gibt an, ob andere Personen als der Organisator sehen können, wer an dem Termin teilnimmt. Optional. Der Standardwert ist „True“. Bearbeitbar
iCalUID string Eindeutige Kennung des Ereignisses gemäß Definition in RFC5545. Er wird verwendet, um Termine in Kalendersystemen eindeutig zu identifizieren, und muss beim Importieren von Terminen über die import-Methode angegeben werden.

Die iCalUID und die id sind nicht identisch und es sollte beim Erstellen des Ereignisses nur einer davon angegeben werden. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Ereignissen alle Vorkommen eines Ereignisses unterschiedliche id-Werte haben, während sie alle dieselben iCalUID-Werte haben. Wenn Sie ein Ereignis mithilfe des iCalUID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf. Rufen Sie die Methode events.get auf, um ein Ereignis mit seiner id abzurufen.
id string Intransparente ID des Ereignisses. Wenn Sie neue einzelne oder wiederkehrende Termine erstellen, können Sie die zugehörigen IDs angeben. Angegebene IDs müssen diesen Regeln entsprechen:
  • Für die ID sind die Zeichen zulässig, die in der base32hex-Codierung verwendet werden, d. h. Kleinbuchstaben a–v und Ziffern 0–9, siehe Abschnitt 3.1.2 in RFC2938.
  • Die Länge der ID muss zwischen 5 und 1.024 Zeichen liegen
  • Die ID muss pro Kalender eindeutig sein.
Da das System global verteilt ist, können wir nicht garantieren, dass ID-Kollisionen zum Zeitpunkt der Ereigniserstellung erkannt werden. Wir empfehlen, einen etablierten UUID-Algorithmus wie in RFC4122 beschrieben zu verwenden, um das Risiko von Konflikten zu minimieren.

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

Die icalUID und die id sind nicht identisch und es sollte beim Erstellen des Ereignisses nur einer davon angegeben werden. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Ereignissen alle Vorkommen eines Ereignisses unterschiedliche id-Werte haben, während 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 Ereigniskopie handelt, bei der keine Änderungen an den Hauptereignisfeldern „Zusammenfassung“, „Beschreibung“, „Ort“, „Start“, „Ende“ oder „Wiederholung“ vorgenommen werden können. Die Standardeinstellung ist "False". Schreibgeschützt.
organizer object Der Organisator des Termins. Wenn der Organisator auch ein Teilnehmer ist, wird dies durch einen separaten Eintrag in attendees angezeigt, wobei das Feld organizer auf „True“ gesetzt ist. Verwenden Sie den Vorgang Verschieben, um den Organisator zu ä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 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 Ereignis ist dies der Zeitpunkt, zu dem dieses Ereignis laut den Wiederholungsdaten des wiederkehrenden Ereignisses beginnen würde, das durch „retailEventId“ identifiziert 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-Uhrzeitwert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist explizit 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 Wiederholung erweitert wird. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses an. Bearbeitbar
outOfOfficeProperties nested object Daten zu Außer-Haus-Terminen. Wird verwendet, wenn eventType den Wert outOfOffice hat. Bearbeitbar
outOfOfficeProperties.autoDeclineMode string Gibt an, ob Besprechungseinladungen abgelehnt werden, die sich mit Außer-Haus-Terminen überschneiden. Gültige Werte sind declineNone, d. h. keine Besprechungseinladungen werden abgelehnt. declineAllConflictingInvitations bedeutet, dass alle in Konflikt stehenden Besprechungseinladungen abgelehnt werden, die mit dem Termin in Konflikt stehen, und declineOnlyNewConflictingInvitations, was bedeutet, dass nur neue, in Konflikt stehende Besprechungseinladungen, die eingehen, während der Außer-Haus-Termin eingeht, abgelehnt werden.
outOfOfficeProperties.declineMessage string Antwortnachricht, die festgelegt werden soll, wenn ein vorhandener 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 Veranstaltungen. Optional. Nicht veränderbar. Die Standardeinstellung ist "False".
recurrence[] list Liste der Zeilen RRULE, EXRULE, RDATE und EXDATE 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 Endzeiten von Ereignissen 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 die Instanz gehört. Nicht veränderbar.
reminders object Informationen zu den Terminerinnerungen für den authentifizierten Nutzer.
reminders.overrides[] list Wenn für den Termin keine Standarderinnerungen verwendet werden, werden hier die Erinnerungen speziell für den Termin angezeigt. Ist die Richtlinie nicht konfiguriert, werden für diesen Termin keine Erinnerungen eingerichtet. Es können maximal fünf Erinnerungen überschrieben werden. 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, wenn eine Erinnerung hinzugefügt wird.

 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, wenn eine Erinnerung hinzugefügt wird.

 Bearbeitbar
reminders.useDefault boolean Legt fest, ob die Standarderinnerungen des Kalenders für den Termin gelten. Bearbeitbar
sequence integer Sequenznummer gemäß iKalender. 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 kann nur vom Ersteller des Termins angesehen oder geändert werden.
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 einem wiederkehrenden Termin 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-Uhrzeitwert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist explizit 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 Wiederholung erweitert wird. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses an. Bearbeitbar
status string Status des Ereignisses. Optional. Mögliche Werte sind:
  • „confirmed“: Das Ereignis wurde bestätigt. Das ist der Standardstatus.
  • "tentative": Der Termin wurde vorläufig bestätigt.
  • "cancelled": Das Ereignis wurde abgebrochen (gelöscht). Die list-Methode gibt abgebrochene Ereignisse nur bei inkrementeller Synchronisierung zurück (wenn syncToken oder updatedMin angegeben ist) oder wenn das Flag showDeleted auf true gesetzt ist. Die Methode get gibt sie immer zurück.

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

    1. Abgebrochene Ausnahmen eines nicht abgebrochenen wiederkehrenden Termins weisen darauf hin, dass diese Instanz dem Nutzer nicht mehr angezeigt werden soll. Kunden sollten diese Ereignisse für die Lebensdauer des übergeordneten wiederkehrenden 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 stellen gelöschte Ereignisse dar. Kunden sollten ihre lokal synchronisierten Kopien entfernen. Solche abgebrochenen Ereignisse verschwinden irgendwann, daher sollten Sie sich nicht darauf verlassen, dass sie auf unbestimmte Zeit verfügbar sind.

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

    Im Kalender des Organisators werden für abgesagte Termine weiterhin Termindetails (Zusammenfassung, Ort usw.) angezeigt, damit 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 Verschieben), und der ursprüngliche Organisator nicht auf der Teilnehmerliste steht, wird ein abgesagter Termin beibehalten, 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. In diesem Fall wird im Kalender eine Zeitblockade angezeigt. Dies entspricht der Einstellung Anzeigen als in der Google Kalender-Benutzeroberfläche auf Beschäftigt.
  • "transparent": Für diesen Termin wurde die Zeit im Kalender nicht blockiert. Dies entspricht der Einstellung Zeigen 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": Verwendet die Standardeinstellung für die Sichtbarkeit von Terminen im Kalender. „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 zu einem Arbeitsort. Bearbeitbar
workingLocationProperties.customLocation object Falls vorhanden, gibt diese an, dass der Nutzer von einem benutzerdefinierten Standort aus arbeitet. Bearbeitbar
workingLocationProperties.customLocation.label string Ein optionales zusätzliches Label für zusätzliche Informationen. Bearbeitbar
workingLocationProperties.homeOffice any value Falls vorhanden, wird angegeben, dass der Nutzer von zu Hause aus arbeitet. Bearbeitbar
workingLocationProperties.officeLocation object Falls vorhanden, gibt der Nutzer an, dass er 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 Kennung der Etage. Bearbeitbar
workingLocationProperties.officeLocation.floorSectionId string Eine optionale Kennung des Etagenabschnitts. Bearbeitbar
workingLocationProperties.officeLocation.label string Der Büroname, der in Google Kalender Web- und Google Kalender-Clients angezeigt wird Wir empfehlen, in der Ressourcendatenbank der Organisation auf einen Gebäudenamen zu verweisen. Bearbeitbar
workingLocationProperties.type string Art des Arbeitsorts. Mögliche Werte sind:
  • „homeOffice“: Der Nutzer arbeitet von zu Hause aus.
  • „officeLocation“: Der Nutzer arbeitet in einem 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 iKalender-ID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf.
import
Importiert einen Termin. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Termine mit einem eventType von default importiert werden.

Veraltetes Verhalten:Wenn ein anderes Ereignis als default importiert wird, wird sein Typ in default geändert und alle ereignistypspezifischen Eigenschaften des Ereignisses werden entfernt.

insert
Zum Erstellen eines Ereignisses.
Instanzen
Gibt Instanzen des angegebenen wiederkehrenden Ereignisses zurück.
list
Gibt Termine im angegebenen Kalender zurück.
Verschieben
Verschiebt einen Termin in einen anderen Kalender, d.h. ändert den Organisator des Termins. Nur default-Ereignisse können verschoben werden. outOfOffice-, focusTime- und workingLocation-Ereignisse können nicht verschoben werden.
patch
Aktualisiert ein Ereignis. Diese Methode unterstützt die Patch-Semantik. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise sollte get gefolgt von update verwendet werden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Sofern angegeben, werden die vorhandenen Array-Felder überschrieben. Dadurch werden alle vorherigen Array-Elemente verworfen.
quickAdd
Erstellt ein Ereignis anhand eines einfachen Textstrings.
Update
Aktualisiert ein Ereignis. Diese Methode unterstützt keine Patch-Semantik 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.