Events

Die Calendar API bietet verschiedene Varianten von Terminressourcen. Weitere Informationen finden Sie im Hilfeartikel 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 sich jeder zu dem Termin selbst 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 gesetzt sein.

Pro Termin dürfen maximal 25 Anhänge hinzugefügt werden.
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 beim Hinzufügen von Google Drive-Dateianhängen dasselbe Format wie im Attribut alternateLink der Ressource Files in der Drive API.

Erforderlich, wenn Sie einen Anhang hinzufügen.

 Bearbeitbar
attachments[].mimeType string Internetmedientyp (MIME-Typ) des Anhangs.
attachments[].title string Titel des Anhangs.
attendeesOmitted boolean Gibt an, ob Teilnehmer möglicherweise aus der Darstellung der Veranstaltung ausgelassen wurden. Beim Abrufen eines Ereignisses kann dies an einer Einschränkung liegen, die durch den Abfrageparameter maxAttendee festgelegt wurde. 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. 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 Kommentar zur Antwort des Teilnehmers. Optional. Bearbeitbar
attendees[].displayName string Name des Gastes, falls verfügbar. Optional. Bearbeitbar
attendees[].email string Die E-Mail-Adresse des Teilnehmers, falls verfügbar. Dieses Feld muss beim Hinzufügen eines Gasts vorhanden sein. Es muss sich um eine gültige E-Mail-Adresse gemäß RFC5322 handeln.

Erforderlich, wenn ein Teilnehmer hinzugefügt wird.

 Bearbeitbar
attendees[].id string Profil-ID des Teilnehmers, falls verfügbar.
attendees[].optional boolean Ob es sich um eine optionale Teilnehmerrolle handelt. 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 Teilnehmer eine Ressource ist. Dieser Wert kann nur festgelegt werden, wenn der Teilnehmer dem Termin zum ersten Mal 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 (empfohlen für neue Termine).
  • „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 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 Konferenzbezogene Informationen, z. B. Details zu einer Google Meet-Konferenz Verwenden Sie das Feld createRequest, um neue Konferenzdetails zu erstellen. Damit Ihre Änderungen gespeichert werden, müssen Sie den Anfrageparameter conferenceDataVersion für alle Anfragen zur Ereignisänderung auf 1 festlegen. Bearbeitbar
conferenceData.conferenceId string 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 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, z. B. Google Meet.

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

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest 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, mit dem die Konferenzlösung für diese Veranstaltung eindeutig identifiziert werden kann.
conferenceData.conferenceSolution.key.type string Der Lösungstyp für Konferenzen.

Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollte er trotzdem die Einstiegspunkte anzeigen können. Änderungen sollten jedoch nicht zulässig sein.

Die möglichen Werte sind:

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

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 können Sie sehen, ob die Daten vorhanden sind.

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest ist erforderlich.
conferenceData.createRequest.conferenceSolutionKey nested object Die Konferenzlösung, z. B. Hangouts oder Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Der Lösungstyp für Konferenzen.

Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollte er trotzdem die Einstiegspunkte anzeigen können. Änderungen sollten jedoch nicht zulässig sein.

Die möglichen Werte sind:

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

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 eine angegebene ID mit der für die vorherige Anfrage identisch ist, 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 der Konferenz wird noch verarbeitet.
  • "success": Die Anfrage zum Erstellen der Konferenz war erfolgreich. Die Einstiegspunkte werden ausgefüllt.
  • "failure": Die Anfrage zum Erstellen der Konferenz ist fehlgeschlagen. Es gibt keine Einstiegspunkte.

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

Sie müssen alle zur selben Konferenz gehören.

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest ist erforderlich.
conferenceData.entryPoints[].accessCode string Der Zugriffscode für den Zugriff auf die Konferenz. Die maximale Länge beträgt 128 Zeichen.

