Events: insert

Erstellt einen Termin. Jetzt testen

Anfrage

HTTP-Anfrage

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events

Parameter

Parametername Wert Beschreibung
Pfadparameter
calendarId string Kalender-ID. Rufen Sie die Methode calendarList.list auf, um Kalender-IDs abzurufen. Wenn Sie auf den primären Kalender des aktuell angemeldeten Nutzers zugreifen möchten, verwenden Sie das Keyword „primary“.
Optionale Abfrageparameter
conferenceDataVersion integer Versionsnummer der vom API-Client unterstützten Konferenzdaten. Bei Version 0 wird keine Unterstützung für Konferenzdaten angenommen und Konferenzdaten im Text des Ereignisses werden ignoriert. Version 1 bietet Unterstützung für das Kopieren von ConferenceData sowie für das Erstellen neuer Konferenzen mit dem Feld „createRequest“ von „conferenceData“. Der Standardwert ist 0. Zulässige Werte: 0 bis 1.
maxAttendees integer Die maximale Anzahl der Teilnehmer, die in der Antwort enthalten sein sollen. Wenn es mehr Teilnehmer als die angegebene Anzahl gibt, wird nur der Teilnehmer zurückgegeben. Optional.
sendNotifications boolean Verworfen. Verwenden Sie stattdessen sendUpdates.

Gibt an, ob Benachrichtigungen über die Erstellung des neuen Ereignisses gesendet werden sollen. Auch wenn Sie den Wert auf false setzen, werden möglicherweise weiterhin einige E‑Mails gesendet. Der Standardwert ist false.
sendUpdates string Gibt an, ob Benachrichtigungen über die Erstellung des neuen Ereignisses gesendet werden sollen. Beachten Sie, dass einige E‑Mails möglicherweise trotzdem gesendet werden. Der Standardwert ist false.

Zulässige Werte sind:
  • „all“: Benachrichtigungen werden an alle Gäste gesendet.
  • „externalOnly“: Benachrichtigungen werden nur an Gäste gesendet, die Google Kalender nicht verwenden.
  • „none“: Es werden keine Benachrichtigungen gesendet.
supportsAttachments boolean Gibt an, ob der API-Client, der den Vorgang ausführt, Ereignisanhänge unterstützt. Optional. Die Standardeinstellung ist "False".

Autorisierung

Für diese Anfrage ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche erforderlich:

Umfang
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Geben Sie im Anfragetext eine Events-Ressource mit den folgenden Attributen an:

Property-Name Wert Beschreibung Hinweise
Erforderliche Attribute
end nested object Die (ausgeschlossene) Endzeit des Ereignisses. Bei einem wiederkehrenden Termin ist dies die Endzeit des ersten Termins.
start nested object Die (inklusive) Startzeit des Ereignisses. Bei einem wiederkehrenden Termin ist dies die Startzeit der ersten Instanz.
Optionale Attribute
anyoneCanAddSelf boolean Gibt an, ob sich Nutzer selbst zur Veranstaltung einladen können (eingestellt). Optional. Die Standardeinstellung ist "False". Bearbeitbar
attachments[].fileUrl string URL-Link zum Anhang.

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

Erforderlich beim Hinzufügen eines Anhangs.

 Bearbeitbar
attendees[] list Die Teilnehmer der Veranstaltung. Weitere Informationen zum Planen von Terminen mit anderen Kalendernutzern finden Sie im Leitfaden Termine mit Teilnehmern. Dienstkonten müssen die domainweite Delegierung von Befugnissen verwenden, um die Teilnehmerliste zu füllen. Bearbeitbar
attendees[].additionalGuests integer Anzahl der zusätzlichen Gäste. Optional. Der Standardwert ist 0. Bearbeitbar
attendees[].comment string Der Antwortkommentar 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, sofern verfügbar. Dieses Feld muss beim Hinzufügen eines Teilnehmers angegeben werden. Es muss eine gültige E‑Mail-Adresse gemäß RFC5322 sein.

