Events: import

Importiert einen Termin. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Ereignisse mit einem eventType von default importiert werden.

Eingestelltes Verhalten:Wenn ein Ereignis importiert wird, das nicht default ist, wird sein Typ in default geändert und alle ereignistyp-spezifischen Eigenschaften werden entfernt.

Jetzt testen

Anfrage

HTTP-Anfrage

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

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 Suchparameter
conferenceDataVersion integer Versionsnummer der vom API-Client unterstützten Konferenzdaten. Bei Version 0 werden keine Konferenzdaten unterstützt und Konferenzdaten im Text des Termins 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.
eventLabelVersion integer Versionsnummer der Funktion für Ereignislabels, die vom API-Client unterstützt wird. Bei Version 0 wird davon ausgegangen, dass keine Ereignislabels unterstützt werden. Das Feld colorId wird für die Farbverwaltung verarbeitet. Mit Version 1 werden Ereignislabels unterstützt und die eventLabelId im Ereignis-Body verarbeitet. In diesem Fall wird das Feld colorId ignoriert. Der Standardwert ist 0. Zulässige Werte sind 0 bis einschließlich 1.
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 Bereiche 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 (nicht eingeschlossene) Endzeit des Ereignisses. Bei einem wiederkehrenden Termin ist dies die Endzeit des ersten Termins.
iCalUID string Eindeutige Kennung des Ereignisses gemäß RFC5545. Sie dient zur eindeutigen Identifizierung von Ereignissen in verschiedenen Kalendersystemen und muss beim Importieren von Ereignissen über die Methode import angegeben werden.

iCalUID und id sind nicht identisch. Nur eines der beiden sollte beim Erstellen des Ereignisses angegeben werden. Ein semantischer Unterschied besteht darin, dass bei wiederkehrenden Terminen alle Instanzen eines Termins unterschiedliche id-Werte haben, aber alle denselben iCalUID-Wert. Wenn Sie ein Ereignis anhand seines iCalUID abrufen möchten, rufen Sie die Methode „events.list“ mit dem Parameter iCalUID auf. Wenn Sie ein Ereignis anhand seiner id abrufen möchten, rufen Sie die Methode events.get auf.
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 vorhanden sein. 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
attendeesOmitted boolean Gibt an, ob Teilnehmer möglicherweise nicht in der Darstellung des Termins enthalten sind. Beim Abrufen eines Ereignisses kann dies an einer Einschränkung liegen, die durch den Abfrageparameter maxAttendee angegeben wird. Beim Aktualisieren eines Ereignisses kann damit nur die Antwort des Teilnehmers aktualisiert werden. Optional. Die Standardeinstellung ist "False". 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 (formatiert gemäß RFC3339). 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 und das Ende des Termins an. Bearbeitbar
eventLabelId string Die ID des Ereignislabels, das dem Ereignis zugewiesen ist. Optional. Dies bezieht sich auf die ID eines Eintrags in der Eigenschaft labelProperties.eventLabels des Kalenders (siehe den Endpunkt Calendars.get).

Dieses Attribut ersetzt das indexbasierte Attribut colorId. Wenn Sie diese Eigenschaft festlegen oder ändern möchten, müssen Sie eventLabelVersion=1 in den Parametern der Methoden insert, import, update und patch angeben.

Wenn Sie einen leeren String festlegen oder dieses Feld nicht festlegen, wird das vorhandene Label aus dem Ereignis entfernt.

 Bearbeitbar
extendedProperties.private object Attribute, die nur für die Kopie des Termins gelten, die 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-Ereignisdaten. 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
location string Der geografische Standort des Ereignisses als Freitext. Optional. Bearbeitbar
organizer object Der Organisator des Termins. Wenn der Organisator auch ein Teilnehmer ist, wird dies durch einen separaten Eintrag in attendees angegeben, wobei das Feld organizer auf „True“ gesetzt ist. Wenn Sie den Organisator ändern möchten, verwenden Sie den Vorgang move. 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
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 (formatiert gemäß RFC3339). 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 und das Ende des Termins an. Bearbeitbar
outOfOfficeProperties nested object Ereignisdaten zu Außer-Haus-Terminen. 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 Terminen werden in den Feldern start und end angegeben. Dieses Feld wird für einzelne Ereignisse oder Instanzen wiederkehrender Ereignisse 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 dies angegeben. 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 dem Beginn des Termins, zu dem 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 auf den Termin angewendet werden. 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 (formatiert gemäß RFC3339). 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 und das Ende des Termins an. Bearbeitbar
status string Status des Ereignisses. Optional. Mögliche Werte:
  • „confirmed“: Das Ereignis wurde 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 geben an, 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 wird garantiert nur das Feld id ausgefüllt.

    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 garantiert nur das Feld id 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. Dies 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 die Teilnehmer können die Termindetails sehen.
  • „confidential“: Das Ereignis ist privat. Dieser Wert wird aus Kompatibilitätsgründen angegeben.
 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.