Füllen Sie beim Erstellen neuer Konferenzdaten nur die Felder {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. 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 mehrere phone-Einstiegspunkte haben.
  • "sip": Über SIP an einer Konferenz teilnehmen Eine Konferenz kann keinen oder einen sip-Einstiegspunkt haben.
  • "more": Weitere Informationen zur Teilnahme an einer Konferenz, z. B. zusätzliche Telefonnummern Eine Konferenz kann keinen oder einen more-Einstiegspunkt haben. Eine Konferenz, die nur einen more-Einstiegspunkt hat, ist keine gültige Konferenz.

conferenceData.entryPoints[].label string Das Label für den URI. Sichtbar für Endnutzer 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 den Zugriff auf die Konferenz. Die maximale Länge beträgt 128 Zeichen.

Füllen Sie beim Erstellen neuer Konferenzdaten nur die Felder {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. Es sollten nur die ausgefüllten Felder angezeigt werden.

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

Füllen Sie beim Erstellen neuer Konferenzdaten nur die Felder {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. 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.

Füllen Sie beim Erstellen neuer Konferenzdaten nur die Felder {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. Es sollten nur die ausgefüllten Felder angezeigt werden.

Optional.
conferenceData.entryPoints[].pin string Die PIN für den Zugriff auf die Konferenz. Die maximale Länge beträgt 128 Zeichen.

Füllen Sie beim Erstellen neuer Konferenzdaten nur die Felder {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. 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 das Schema tel: erforderlich. Der URI sollte die gesamte Wählfolge enthalten (z.B. tel:+12345678900,,,123456789;1234).
  • Für sip ist das sip:-Schema erforderlich, z.B. sip:12345678@myprovider.com.
  • für more, http: oder https: ist erforderlich.

conferenceData.notes string Zusätzliche Hinweise, die dem Nutzer angezeigt werden sollen, 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.

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

Optional für eine Konferenz mit einer ausstehenden Anfrage zum Erstellen.
created datetime Erstellungszeit des Ereignisses (als RFC3339-Zeitstempel) Schreibgeschützt.
creator object Der Ersteller des Ereignisses Schreibgeschützt.
creator.displayName string Der Name des Creators, falls verfügbar.
creator.email string Die E-Mail-Adresse des Erstellers, falls verfügbar.
creator.id string Die Profil-ID des Erstellers, 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, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. Bearbeitbar
end.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die wiederkehrende Termine angezeigt werden. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende des Ereignisses an. Bearbeitbar
endTimeUnspecified boolean Gibt an, ob die Endzeit nicht angegeben ist. Aus Kompatibilitätsgründen wird trotzdem eine Endzeit angegeben, auch wenn dieses Attribut auf „True“ gesetzt ist. Die Standardeinstellung ist "False".
etag etag Das ETag der Ressource.
eventType string Spezifischer Ereignistyp. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte sind:
  • „birthday“ – Ein besonderer ganztägiger Termin mit jährlicher Wiederholung.
  • „default“ – Ein reguläres Ereignis oder kein näher spezifizierter Wert.
  • „focusTime“ – Ein Fokuszeit-Ereignis.
  • „fromGmail“ – einen Termin aus Gmail. Dieser Ereignistyp kann nicht erstellt werden.
  • „outOfOffice“ – Eine Außer-Haus-Veranstaltung.
  • „workingLocation“ – Ein Termin am Arbeitsort.
 Bearbeitbar
extendedProperties object Erweiterte Properties des Ereignisses.
extendedProperties.private object Eigenschaften, die nur für die Kopie des in diesem Kalender angezeigten Termins gelten. Bearbeitbar
extendedProperties.private.(key) string Der Name der privaten Eigenschaft und der entsprechende Wert.
extendedProperties.shared object Eigenschaften, die zwischen Kopien des Termins auf den Kalender. Bearbeitbar
extendedProperties.shared.(key) string Der Name der gemeinsam genutzten Property und der entsprechende Wert.
focusTimeProperties nested object Fokuszeit-Ereignisdaten. Wird verwendet, wenn eventType gleich focusTime ist. Bearbeitbar
focusTimeProperties.autoDeclineMode string Ob Besprechungseinladungen mit Fokuszeit-Terminen abgelehnt werden sollen. Gültige Werte sind declineNone. Das bedeutet, dass keine Besprechungseinladungen abgelehnt werden. declineAllConflictingInvitations. Das bedeutet, dass alle in Konflikt stehenden Besprechungseinladungen, die mit dem Termin in Konflikt stehen, abgelehnt werden. und declineOnlyNewConflictingInvitations. Das bedeutet, dass nur neue in Konflikt stehende Besprechungseinladungen abgelehnt werden, die während des Fokuszeit-Termins eingehen.
focusTimeProperties.chatStatus string Der Status zum Markieren des Nutzers in Google Chat und ähnlichen Produkten. Dies kann available oder doNotDisturb sein.
focusTimeProperties.declineMessage string Antwortnachricht, die festgelegt wird, wenn ein bestehender Termin oder eine neue Einladung von Google Kalender automatisch abgelehnt wird.
gadget object Ein Gadgets, das dieses Ereignis verlängert. Gadgets werden nicht mehr unterstützt. Diese Struktur wird stattdessen nur noch für die Rückgabe von Metadaten für den Geburtstagskalender verwendet.
gadget.display string Der Anzeigemodus des Gadgets. Verworfen. Mögliche Werte sind:
  • „icon“ - Das Gadgets wird neben dem Titel des Termins in der Kalenderansicht angezeigt.
  • „chip“ - Das Gadgets 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. Verworfen. 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. Verworfen. Bearbeitbar
gadget.type string Der Typ des Gadgets. Verworfen. Bearbeitbar
gadget.width integer Die Breite des Gadgets in Pixeln. Die Breite muss eine Ganzzahl größer als 0 sein. Optional. Verworfen. Bearbeitbar
guestsCanInviteOthers boolean Gibt an, ob andere Teilnehmer als der Organisator andere zu dem Termin einladen können. Optional. Der Standardwert ist „True“. Bearbeitbar
guestsCanModify boolean Gibt an, ob andere Teilnehmer als der Organisator den Termin ändern können. Optional. Die Standardeinstellung ist "False". Bearbeitbar
guestsCanSeeOtherGuests boolean Ob andere Teilnehmer als der Organisator sehen können, wer die Teilnehmer der Veranstaltung sind. Optional. Der Standardwert ist „True“. Bearbeitbar
iCalUID string Die eindeutige Kennung des Ereignisses gemäß RFC5545. Er wird verwendet, um Termine in allen Kalendersystemen eindeutig zu identifizieren, und muss beim Importieren von Terminen über die import-Methode bereitgestellt werden.

Beachten Sie, dass iCalUID und id nicht identisch sind und nur eines davon beim Erstellen des Ereignisses angegeben werden sollte. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Terminen alle Vorkommen eines Termins unterschiedliche ids haben und alle dieselbe iCalUID haben. Wenn Sie ein Ereignis mit dem zugehörigen iCalUID abrufen möchten, rufen Sie die events.list-Methode mit dem Parameter iCalUID auf. Wenn Sie ein Ereignis mithilfe der zugehörigen 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 deren IDs angeben. Angegebene IDs müssen den folgenden Regeln entsprechen:
  • In der ID sind die in base32hex-Codierung zulässigen Zeichen zulässig, d. h. die Kleinbuchstaben a–v und die Ziffern 0–9, siehe Abschnitt 3.1.2 in RFC2938.
  • muss die ID zwischen 5 und 1.024 Zeichen lang sein
  • Die ID muss pro Kalender eindeutig sein
Da das System global verteilt ist, können wir nicht garantieren, dass ID-Kollisionen bei der Ereigniserstellung erkannt werden. Um das Risiko von Kollisionen zu minimieren, empfehlen wir die Verwendung eines etablierten UUID-Algorithmus, wie z. B. der in RFC4122 beschriebene Algorithmus.

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

icalUID und id sind nicht identisch und es sollte beim Erstellen des Ereignisses nur eines der beiden angegeben werden. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Terminen alle Vorkommen eines Termins unterschiedliche ids haben und alle dieselbe icalUID haben.

 Bearbeitbar
kind string Typ der Ressource ("calendar#event").
location string Der geografische Standort des Ereignisses als Freitext. Optional. Bearbeitbar
locked boolean Ob es sich um eine gesperrte Terminkopie handelt, bei der keine Änderungen an den Hauptereignisfeldern „Zusammenfassung“, „Beschreibung“, „Ort“, „Start“ und „Ende“ vorgenommen werden können oder „Wiederholung“. Die Standardeinstellung ist "False". Schreibgeschützt.
organizer object Der Organisator des Termins. Wenn der Organisator auch ein Gast ist, wird dies mit einem separaten Eintrag in attendees angezeigt, bei dem das Feld organizer auf „True“ gesetzt ist. Verwenden Sie den Vorgang move, 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 Termin ist dies der Zeitpunkt, zu dem dieser Termin gemäß den Wiederholungsdaten des wiederkehrenden Termins beginnen würde. Dieser wird mit der wiederkehrenden Ereignis-ID angegeben. Sie identifiziert die Instanz innerhalb der Serie mit wiederkehrenden Terminen eindeutig, selbst wenn die Instanz an einen anderen Zeitpunkt 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, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. Bearbeitbar
originalStartTime.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die wiederkehrende Termine angezeigt werden. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende des Ereignisses an. Bearbeitbar
outOfOfficeProperties nested object Daten zu Außer-Haus-Terminen. Wird verwendet, wenn eventType gleich outOfOffice ist. Bearbeitbar
outOfOfficeProperties.autoDeclineMode string Ob Besprechungseinladungen abgelehnt werden sollen, die mit Außer-Haus-Terminen übereinstimmen. Gültige Werte sind declineNone. Das bedeutet, dass keine Besprechungseinladungen abgelehnt werden. declineAllConflictingInvitations. Das bedeutet, dass alle in Konflikt stehenden Besprechungseinladungen, die mit dem Termin in Konflikt stehen, abgelehnt werden. und declineOnlyNewConflictingInvitations. Das bedeutet, dass nur neue in Konflikt stehende Besprechungseinladungen abgelehnt werden, die während des Außer-Haus-Termins eingehen.
outOfOfficeProperties.declineMessage string Antwortnachricht, die festgelegt wird, wenn ein bestehender Termin oder eine neue Einladung von Google Kalender automatisch abgelehnt wird.
privateCopy boolean Ist diese Option auf „True“ gesetzt, wird 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 gemäß RFC5545. Beachten Sie, dass DTSTART- und DTEND-Zeilen in diesem Feld nicht zulässig sind. Beginn und Ende des 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 dieser Termin gehört. Nicht veränderbar.
reminders object Informationen zu den Terminerinnerungen für den authentifizierten Nutzer. Hinweis: Wenn Sie Erinnerungen ändern, ändert sich nicht auch die Eigenschaft updated des einschließenden Termins.
reminders.overrides[] list Wenn für den Termin nicht die Standarderinnerungen verwendet werden, werden hier die Erinnerungen für den Termin aufgelistet. Sind keine Erinnerungen festgelegt, werden für diesen Termin keine Erinnerungen festgelegt. Es sind maximal 5 Überschreibungs-Erinnerungen zulässig. 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-Fenster 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 Gibt an, ob die Standarderinnerungen des Kalenders für den Termin gelten. Bearbeitbar
sequence integer Sequenznummer gemäß iCalendar. Bearbeitbar
source object Quelle, über die das Ereignis erstellt wurde. Zum Beispiel eine Webseite, eine E-Mail-Nachricht oder ein Dokument, das durch eine URL mit HTTP- oder HTTPS-Schema erkennbar ist. Kann nur vom Ersteller des Ereignisses angesehen oder geändert werden.
source.title string Titel der Quelle; z. B. den Titel einer Webseite oder einen E-Mail-Betreff. 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 (einschließlich) 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-Uhrzeit-Wert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. Bearbeitbar
start.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die wiederkehrende Termine angezeigt werden. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende des Ereignisses an. Bearbeitbar
status string Status des Ereignisses. Optional. Mögliche Werte sind:
  • „confirmed“ – Die Veranstaltung wurde bestätigt. Dies ist der Standardstatus.
  • „tentative“ - Die Veranstaltung 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. Sie werden von der Methode get immer zurückgegeben.

    Der Status „Abgebrochen“ stellt je nach Ereignistyp zwei verschiedene Status dar:

    1. Abgesagte Ausnahmen eines nicht abgesagten wiederkehrenden Termins geben an, dass diese Instanz dem Nutzer nicht mehr angezeigt werden soll. Kunden sollten diese Ereignisse für die Lebensdauer des übergeordneten wiederkehrenden Ereignisses speichern.

      Abgebrochene Ausnahmen enthalten nur garantiert Werte für die Felder id, recurringEventId und originalStartTime. Die anderen Felder sind möglicherweise leer.

    2. Alle anderen abgebrochenen Ereignisse stellen gelöschte Ereignisse dar. Kunden sollten ihre lokal synchronisierten Kopien entfernen. Solche abgebrochenen Ereignisse werden irgendwann entfernt. Sie können also nicht davon ausgehen, dass sie auf unbestimmte Zeit verfügbar sind.

      Bei gelöschten Ereignissen ist nur das Feld id automatisch ausgefüllt.

    Abgesagte Termine im Kalender des Organisators enthalten weiterhin Termindetails (Zusammenfassung, Ort usw.), damit sie wiederhergestellt werden können. Ebenso enthalten die Ereignisse, zu denen der Nutzer eingeladen wurde und die er manuell entfernt hat, weiterhin Details. Bei inkrementellen Synchronisierungsanfragen, bei denen showDeleted auf „false“ gesetzt ist, werden diese Details jedoch nicht zurückgegeben.

    Wenn sich der Organisator eines Termins ändert, z. B. durch den Vorgang move, und der ursprüngliche Organisator nicht in der Teilnehmerliste enthalten ist, wird ein abgesagter Termin beibehalten, bei dem nur das Feld id garantiert gefüllt wird.

Bearbeitbar
summary string Titel der Veranstaltung. Bearbeitbar
transparency string Gibt an, ob der Termin die Zeit im Kalender blockiert. Optional. Mögliche Werte sind:
  • „opaque“ – Standardwert. Der Termin blockiert die Zeit im Kalender. Dies entspricht der Einstellung für Anzeigen als in der 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 der Hauptereignisdaten (als RFC3339-Zeitstempel) Durch das Aktualisieren von Terminerinnerungen ändert sich dies nicht. Schreibgeschützt.
visibility string Sichtbarkeit des Ereignisses. Optional. Mögliche Werte sind:
  • „default“ - Verwendet die Standardsichtbarkeit für Termine im Kalender. „Immer“ ist der Standardwert.
  • „public“ - Der Termin ist öffentlich und die Termindetails sind für alle Leser des Kalenders sichtbar.
  • „private“ - Der Termin ist privat und nur die Teilnehmer können die Termindetails sehen.
  • „confidential“ - Der Termin ist privat. Dieser Wert wird aus Kompatibilitätsgründen angegeben.
 Bearbeitbar
workingLocationProperties nested object Ereignisdaten zum Arbeitsort. Bearbeitbar
workingLocationProperties.customLocation object Falls vorhanden: Gibt an, dass der Nutzer von einem benutzerdefinierten Standort aus arbeitet. Bearbeitbar
workingLocationProperties.customLocation.label string Optionales zusätzliches Label für zusätzliche Informationen. Bearbeitbar
workingLocationProperties.homeOffice any value Falls vorhanden: Gibt an, dass der Nutzer zu Hause arbeitet. Bearbeitbar
workingLocationProperties.officeLocation object Gibt an, dass der Nutzer in einem Büro arbeitet. Bearbeitbar
workingLocationProperties.officeLocation.buildingId string Eine optionale Gebäude-ID. Diese 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 Etagenkennzeichnung. Bearbeitbar
workingLocationProperties.officeLocation.floorSectionId string Eine optionale Etagenabschnitts-ID. Bearbeitbar
workingLocationProperties.officeLocation.label string Der Büroname, der in Google Kalender Web und Mobile-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 zu Hause.
  • „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 anhand seiner iCalendar-ID abrufen möchten, rufen Sie die Methode „events.list“ mit dem Parameter „iCalUID“ auf.
import
Importiert einen Termin. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Nur Termine mit dem eventType-Wert default können importiert werden.

Eingestelltes Verhalten:Wenn ein Ereignis importiert wird, das nicht zu default gehört, wird sein Typ in default geändert und alle ereignisbasierten Eigenschaften, die es möglicherweise hat, werden entfernt.

insert
Erstellt ein Ereignis.
instances
Gibt Instanzen des angegebenen wiederkehrenden Termins zurück.
list
Gibt Termine im angegebenen Kalender zurück.
verschieben
Verschieben eines Termins in einen anderen Kalender, d.h., der Organisator eines Termins wird geändert. Es können nur default-Ereignisse verschoben werden. birthday-, focusTime-, fromGmail-, outOfOffice- und workingLocation-Termine können nicht verschoben werden.
patch
Aktualisiert ein Ereignis. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass jede Patchanfrage drei Kontingenteinheiten verbraucht. verwenden Sie am besten get gefolgt von update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Sofern angegeben, werden die vorhandenen Arrays mit Array-Feldern überschrieben. Dadurch werden alle vorherigen Array-Elemente verworfen.
quickAdd
Erstellt ein Ereignis auf Basis eines einfachen Textstrings.
aktualisieren
Aktualisiert ein Ereignis. Diese Methode unterstützt keine Patch-Semantik und aktualisiert immer die gesamte Ereignisressource. Für eine Teilaktualisierung führen Sie einen get gefolgt von einem update mit ETags aus, um die Atomarität sicherzustellen.
uhr
Achten Sie auf Änderungen an Veranstaltungsressourcen.