Erforderlich, wenn ein Teilnehmer hinzugefügt wird.

 Bearbeitbar
attendees[].optional boolean Gibt an, ob es sich um einen optionalen Teilnehmer handelt. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[].resource boolean Gibt an, ob der Teilnehmer eine Ressource ist. 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:
  • „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
birthdayProperties nested object Daten zu Geburtstagen oder besonderen Ereignissen. Wird verwendet, wenn eventType "birthday" ist. Nicht veränderbar. Bearbeitbar
birthdayProperties.type string Art des Geburtstags oder besonderen Ereignisses. Mögliche Werte:
  • "anniversary" – Ein anderes Jubiläum als ein Geburtstag. Hat immer einen contact.
  • "birthday": Ein Geburtstagsereignis. „Immer“ ist der Standardwert.
  • "custom": Ein spezielles Datum, dessen Label im Feld customTypeName genauer angegeben wird. Hat immer einen contact.
  • "other": Ein besonderes Datum, das nicht in die anderen Kategorien fällt und kein benutzerdefiniertes Label hat. Hat immer einen contact.
  • "self" – Geburtstag des Kalenderinhabers. Darf keine contact enthalten.
 Mit der Calendar API können nur Ereignisse vom Typ "birthday" erstellt werden. 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 Farben-Endpunkt). 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 beibehalten werden, müssen Sie den Anfrageparameter conferenceDataVersion für alle Anfragen zur Ereignisänderung auf 1 festlegen. Bearbeitbar
description string Beschreibung der Veranstaltung. Kann HTML enthalten. Optional. Bearbeitbar
end.date date Das Datum im Format „JJJJ-MM-TT“, wenn es sich um einen ganztägigen Termin handelt. Bearbeitbar
end.dateTime datetime Die Zeit als kombinierter Datums- und Zeitwert (gemäß RFC3339 formatiert). Eine Zeitzonenabweichung ist erforderlich, sofern in timeZone keine Zeitzone explizit angegeben ist. Bearbeitbar
end.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name aus der IANA-Zeitzonendatenbank, z.B. „Europe/Zurich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die Wiederholung erweitert wird. Bei einzelnen Terminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Start/das Ende des Termins an. Bearbeitbar
eventType string Die genaue Art des Ereignisses. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte:
  • „birthday“: Ein besonderes ganztägiges Ereignis, das jährlich wiederkehrt.
  • „default“: Ein regulärer Termin oder nicht weiter angegeben.
  • „focusTime“: Ein Fokuszeittermin.
  • „fromGmail“: Ein Termin aus Gmail. Dieser Ereignistyp kann nicht erstellt werden.
  • „outOfOffice“ – Ein Außer-Haus-Termin.
  • „workingLocation“: Ein Arbeitsort-Ereignis.
 Bearbeitbar
extendedProperties.private object Eigenschaften, die nur für die Kopie des Termins gelten, der in diesem Kalender angezeigt wird. Bearbeitbar
extendedProperties.shared object Eigenschaften, die zwischen Kopien des Termins in den Kalendern anderer Teilnehmer geteilt werden. Bearbeitbar
focusTimeProperties nested object Fokuszeit-Termindaten. Wird verwendet, wenn eventType focusTime ist. Bearbeitbar
gadget.display string Der Anzeigemodus des Gadgets. Verworfen. Mögliche Werte:
  • „icon“: Das Gadget wird in der Kalenderansicht neben dem Titel des Termins angezeigt.
  • „chip“: Das Gadget 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.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 zum 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 Gibt an, ob andere Teilnehmer als der Organisator sehen können, wer die Teilnehmer des Termins sind. Optional. Der Standardwert ist „True“. Bearbeitbar
