Events: import

Importiert einen Termin. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Jetzt testen oder Beispiel ansehen

Anfragen

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 Hauptkalender des aktuell angemeldeten Nutzers zugreifen möchten, verwenden Sie das Keyword „primary“.
Optionale Suchparameter
conferenceDataVersion integer Versionsnummer der vom API-Client unterstützten Konferenzdaten In Version 0 wird davon ausgegangen, dass keine Konferenzdaten unterstützt werden. Daher werden die Konferenzdaten im Text der Veranstaltung ignoriert. Version 1 unterstützt das Kopieren von ConferenceData-Daten sowie das Erstellen neuer Konferenzen mit dem Feld „createRequest“ von ConferenceData. Der Standardwert ist 0. Zulässige Werte: 0 bis 1.
supportsAttachments boolean Gibt an, ob der API-Client, der Vorgänge ausführt, Ereignisanhänge unterstützt. Optional. Die Standardeinstellung ist "False".

Autorisierung

Für diese Anfrage ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

Umfang
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Geben Sie im Anforderungstext eine Ereignisressource mit den folgenden Attributen an:

Attributname Wert Beschreibung Hinweise
Erforderliche Properties
end nested object Das Ende der Veranstaltung (exklusiv). Bei einem wiederkehrenden Termin ist dies die Endzeit der ersten Instanz.
iCalUID string Eindeutige Ereignis-ID gemäß RFC 5545. Sie wird verwendet, um Ereignisse aus mehreren Kalendersystemen eindeutig zu identifizieren. Sie muss beim Importieren von Terminen mit der Methode import angegeben werden.

iCalUID und id sind nicht identisch und nur einer sollte bei der Erstellung des Ereignisses angegeben werden. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Ereignissen alle Vorkommen eines Ereignisses unterschiedliche ids haben, während sie alle dieselben iCalUIDs haben. Rufen Sie zum Abrufen eines Ereignisses mit dessen iCalUID die events.list-Methode mit dem iCalUID-Parameter auf. Rufen Sie die Methode events.get auf, um ein Ereignis mithilfe von id abzurufen.
start nested object Die Startzeit der Veranstaltung (inklusive). Bei einem wiederkehrenden Termin ist das die Startzeit der ersten Instanz.
Optionale Attribute
anyoneCanAddSelf boolean Ob jemand sich selbst zum Termin einladen kann (eingestellt). Optional. Die Standardeinstellung ist "False". Bearbeitbar
attachments[].fileUrl string URL-Link zum Anhang.

Wenn Sie Google Drive-Dateianhänge hinzufügen möchten, verwenden Sie in der Drive API das Format der Property alternateLink der Ressource Files.

Erforderlich, wenn Sie einen Anhang hinzufügen.

 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 die domainweite Delegierung von Befugnissen nutzen, um die Teilnehmerliste zu befüllen. Bearbeitbar
attendees[].additionalGuests integer Anzahl der zusätzlichen Gäste. Optional. Der Standardwert ist 0. Bearbeitbar
attendees[].comment string Der Kommentar zur Antwort des Teilnehmers. Optional. Bearbeitbar
attendees[].displayName string Der Name des Teilnehmers, falls verfügbar. Optional. Bearbeitbar
attendees[].email string Die E-Mail-Adresse des Teilnehmers, falls verfügbar. Dieses Feld muss vorhanden sein, wenn ein Teilnehmer hinzugefügt wird. Es muss sich um eine gültige E-Mail-Adresse gemäß RFC5322 handeln.

Erforderlich beim Hinzufügen eines Teilnehmers.

 Bearbeitbar
attendees[].optional boolean Ob dies ein optionaler Teilnehmer ist. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[].resource boolean Gibt an, ob der Teilnehmer eine Ressource ist. Kann nur festgelegt werden, wenn ein Teilnehmer dem Termin zum ersten Mal hinzugefügt wird. Nachfolgende Änderungen werden ignoriert. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[].responseStatus string Der Antwortstatus der Teilnehmer. 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 vorläufig die Einladung angenommen.
  • „accepted“: Der Teilnehmer hat die Einladung angenommen.
 Bearbeitbar
