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
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": 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 Ereignis können maximal 25 Anhänge vorhanden sein.
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 für das Hinzufügen von Google Drive-Dateianhängen dasselbe Format wie in der alternateLink-Eigenschaft der Files-Ressource in der Drive API.

Erforderlich, wenn ein Anhang hinzugefügt wird.

 Bearbeitbar
attachments[].mimeType string Der Internet-Medientyp (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. Wenn beim Abrufen eines Ereignisses keine Daten zurückgegeben werden, kann das an einer Einschränkung liegen, die durch den Abfrageparameter maxAttendee festgelegt wurde. Wenn Sie ein Ereignis aktualisieren, können Sie damit nur die Antwort des Teilnehmers aktualisieren. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[] list Die Teilnehmer der Veranstaltung. Weitere Informationen zum Planen von Terminen mit anderen Kalendernutzern finden Sie im Hilfeartikel Termine mit Teilnehmern. Für Dienstkonten muss die domainweite Delegierung von Befugnissen verwendet werden, um die Teilnehmerliste zu erstellen. 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 beim Hinzufügen eines Gasts vorhanden sein. Es muss eine gültige E-Mail-Adresse gemäß RFC5322 sein.

Erforderlich, wenn ein Teilnehmer hinzugefügt wird.

 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 Gibt an, ob der Teilnehmer der Organisator der Veranstaltung ist. Schreibgeschützt. Die Standardeinstellung ist "False".
attendees[].resource boolean Gibt an, ob der Gast eine Ressource ist. Kann nur festgelegt werden, wenn der Teilnehmer der Veranstaltung 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 (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 diese Kopie des Termins angezeigt wird. Schreibgeschützt. Die Standardeinstellung ist "False".
birthdayProperties nested object Daten zu Geburtstagen oder besonderen Ereignissen Wird verwendet, wenn eventType den Wert "birthday" hat. Nicht veränderbar. Bearbeitbar
birthdayProperties.contact string Ressourcenname des Kontakts, mit dem dieser Geburtstagstermin verknüpft ist. Damit können Kontaktdaten aus der People API abgerufen werden. Format: "people/c12345". Schreibgeschützt.
birthdayProperties.customTypeName string Für dieses Ereignis angegebenes Label für benutzerdefinierten Typ. Dieser Wert wird ausgefüllt, wenn birthdayProperties.type auf "custom" festgelegt ist. Schreibgeschützt.
birthdayProperties.type string Art des Geburtstags oder besonderen Ereignisses. Mögliche Werte sind:
  • "anniversary" – ein anderes Jubiläum als ein Geburtstag. Enthält immer ein contact.
  • "birthday": ein Geburtstagsereignis. „Immer“ ist der Standardwert.
  • "custom": Ein spezielles Datum, dessen Label im Feld customTypeName weiter spezifiziert wird. Enthält immer ein contact.
  • "other": ein spezielles Datum, das nicht in eine der anderen Kategorien fällt und kein benutzerdefiniertes Label hat. Hat immer einen contact.
  • "self": Geburtstag des Kalendereigentümers Darf kein contact haben.
 Die Calendar API unterstützt nur das Erstellen von Ereignissen vom Typ "birthday". Der Typ kann nach dem Erstellen des Ereignisses nicht mehr geändert werden.		 Bearbeitbar
colorId string Die Farbe des Ereignisses. Dies ist eine ID, die sich auf einen Eintrag im Abschnitt event der Farbdefinition bezieht (siehe Farbenendpunkt). 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 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 nicht festgelegt. Dieser Konferenztyp wurde eingestellt.
  • eventNamedHangout: Die ID ist der Name des Hangouts. (Dieser Konferenztyp wird nicht mehr unterstützt.)
  • hangoutsMeet: ID ist der 10-stellige Konferenzcode, z. B. aaa-bbbb-ccc.
  • addOn: Die ID wird vom Drittanbieter definiert.
Optional.
conferenceData.conferenceSolution nested object Die Konferenzlösung, z. B. Google Meet.

Wird für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage zurückgesetzt.

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest ist erforderlich.
conferenceData.conferenceSolution.iconUri string Das für Nutzer sichtbare Symbol für diese Lösung.
conferenceData.conferenceSolution.key nested object Der Schlüssel, mit dem die Konferenzlösung für dieses Ereignis eindeutig identifiziert werden kann.
conferenceData.conferenceSolution.key.type string Der Konferenzlösungstyp.

Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollten die Einstiegspunkte trotzdem angezeigt werden 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; bei bestehenden Terminen wird möglicherweise dieser Konferenzlösungstyp angezeigt, aber es können keine neuen Konferenzen erstellt werden)
  • "hangoutsMeet" für Google Meet (http://meet.google.com)
  • "addOn" für Drittanbieter von Konferenzdiensten

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

Es muss entweder conferenceSolution und mindestens eine entryPoint oder createRequest angegeben werden.
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, sollten die Einstiegspunkte trotzdem angezeigt werden 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; bei bestehenden Terminen wird möglicherweise dieser Konferenzlösungstyp angezeigt, 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 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 wurden ausgefüllt.
  • "failure": Die Anfrage zum Erstellen der Konferenz ist fehlgeschlagen. Es gibt keine Einstiegspunkte.

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

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

Es muss entweder conferenceSolution und mindestens eine entryPoint oder createRequest angegeben werden.
conferenceData.entryPoints[].accessCode string Der Zugriffscode 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 der Terminologie des Konferenzanbieters entspricht. 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" – Sie nehmen per Telefon an einer Konferenz teil, indem Sie eine Telefonnummer wählen. 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 Anleitungen zur Teilnahme an der 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.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Teilmenge der Felder {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entspricht. Es sollten nur die ausgefüllten Felder angezeigt werden.

Optional.
conferenceData.entryPoints[].passcode string Der Sicherheitscode 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 der Terminologie des Konferenzanbieters entspricht. 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 der Terminologie des Konferenzanbieters entspricht. 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.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Teilmenge der Felder {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entspricht. 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 ein Schema erforderlich.
  • Für phone ist das Schema tel: erforderlich. Der URI muss die gesamte Wählsequenz 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 (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.

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 der Veranstaltung. 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 (ausschließliche) 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 Datums- und Zeitwert (formatiert gemäß RFC3339). Ein Zeitzonenversatz ist erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. 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. 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/das Ende des Ereignisses an. Bearbeitbar
endTimeUnspecified boolean Gibt an, ob die Endzeit nicht angegeben ist. Aus Kompatibilitätsgründen wird immer ein Endzeitpunkt angegeben, auch wenn dieses Attribut auf „True“ gesetzt ist. Die Standardeinstellung ist "False".
etag etag ETag der Ressource.
eventType string Spezifischer Ereignistyp. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte:
  • „birthday“: Ein ganztägiges, jährlich wiederkehrendes Ereignis.
  • „default“: Ein regelmäßiger Termin oder nicht weiter spezifiziert.
  • „focusTime“: Ein Ereignis für die Fokuszeit.
  • „fromGmail“: Ein Termin aus Gmail. Dieser Ereignistyp kann nicht erstellt werden.
  • „outOfOffice“: Ein Außer-Haus-Termin.
  • „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 Property und der entsprechende Wert.
extendedProperties.shared object Eigenschaften, die zwischen Kopien des Termins in den Kalendern anderer Teilnehmer geteilt werden. Bearbeitbar
extendedProperties.shared.(key) string Der Name der freigegebenen Property und der entsprechende Wert.
focusTimeProperties nested object Fokuszeit-Ereignisdaten. Wird verwendet, wenn eventType focusTime ist. Bearbeitbar
focusTimeProperties.autoDeclineMode string Ob Besprechungseinladungen abgelehnt werden sollen, die mit Fokuszeit-Terminen übereinstimmen. Gültige Werte sind declineNone, was bedeutet, dass keine Besprechungseinladungen abgelehnt werden; declineAllConflictingInvitations, was bedeutet, dass alle Besprechungseinladungen, die mit dem Termin in Konflikt stehen, abgelehnt werden; und declineOnlyNewConflictingInvitations, was bedeutet, dass nur neue Besprechungseinladungen abgelehnt werden, die während der Fokuszeit eingehen.
focusTimeProperties.chatStatus string Der Status, mit dem der Nutzer in Google Chat und ähnlichen Produkten gekennzeichnet wird. Dies kann available oder doNotDisturb sein.
focusTimeProperties.declineMessage string Antwortnachricht, die festgelegt wird, wenn ein vorhandener Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird.
gadget object Ein Gadget, das dieses Ereignis erweitert. 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:
  • „icon“: Das Gadget wird in der Kalenderansicht neben dem Titel des Ereignisses 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 Ob andere Teilnehmer als der Organisator andere zum Termin einladen können. Optional. Der Standardwert ist „True“. Bearbeitbar
guestsCanModify boolean Ob andere Teilnehmer als der Organisator die Veranstaltung ä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. Sie wird verwendet, um Ereignisse in allen Kalendersystemen eindeutig zu identifizieren, und muss beim Importieren von Ereignissen über die Methode import bereitgestellt werden.

iCalUID und id sind nicht identisch und beim Erstellen des Ereignisses sollte nur eines davon 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. Wenn du ein Ereignis anhand seiner iCalUID abrufen möchtest, rufe die Methode „events.list“ mit dem Parameter „iCalUID“ auf. Wenn Sie ein Ereignis anhand seines id abrufen möchten, rufen Sie die Methode events.get auf.
id string Intransparente Kennung des Ereignisses. Wenn Sie neue einmalige oder wiederkehrende Ereignisse 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
Aufgrund der globalen Verteilung des Systems können wir nicht garantieren, dass ID-Kollisionen beim Erstellen von Ereignissen erkannt werden. Um das Risiko von Kollisionen zu minimieren, empfehlen wir die Verwendung eines etablierten UUID-Algorithmus, wie er in RFC4122 beschrieben ist.

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

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 Ereignissen alle Vorkommnisse eines Ereignisses unterschiedliche ids haben, während sie alle dieselben icalUIDs 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“, „Beginn“, „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 move, um den Organisator zu ändern. Schreibgeschützt, außer beim Importieren eines Ereignisses. 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 einer Instanz eines wiederkehrenden Ereignisses ist dies die Uhrzeit, zu der dieses Ereignis gemäß den Wiederholungsdaten im wiederkehrenden Ereignis mit der ID „recurringEventId“ beginnen würde. Sie dient der eindeutigen Identifizierung der Instanz innerhalb der wiederkehrenden Ereignisreihe, 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 Datums- und Zeitwert (formatiert gemäß RFC3339). Ein Zeitzonenversatz ist erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. 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. 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/das Ende des Ereignisses an. Bearbeitbar
outOfOfficeProperties nested object Daten zu Abwesenheitsereignissen Wird verwendet, wenn eventType outOfOffice ist. Bearbeitbar
outOfOfficeProperties.autoDeclineMode string Ob Besprechungseinladungen mit sich überschneidenden Außer-Haus-Terminen abgelehnt werden sollen. Gültige Werte sind declineNone, was bedeutet, dass keine Besprechungseinladungen abgelehnt werden; declineAllConflictingInvitations, was bedeutet, dass alle Besprechungseinladungen abgelehnt werden, die mit dem Termin in Konflikt stehen; und declineOnlyNewConflictingInvitations, was bedeutet, dass nur neue Besprechungseinladungen abgelehnt werden, die mit dem Abwesenheitsereignis in Konflikt stehen.
outOfOfficeProperties.declineMessage string Antwortnachricht, die festgelegt wird, 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: Das ist nicht dasselbe wie Properties für private Ereignisse. Optional. Nicht veränderbar. Die Standardeinstellung ist "False".
recurrence[] list Liste der Zeilen RRULE, EXRULE, RDATE und EXDATE für ein wiederkehrendes Ereignis gemäß RFC5545. In diesem Feld sind keine DTSTART- und DTEND-Zeilen zulässig. Beginn und Ende der Veranstaltung werden in den Feldern start und end angegeben. Dieses Feld wird für einzelne Ereignisse oder Instanzen wiederkehrender Ereignisse weggelassen. Bearbeitbar
recurringEventId string Bei einer Instanz eines wiederkehrenden Termins ist dies die id des wiederkehrenden Termins, zu dem diese Instanz 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 das Ereignis nicht die Standarderinnerungen verwendet werden, werden hier die für das Ereignis spezifischen Erinnerungen aufgeführt. Andernfalls wird angezeigt, dass für dieses Ereignis keine Erinnerungen festgelegt sind. Die maximale Anzahl von Erinnerungen zum Überschreiben ist 5. Bearbeitbar
reminders.overrides[].method string Die von dieser Erinnerung verwendete Methode. Mögliche Werte:
  • „email“: Erinnerungen werden per E-Mail gesendet.
  • „popup“: Erinnerungen werden über ein Pop-up in der Benutzeroberfläche gesendet.

Erforderlich, wenn Sie eine Erinnerung hinzufügen.

 Bearbeitbar
reminders.overrides[].minutes integer Anzahl der Minuten vor Beginn der Veranstaltung, zu der die Erinnerung ausgelöst werden soll. Gültige Werte liegen zwischen 0 und 40.320 (4 Wochen in Minuten).

Erforderlich, wenn Sie eine Erinnerung hinzufügen.

 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, aus der 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 Der 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 Startzeit des Ereignisses (inklusive). Bei einem wiederkehrenden Termin ist dies der Beginn der ersten Instanz.
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 Datums- und Zeitwert (formatiert gemäß RFC3339). Eine Zeitzonenverschiebung ist erforderlich, es sei denn, in timeZone ist eine Zeitzone explizit 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. 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/das Ende des Ereignisses an. Bearbeitbar
status string Status des Ereignisses. Optional. Mögliche Werte:
  • „confirmed“: Das Ereignis ist bestätigt. Das ist der Standardstatus.
  • „tentative“: Der Termin ist vorläufig bestätigt.
  • „cancelled“: Die Veranstaltung wurde abgesagt (gelöscht). Die Methode list gibt abgesagte Ereignisse nur bei inkrementeller Synchronisierung zurück (wenn syncToken oder updatedMin angegeben ist) oder wenn das Flag showDeleted auf true gesetzt ist. Sie werden von der Methode get immer zurückgegeben.

    Der Status „Abgebrochen“ kann je nach Ereignistyp zwei verschiedene Status haben:

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

      Bei stornierten Ausnahmen sind nur Werte für die Felder id, recurringEventId und originalStartTime ausgefüllt. Die anderen Felder sind möglicherweise leer.

    2. Alle anderen abgebrochenen Ereignisse sind gelöschte Ereignisse. 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 garantiert ausgefüllt.

    Im Kalender des Organisators sind die Details der abgesagten Termine (Zusammenfassung, Ort usw.) weiterhin zu sehen, damit sie wiederhergestellt (nicht gelöscht) werden können. Ebenso werden weiterhin Details zu den Terminen angezeigt, zu denen der Nutzer eingeladen wurde und die er manuell entfernt hat. 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. über den Vorgang Verschieben) und der ursprüngliche Organisator nicht auf der Teilnehmerliste steht, wird ein abgesagter Termin zurückgelassen, bei dem nur das Feld id garantiert ausgefüllt ist.

Bearbeitbar
summary string Titel der Veranstaltung. Bearbeitbar
transparency string Gibt an, ob der Termin Zeit im Kalender blockiert. Optional. Mögliche Werte:
  • „opaque“: Standardwert. Der Termin blockiert Zeit im Kalender. Das entspricht der Einstellung Als Beschäftigt in der Kalenderoberfläche.
  • „transparent“: Der Termin blockiert keine Zeit im Kalender. Das entspricht der Einstellung Als Verfügbar in der Kalenderoberfläche.
 Bearbeitbar
updated datetime Zeitpunkt der letzten Änderung der Hauptereignisdaten (als RFC3339-Zeitstempel). Dies ändert sich nicht, wenn Sie Terminerinnerungen aktualisieren. Schreibgeschützt.
visibility string Sichtbarkeit des Ereignisses. Optional. Mögliche Werte:
  • „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“: Die Veranstaltung ist privat und nur Teilnehmer können sich die Details ansehen.
  • „confidential“: Das Ereignis ist privat. Dieser Wert wird aus Kompatibilitätsgründen angegeben.
 Bearbeitbar
workingLocationProperties nested object Ereignisdaten zu Arbeitsorten. Bearbeitbar
workingLocationProperties.customLocation object Falls vorhanden: Gibt 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: 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äudekennzeichnung. 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 Stockwerkskennzeichnung. 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, einen Gebäudenamen in der Ressourcendatenbank der Organisation anzugeben. Bearbeitbar
workingLocationProperties.type string Art des Arbeitsorts. Mögliche Werte:
  • „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, wenn Properties für den Arbeitsort hinzugefügt werden.

 Bearbeitbar

Methoden

Delete
Löst einen Termin.
get
Gibt einen Termin anhand 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
Ereignisse importieren. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Ereignisse mit einer eventType von default 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 einen Termin.
Instanzen
Gibt Instanzen des angegebenen wiederkehrenden Termins zurück.
list
Gibt Termine im angegebenen Kalender zurück.
move
Verschiebt einen Termin in einen anderen Kalender, d.h. ändert den Organisator eines Termins. Hinweis: Nur default-Ereignisse können verschoben werden. birthday-, focusTime-, fromGmail-, outOfOffice- und workingLocation-Ereignisse können nicht verschoben werden.
patch
Aktualisiert ein Ereignis. Diese Methode unterstützt die Patch-Semantik. Hinweis: Jede Patchanfrage belegt drei Kontingenteinheiten. Verwenden Sie daher vorzugsweise get gefolgt von update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Wenn Arrayfelder angegeben werden, werden die vorhandenen Arrays überschrieben. Alle vorherigen Arrayelemente werden dabei verworfen.
quickAdd
Erstellt ein Ereignis basierend auf einem einfachen Textstring.
aktualisieren
Aktualisiert ein Ereignis. Diese Methode unterstützt keine Patch-Semantik und aktualisiert immer die gesamte Ereignisressource. Führen Sie für eine teilweise Aktualisierung eine get gefolgt von einer update mit ETags aus, um für Atomarität zu sorgen.
watch
Achten Sie auf Änderungen an den Ressourcen für Ereignisse.