id string Opake Kennung des Ereignisses. Wenn Sie neue einmalige oder wiederkehrende Ereignisse erstellen, können Sie deren IDs angeben. Die bereitgestellten IDs müssen die folgenden Regeln erfüllen:
  • Die in der ID zulässigen Zeichen sind die, die in der base32hex-Codierung verwendet werden, d. h. Kleinbuchstaben a–v und Ziffern 0–9 (siehe Abschnitt 3.1.2 in RFC2938).
  • Die ID muss zwischen 5 und 1.024 Zeichen lang sein.
  • Die ID muss pro Kalender eindeutig sein.
Aufgrund der global verteilten Natur des Systems können wir nicht garantieren, dass ID-Kollisionen zum Zeitpunkt der Ereigniserstellung erkannt werden. Um das Risiko von Kollisionen zu minimieren, empfehlen wir die Verwendung eines etablierten UUID-Algorithmus, z. B. eines in RFC4122 beschriebenen.

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

Beachten Sie, dass icalUID und id nicht identisch sind und nur eines der beiden beim Erstellen des Ereignisses angegeben werden sollte. Ein semantischer Unterschied besteht darin, dass bei wiederkehrenden Terminen alle Instanzen eines Termins unterschiedliche id-Werte haben, aber alle denselben icalUID-Wert.

 Bearbeitbar
location string Der geografische Ort des Ereignisses als Freitext. Optional. Bearbeitbar
originalStartTime.date date Das Datum im Format „JJJJ-MM-TT“, wenn es sich um einen ganztägigen Termin handelt. Bearbeitbar
originalStartTime.dateTime datetime Die Zeit als kombinierter Datums- und Zeitwert (gemäß RFC3339 formatiert). Eine Zeitzonenabweichung ist erforderlich, sofern in timeZone keine Zeitzone explizit angegeben ist. Bearbeitbar
originalStartTime.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name aus der IANA-Zeitzonendatenbank, z.B. „Europe/Zurich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die Wiederholung erweitert wird. Bei einzelnen Terminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Start/das Ende des Termins an. Bearbeitbar
outOfOfficeProperties nested object Außer-Haus-Termine Wird verwendet, wenn eventType outOfOffice ist. Bearbeitbar
recurrence[] list Liste der RRULE-, EXRULE-, RDATE- und EXDATE-Zeilen für ein wiederkehrendes Ereignis, wie in RFC5545 angegeben. Die Zeilen DTSTART und DTEND sind in diesem Feld nicht zulässig. Start- und Endzeiten von Veranstaltungen werden in den Feldern start und end angegeben. Dieses Feld wird bei einzelnen Terminen oder Instanzen wiederkehrender Termine ausgelassen. Bearbeitbar
reminders.overrides[] list Wenn für den Termin nicht die Standarderinnerungen verwendet werden, werden hier die spezifischen Erinnerungen für den Termin aufgeführt. Wenn keine Erinnerungen festgelegt sind, wird angegeben, dass für diesen Termin keine Erinnerungen festgelegt sind. Die maximale Anzahl von Erinnerungen zum Überschreiben beträgt 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 des Termins, 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.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.date date Das Datum im Format „JJJJ-MM-TT“, wenn es sich um einen ganztägigen Termin handelt. Bearbeitbar
start.dateTime datetime Die Zeit als kombinierter Datums- und Zeitwert (gemäß RFC3339 formatiert). Eine Zeitzonenabweichung ist erforderlich, sofern in timeZone keine Zeitzone explizit angegeben ist. Bearbeitbar
start.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name aus der IANA-Zeitzonendatenbank, z.B. „Europe/Zurich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die Wiederholung erweitert wird. Bei einzelnen Terminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Start/das Ende des Termins an. Bearbeitbar
status string Status des Ereignisses. Optional. Mögliche Werte:
  • „confirmed“: Der Termin 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 Termine nur bei der inkrementellen Synchronisierung zurück (wenn syncToken oder updatedMin angegeben sind) oder wenn das Flag showDeleted auf true gesetzt ist. Die get-Methode gibt sie immer zurück.

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

    1. Abgesagte Ausnahmen eines nicht abgesagten wiederkehrenden Termins deuten darauf hin, dass diese Instanz dem Nutzer nicht mehr präsentiert werden sollte. Clients sollten diese Ereignisse für die gesamte Dauer des übergeordneten wiederkehrenden Ereignisses speichern.

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

    2. Alle anderen abgesagten Termine sind gelöschte Termine. Kunden sollten ihre lokal synchronisierten Kopien entfernen. Solche abgesagten Veranstaltungen verschwinden irgendwann. Verlassen Sie sich also nicht darauf, 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. Ebenso werden weiterhin Details zu den Ereignissen bereitgestellt, zu denen der Nutzer eingeladen wurde und die er manuell entfernt hat. Bei inkrementellen Synchronisierungsanfragen mit showDeleted auf „false“ werden diese Details jedoch nicht zurückgegeben.

    Wenn sich der Organisator eines Termins ändert (z. B. über den Vorgang move) und der ursprüngliche Organisator nicht in der Teilnehmerliste enthalten ist, 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. Dies entspricht der Einstellung Mir anzeigen als auf Beschäftigt in der Kalender-Benutzeroberfläche.
  • „transparent“: Der Termin blockiert keine Zeit im Kalender. Das entspricht der Einstellung Anzeigen als auf Verfügbar in der Kalender-Benutzeroberfläche.
 Bearbeitbar