attendeesOmitted boolean Gibt an, ob Teilnehmer aus der Darstellung des Termins ausgelassen wurden. Beim Abrufen eines Ereignisses kann dies auf eine Einschränkung zurückzuführen sein, die durch den Abfrageparameter maxAttendee angegeben wird. Beim Aktualisieren eines Termins kann damit nur die Antwort des Teilnehmers aktualisiert werden. Optional. Die Standardeinstellung ist "False". Bearbeitbar
colorId string Die Farbe des Termins. Diese ID verweist auf einen Eintrag im Abschnitt event der Farbdefinition (siehe Farbendpunkt). Optional. Bearbeitbar
conferenceData nested object Informationen zur Konferenz, z. B. die Details einer Google Meet-Videokonferenz Verwenden Sie das Feld createRequest, um neue Konferenzdetails zu erstellen. Wenn Sie die Änderungen beibehalten möchten, müssen Sie den conferenceDataVersion-Anfrageparameter für alle Ereignisänderungsanfragen auf 1 setzen. 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 Uhrzeit als kombinierter Datum/Uhrzeit-Wert (nach RFC3339 formatiert). Es ist ein Zeitzonenversatz erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. Bearbeitbar
end.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Zeitzonenname für die IANA-Datenbank, z.B. „Europa/Zürich“). Bei wiederkehrenden Ereignissen ist dieses Feld erforderlich und gibt die Zeitzone an, in der der wiederkehrende Termin maximiert wird. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende von Ereignissen an. Bearbeitbar
extendedProperties.private object Properties, die nur für die Kopie des Termins verfügbar sind, der in diesem Kalender angezeigt wird. Bearbeitbar
extendedProperties.shared object Eigenschaften, die zwischen Kopien des Termins in den Kalendern anderer Teilnehmer freigegeben sind. Bearbeitbar
gadget.display string Der Anzeigemodus des Gadgets. Veraltet. Mögliche Werte sind:
  • „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. Veraltet. Bearbeitbar
gadget.preferences object Einstellungen. Bearbeitbar
gadget.title string Der Titel des Gadgets. Veraltet. Bearbeitbar
gadget.type string Der Typ des Gadgets. Veraltet. Bearbeitbar
gadget.width integer Die Breite des Gadgets in Pixeln. Die Breite muss eine Ganzzahl größer als 0 sein. Optional. Veraltet. Bearbeitbar
guestsCanInviteOthers boolean Gibt an, ob Gäste außer dem Organisator andere Personen zu dem Termin einladen können. Optional. Der Standardwert ist „True“. Bearbeitbar
guestsCanModify boolean Gibt an, ob Teilnehmer außer dem Organisator den Termin bearbeiten dürfen. Optional. Die Standardeinstellung ist "False". Bearbeitbar
guestsCanSeeOtherGuests boolean Gibt an, ob Gäste außer dem Organisator sehen können, wer der Termin ist Optional. Der Standardwert ist „True“. Bearbeitbar
location string Der geografische Ort des Ereignisses in freiem Format. Optional. Bearbeitbar
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. Mit dem Vorgang move können Sie den Organisator ändern. Nur Lesezugriff, 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 sich um eine gültige E-Mail-Adresse gemäß RFC5322 handeln. 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 Uhrzeit als kombinierter Datum/Uhrzeit-Wert (nach RFC3339 formatiert). Es ist ein Zeitzonenversatz erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. Bearbeitbar
originalStartTime.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Zeitzonenname für die IANA-Datenbank, z.B. „Europa/Zürich“). Bei wiederkehrenden Ereignissen ist dieses Feld erforderlich und gibt die Zeitzone an, in der der wiederkehrende Termin maximiert wird. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende von Ereignissen an. Bearbeitbar
recurrence[] list Liste der Zeilen RRULE, EXRULE, RDATE und EXDATE für ein wiederkehrendes Ereignis, wie in RFC5545 angegeben. In diesem Feld sind keine DTSTART- und DTEND-Zeilen zulässig. Beginn und Ende des Ereignisses werden in den Feldern start und end angegeben. Dieses Feld wird bei einzelnen Terminen oder Instanzen wiederkehrender Termine weggelassen. Bearbeitbar
reminders.overrides[] list Wenn für den Termin nicht die Standarderinnerungen verwendet werden, werden die spezifischen Erinnerungen für den Termin angezeigt. Ist er nicht festgelegt, wird für diesen Termin keine Erinnerung eingerichtet. Es sind maximal fünf Überschreibungserinnerungen möglich. 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 dem Termin, an dem 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.title string Titel der Quelle, beispielsweise der Titel einer Webseite oder ein 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.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 (nach RFC3339 formatiert). Es ist ein Zeitzonenversatz erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. Bearbeitbar
start.timeZone string Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Zeitzonenname für die IANA-Datenbank, z.B. „Europa/Zürich“). Bei wiederkehrenden Ereignissen ist dieses Feld erforderlich und gibt die Zeitzone an, in der der wiederkehrende Termin maximiert wird. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende von Ereignissen an. Bearbeitbar
status string Status des Ereignisses. Optional. Mögliche Werte sind:
  • „confirmed“: Das Ereignis wurde bestätigt. Das ist der Standardstatus.
  • „tentative“: Das Ereignis wird vorläufig bestätigt.
  • „cancelled“: Das Ereignis wurde abgebrochen (gelöscht). Die Methode list gibt abgebrochene Ereignisse nur bei inkrementeller Synchronisierung 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.

    Ein abgebrochener Status repräsentiert je nach Ereignistyp zwei verschiedene Zustände:

    1. Stornierte Ausnahmen eines nicht stornierten wiederkehrenden Termins zeigen an, dass diese Instanz dem Nutzer nicht mehr angezeigt werden soll. Kunden sollten diese Ereignisse für die Dauer des übergeordneten wiederkehrenden Termins speichern.

      Für stornierte Ausnahmen werden garantiert nur Werte für die Felder id, recurringEventId und originalStartTime ausgefüllt. Die anderen Felder sind möglicherweise leer.

    2. Alle anderen abgesagten Termine stellen gelöschte Termine dar. Kunden sollten ihre lokal synchronisierten Kopien entfernen. Diese abgebrochenen Termine werden schließlich nicht mehr angezeigt. Sie sollten sich also nicht darauf verlassen, dass sie auf unbestimmte Zeit verfügbar sind.

      Bei gelöschten Ereignissen wird nur das Feld id garantiert.

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

    Wenn der Organisator eines Termins geändert wird, z. B. über den Vorgang Verschieben, und der ursprüngliche Organisator nicht auf der Teilnehmerliste steht, bleibt ein abgesagter Termin übrig, in dem nur das Feld id ausgefüllt ist.

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 wird jedoch nicht im Kalender blockiert. Dies entspricht der Einstellung Anzeigen als auf Beschäftigt in der Kalender-Benutzeroberfläche.
  • „transparent“: Der Termin wird nicht im Kalender blockiert. Dies entspricht der Option Anzeigen als auf Verfügbar in der Kalender-Benutzeroberfläche.
 Bearbeitbar
visibility string Sichtbarkeit des Ereignisses. Optional. Mögliche Werte sind:
  • „default“: Hier wird die Standardsichtbarkeit für Termine im Kalender verwendet. „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

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Ressource vom Typ „Ereignisse“ im Antworttext zurückgegeben.

Beispiele

Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.

Java

Verwendet die Java-Clientbibliothek.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;
import com.google.api.services.calendar.model.EventAttendee;
import com.google.api.services.calendar.model.EventDateTime;
import com.google.api.client.util.DateTime;

import java.util.Date;
// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Create and initialize a new event (could also retrieve an existing event)
Event event = new Event();
event.setICalUID("originalUID");

Event.Organizer organizer = new Event.Organizer();
organizer.setEmail("organizerEmail");
organizer.setDisplayName("organizerDisplayName");
event.setOrganizer(organizer);

ArrayList<EventAttendee> attendees = new ArrayList<EventAttendee>();
attendees.add(new EventAttendee().setEmail("attendeeEmail"));
// ...
event.setAttendees(attendees);

Date startDate = new Date();
Date endDate = new Date(startDate.getTime() + 3600000);
DateTime start = new DateTime(startDate, TimeZone.getTimeZone("UTC"));
event.setStart(new EventDateTime().setDateTime(start));
DateTime end = new DateTime(endDate, TimeZone.getTimeZone("UTC"));
event.setEnd(new EventDateTime().setDateTime(end));

// Import the event into a calendar
Event importedEvent = service.events().calendarImport('primary', event).execute();

System.out.println(importedEvent.getId());

Python

Verwendet die Python-Clientbibliothek.

event = {
  'summary': 'Appointment',
  'location': 'Somewhere',
  'organizer': {
    'email': 'organizerEmail',
    'displayName': 'organizerDisplayName'
  },
  'start': {
    'dateTime': '2011-06-03T10:00:00.000-07:00'
  },
  'end': {
    'dateTime': '2011-06-03T10:25:00.000-07:00'
  },
  'attendees': [
    {
      'email': 'attendeeEmail',
      'displayName': 'attendeeDisplayName',
    },
    # ...
  ],
  'iCalUID': 'originalUID'
}

imported_event = service.events().import_(calendarId='primary', body=event).execute()

print imported_event['id']

PHP

Verwendet die PHP-Clientbibliothek.

$event = new Google_Service_Calendar_Event();
$event->setSummary('Appointment');
$event->setLocation('Somewhere');
$start = new Google_Service_Calendar_EventDateTime();
$start->setDateTime('2011-06-03T10:00:00.000-07:00');
$event->setStart($start);
$end = new Google_Service_Calendar_EventDateTime();
$end->setDateTime('2011-06-03T10:25:00.000-07:00');
$event->setEnd($end);
$attendee1 = new Google_Service_Calendar_EventAttendee();
$attendee1->setEmail('attendeeEmail');
// ...
$attendees = array($attendee1,
                   // ...,
                  );
$event->attendees = $attendees;
$organizer = new Google_Service_Calendar_EventOrganizer();
$organizer->setEmail('organizerEmail');
$organizer->setDisplayName('organizerDisplayName');
$event->setOrganizer($organizer);
$event->setICalUID('originalUID');
$importedEvent = $service->events->import('primary', $event);

echo $importedEvent->getId();

Ruby

Verwendet die Ruby-Clientbibliothek.

event = Google::Apis::CalendarV3::Event.new(
  summary: 'Appointment',
  location: 'Somewhere',
  organizer: {
    email: 'organizerEmail',
    display_name: 'organizerDisplayName'
  },
  start: {
    date_time: '2011-06-03T10:00:00.000-07:00'
  },
  end: {
    date_time: '2011-06-03T10:25:00.000-07:00'
  },
  attendees: [
    {
      email: 'attendeeEmail',
      display_name: 'attendeeDisplayName',
    },
    # ...
  ],
  i_cal_uid: 'originalUID'
)
result = client.import_event('primary', event)
print result.id

Testen!

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