visibility string Sichtbarkeit des Ereignisses. Optional. Mögliche Werte:
  • „default“: Hier wird die Standardsichtbarkeit für Termine im Kalender verwendet. „Immer“ ist der Standardwert.
  • „public“: Der Termin ist öffentlich und Termindetails sind für alle Leser des Kalenders sichtbar.
  • „private“: Der Termin ist privat und nur Teilnehmer können die Termindetails sehen.
  • „confidential“: Das Ereignis ist privat. Dieser Wert wird aus Kompatibilitätsgründen angegeben.
 Bearbeitbar
workingLocationProperties nested object Arbeitsort-Ereignisdaten. 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 weitere Informationen. Bearbeitbar
workingLocationProperties.homeOffice any value Falls vorhanden, gibt an, dass der Nutzer von zu Hause aus arbeitet. Bearbeitbar
workingLocationProperties.officeLocation object Falls vorhanden, gibt das Attribut an, dass der Nutzer in einem Büro arbeitet. Bearbeitbar
workingLocationProperties.officeLocation.buildingId string Eine optionale Gebäude-ID. Hier sollte auf eine Gebäude-ID in der Ressourcendatenbank der Organisation verwiesen werden. Bearbeitbar
workingLocationProperties.officeLocation.deskId string Eine optionale Arbeitsplatz-ID. Bearbeitbar
workingLocationProperties.officeLocation.floorId string Eine optionale Etagen-ID. Bearbeitbar
workingLocationProperties.officeLocation.floorSectionId string Eine optionale Kennung für den Etagenabschnitt. Bearbeitbar
workingLocationProperties.officeLocation.label string Der Name des Büros, der in den Web- und Mobilclients von Google Kalender angezeigt wird. Wir empfehlen, auf einen Gebäudenamen in der Ressourcendatenbank der Organisation zu verweisen. Bearbeitbar
workingLocationProperties.type string Typ des Arbeitsorts. Mögliche Werte:
  • „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 ist jedoch möglicherweise nicht vorhanden, wenn es leer ist. Alle anderen Felder werden ignoriert.

Erforderlich, wenn Sie Eigenschaften für den Arbeitsort hinzufügen.

 Bearbeitbar

Antwort

Bei Erfolg gibt diese Methode eine Events-Ressource im Antworttext zurück.

Testen!

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen.