Events

Die Calendar API bietet verschiedene Varianten von Terminressourcen. Weitere Informationen finden Sie unter 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
    }
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Property-Name Wert Beschreibung Hinweise
anyoneCanAddSelf boolean Ob jemand sich selbst zum Termin 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 supportsAttachments-Anfrageparameter auf true gesetzt werden.

Pro Termin sind maximal 25 Anhänge zulässig,

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 zum Hinzufügen von Google Drive-Dateianhängen dasselbe Format wie bei der alternateLink-Property der Files-Ressource in der Drive API.

Erforderlich, wenn ein Anhang hinzugefügt wird.

Bearbeitbar
attachments[].mimeType string Internet-Medientyp (MIME-Typ) des Anhangs
attachments[].title string Anhangstitel.
attendeesOmitted boolean Gibt an, ob Teilnehmer in der Darstellung des Termins ausgelassen wurden. Wenn Sie ein Ereignis abrufen, kann das an einer vom maxAttendee-Abfrageparameter angegebenen Einschränkung liegen. Wenn ein Termin aktualisiert wird, kann nur die Antwort des Teilnehmers aktualisiert werden. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[] list Die Gäste des Termins. Weitere Informationen zur Planung von Terminen mit anderen Nutzern des Kalenders finden Sie im Leitfaden Termine mit Teilnehmern. Dienstkonten müssen die domainweite Delegierung von Befugnissen nutzen, 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 der Teilnehmer. Optional. Bearbeitbar
attendees[].displayName string Der Name des Teilnehmers, falls vorhanden. 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, wenn Sie einen Gast hinzufügen.

Bearbeitbar
attendees[].id string Die Profil-ID des Teilnehmers, falls vorhanden.
attendees[].optional boolean Ob dies ein optionaler Teilnehmer ist. Optional. Die Standardeinstellung ist "False". Bearbeitbar
attendees[].organizer boolean Gibt an, ob der Teilnehmer der Organisator des Termins ist. Schreibgeschützt. Die Standardeinstellung ist "False".
attendees[].resource boolean 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 des Teilnehmers. Mögliche Werte sind:
  • needsAction“: Der Teilnehmer hat nicht auf die Einladung geantwortet (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
attendees[].self boolean Gibt an, ob dieser Eintrag den Kalender repräsentiert, in dem diese Kopie des Termins erscheint. Schreibgeschützt. Die Standardeinstellung ist "False".
colorId string Die Farbe des Termins Dies ist eine ID, die auf einen Eintrag im Abschnitt event der Farbdefinition verweist (siehe Farbendpunkt). Optional. Bearbeitbar
conferenceData nested object Die mit der Konferenz in Verbindung stehenden Informationen, z. B. die Details einer Google Meet-Konferenz. 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
conferenceData.conferenceId string Die ID der Konferenz.

Kann von Entwicklern verwendet werden, um Konferenzen im Auge zu behalten, sollte Nutzern nicht angezeigt werden.

Der ID-Wert wird für jeden Konferenzlösungstyp unterschiedlich definiert:

  • eventHangout: ID ist nicht festgelegt. (Dieser Konferenztyp wurde eingestellt.)
  • eventNamedHangout: Die ID ist der Name des Hangout. (Dieser Konferenztyp wurde eingestellt.)
  • hangoutsMeet: Die ID ist der aus zehn Buchstaben bestehende Besprechungscode, z. B. aaa-bbbb-ccc.
  • addOn: Die ID wird vom Drittanbieter definiert.
Optional.

conferenceData.conferenceSolution nested object Konferenzlösung, z. B. Google Meet

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

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest ist erforderlich.

conferenceData.conferenceSolution.iconUri string Das für diese Lösung sichtbare Symbol.
conferenceData.conferenceSolution.key nested object Der Schlüssel, der die Konferenzlösung für dieses Ereignis eindeutig identifizieren kann.
conferenceData.conferenceSolution.key.type string Der Konferenzlösungstyp.

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

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; bei vorhandenen Ereignissen wird dieser Konferenzlösungstyp möglicherweise angezeigt, es können jedoch keine neuen Konferenzen erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace (eingestellt; bei vorhandenen Terminen wird dieser Lösungstyp angezeigt, es können jedoch keine neuen Konferenzen erstellt werden)
  • "hangoutsMeet" für Google Meet (http://meet.google.com)
  • "addOn" für Konferenzanbieter

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

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest ist erforderlich.

conferenceData.createRequest.conferenceSolutionKey nested object Konferenzlösung, z. B. Hangouts oder Google Meet
conferenceData.createRequest.conferenceSolutionKey.type string Der Konferenzlösungstyp.

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

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; bei vorhandenen Ereignissen wird dieser Konferenzlösungstyp möglicherweise angezeigt, es können jedoch keine neuen Konferenzen erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace (eingestellt; bei vorhandenen Terminen wird dieser Lösungstyp angezeigt, es können jedoch keine neuen Konferenzen erstellt werden)
  • "hangoutsMeet" für Google Meet (http://meet.google.com)
  • "addOn" für Konferenzanbieter

conferenceData.createRequest.requestId string Die vom Client generierte eindeutige ID für diese Anfrage.

Clients sollten diese ID bei jeder neuen Anfrage neu generieren. Wenn die angegebene ID mit der Anfrage identisch ist, wird sie ignoriert.

conferenceData.createRequest.status nested object Der Status der Anfrage zum Erstellen der Konferenz.
conferenceData.createRequest.status.statusCode string Der aktuelle Status der Anfrage zum Erstellen der Konferenz. Schreibgeschützt.

Die möglichen Werte sind:

  • "pending": Die Anfrage zum Erstellen der Konferenz wird noch verarbeitet.
  • "success": Die Anfrage zum Erstellen der Konferenz war erfolgreich. Die Einstiegspunkte werden ausgefüllt.
  • "failure": Die Anfrage zum Erstellen der Konferenz ist fehlgeschlagen. Es gibt keine Einstiegspunkte.

conferenceData.entryPoints[] list Informationen zu den einzelnen Einstiegspunkten einer Konferenz, z. B. URLs oder Telefonnummern

Alle müssen zu derselben Konferenz gehören.

Entweder conferenceSolution und mindestens ein entryPoint oder createRequest ist erforderlich.

conferenceData.entryPoints[].accessCode string Der Zugriffscode für den Zugriff auf die Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Teilmenge der Felder für {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. Nur die ausgefüllten Felder sollten 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 null oder einen video-Einstiegspunkt haben.
  • "phone" – Sie wählen eine Telefonnummer, um an einer Konferenz teilzunehmen. Eine Konferenz kann null oder mehr phone-Einstiegspunkte haben.
  • "sip" – Teilnahme an einer Konferenz über SIP. Eine Konferenz kann null oder einen sip-Einstiegspunkt haben.
  • "more": Weitere Anweisungen zur Teilnahme an einer Konferenz, z. B. zusätzliche Telefonnummern Eine Konferenz kann null oder einen more-Einstiegspunkt haben. Eine Konferenz mit nur einem more-Einstiegspunkt ist keine gültige Konferenz.

conferenceData.entryPoints[].label string Das Label des URI. Für Endnutzer sichtbar. Nicht lokalisiert. Die maximale Länge beträgt 512 Zeichen.

Beispiele:

  • für video: meet.google.com/aaa-bbbb-webstore
  • phone: +1 123 268 2601
  • für sip: 12345678@altostrat.com
  • für more: darf 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 für {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. Nur die ausgefüllten Felder sollten angezeigt werden.

Optional.

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

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Teilmenge der Felder für {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. Nur die ausgefüllten Felder sollten 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 für {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. Nur die ausgefüllten Felder sollten 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 für {meetingCode, accessCode, passcode, password, pin} aus, die der Terminologie des Konferenzanbieters entsprechen. Nur die ausgefüllten Felder sollten 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:-Schema ist erforderlich.
  • für phone ist das Schema tel: erforderlich. Der URI sollte die gesamte Wählsequenz enthalten, z.B. tel:+12345678900,,,123456789;1234.
  • Für sip ist das Schema sip: erforderlich, z.B. sip:12345678@IhrUnternehmen.de.
  • Für more-, http:- oder https:-Schema 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.

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

Optional für eine Konferenz mit einer ausstehenden Erstellungsanfrage.

created datetime Erstellungszeitpunkt des Ereignisses (als RFC3339-Zeitstempel) Schreibgeschützt.
creator object Der Ersteller des Ereignisses. Schreibgeschützt.
creator.displayName string Der Name des Creators, falls verfügbar
creator.email string Die E-Mail-Adresse des Creators, 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 erscheint. Schreibgeschützt. Die Standardeinstellung ist "False".
description string Beschreibung der Veranstaltung. Kann HTML enthalten. Optional. Bearbeitbar
end nested object Das (exklusive) Ende des Ereignisses. Bei einem wiederkehrenden Termin ist dies das Ende der ersten Instanz.
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 Wert für Datum/Uhrzeit (gemäß RFC3339 formatiert). Es muss eine Zeitzone angegeben werden, sofern in timeZone keine Zeitzone explizit angegeben ist. Bearbeitbar
end.timeZone string Die Zeitzone, in der die Zeit angegeben wird. Formatiert als IANA-Zeitzonendatenbankname, z.B. „Europa/Zürich“. Bei wiederkehrenden Terminen ist dieses Feld erforderlich und gibt die Zeitzone an, in der die Serie maximiert wird. Bei Einzelterminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende des Termins an. Bearbeitbar
endTimeUnspecified boolean Gibt an, ob das Ende tatsächlich nicht angegeben ist. Aus Kompatibilitätsgründen wird auch dann ein Ende angegeben, wenn das Attribut auf „true“ gesetzt ist. Die Standardeinstellung ist "False".
etag etag ETag der Ressource.
eventType string Bestimmter Ereignistyp. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte sind:
  • default“: ein reguläres Ereignis oder wird nicht näher spezifiziert
  • "outOfOffice": Ein Außer-Haus-Termin
  • focusTime“: Ein Fokuszeit-Termin
  • workingLocation“: Ein Arbeitsort.
Derzeit können mit der API nur Ereignisse vom Typ „default“ und „workingLocation“ erstellt werden. Erweiterte Unterstützung für andere Ereignistypen wird in späteren Versionen verfügbar gemacht.
Bearbeitbar
extendedProperties object Erweiterte Eigenschaften des Ereignisses.
extendedProperties.private object Eigenschaften, die privat für die Kopie des Termins sind, die in diesem Kalender angezeigt wird. Bearbeitbar
extendedProperties.private.(key) string Der Name der privaten Property und der entsprechende Wert.
extendedProperties.shared object Eigenschaften, die zwischen den Kopien des Termins in den Kalendern anderer Teilnehmer freigegeben sind. Bearbeitbar
extendedProperties.shared.(key) string Der Name der freigegebenen Property und der entsprechende Wert.
gadget object Ein Gadget, das dieses Ereignis erweitert. Gadgets wurden eingestellt. Diese Struktur wird nur bei der Rückgabe von Geburtstagskalender-Metadaten verwendet.
gadget.display string 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 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.preferences.(key) string Der Name der Einstellung und der entsprechende Wert.
gadget.title string Der Titel des Gadgets. Veraltet. Bearbeitbar
gadget.type string Der Typ des Gadgets. Veraltet. Bearbeitbar
gadget.width integer Breite des Gadgets in Pixeln Die Breite muss eine Ganzzahl größer als 0 sein. Optional. Veraltet. Bearbeitbar
guestsCanInviteOthers boolean Gibt an, ob andere Gäste als der Organisator andere zu einem Termin einladen können. Optional. Der Standardwert ist „True“. Bearbeitbar
guestsCanModify boolean Gibt an, ob Gäste außerhalb des Organisators den Termin ändern können. Optional. Die Standardeinstellung ist "False". Bearbeitbar
guestsCanSeeOtherGuests boolean Gibt an, ob Gäste außerhalb des Organisators sehen können, wer die Gäste sind. Optional. Der Standardwert ist „True“. Bearbeitbar
iCalUID string Eindeutige Ereignis-ID gemäß der Definition in RFC5545. Sie wird verwendet, um Ereignisse in mehreren Kalendersystemen eindeutig zu identifizieren. Sie muss beim Importieren von Ereignissen über die import-Methode angegeben werden.

Beachten Sie, dass iCalUID und id nicht identisch sind und nur eines davon beim Erstellen des Ereignisses angegeben werden sollte. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Ereignissen alle Vorkommnisse eines Ereignisses unterschiedliche ids haben, während sie alle dieselben iCalUIDs haben. Wenn Sie ein Ereignis mit iCalUID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf. Wenn Sie ein Ereignis mithilfe von id abrufen möchten, rufen Sie die Methode events.get auf.

id string Undurchsichtige ID des Ereignisses. Beim Erstellen neuer einzelner oder wiederkehrender Termine können Sie die IDs dieser Personen angeben. Bereitgestellte IDs müssen diesen Regeln entsprechen:
  • In der ID zulässige Zeichen sind die, die in der base32hex-Codierung verwendet werden, d. h. die Kleinbuchstaben a-v und die Ziffern 0-9, siehe Abschnitt 3.1.2 in RFC2938.
  • Die ID-ID muss zwischen 5 und 1.024 Zeichen lang sein
  • Die ID muss für jeden Kalender eindeutig sein
Aufgrund der global verteilten Funktion des Systems können wir nicht dafür sorgen, dass es beim Erstellen von Ereignissen zu Kollisionen mit der ID kommt. Um das Risiko von Kollisionen zu minimieren, empfehlen wir Ihnen, einen UUID-Algorithmus wie RFC4122 zu verwenden.

Wenn du keine ID angibst, wird sie automatisch vom Server 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 Geografischer Ort des Ereignisses als freier Text. Optional. Bearbeitbar
locked boolean Ob es sich um eine gesperrte Ereigniskopie handelt, in der keine Änderungen an den Hauptereignisfeldern „summary“, „description“, „location“, „start“, „end“ oder „recurence“ vorgenommen werden können. Die Standardeinstellung ist "False". (schreibgeschützt).
organizer object Der Organisator des Termins. Wenn der Organisator auch ein Teilnehmer ist, wird das mit einem separaten Eintrag in attendees angezeigt, wobei das Feld organizer auf „True“ gesetzt ist. Zum Ändern des Organisators verwenden Sie den Verschieben. Schreibgeschützt, außer beim Importieren eines Ereignisses Bearbeitbar
organizer.displayName string Der Name des Organisators, falls verfügbar. Bearbeitbar
organizer.email string E-Mail-Adresse des Organisators, falls verfügbar Es muss sich um eine gültige E-Mail-Adresse gemäß RFC5322 handeln. 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 einem wiederkehrenden Termin ist dies der Zeitpunkt, zu dem dieses Ereignis gemäß den Wiederholungsdaten im wiederkehrenden Ereignis beginnt, das durch „wiederkehrende Veranstaltung“ identifiziert ist. Sie identifiziert die Instanz in der wiederkehrenden Ereignisserie eindeutig, selbst wenn die Instanz zu einer anderen 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 Wert für Datum/Uhrzeit (gemäß RFC3339 formatiert). Es muss eine Zeitzone angegeben werden, sofern in timeZone keine Zeitzone explizit angegeben ist. Bearbeitbar
originalStartTime.timeZone string Die Zeitzone, in der die Zeit angegeben wird. Formatiert als IANA-Zeitzonendatenbankname, z.B. „Europa/Zürich“. Bei wiederkehrenden Terminen ist dieses Feld erforderlich und gibt die Zeitzone an, in der die Serie maximiert wird. Bei Einzelterminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende des Termins an. Bearbeitbar
privateCopy boolean Ist die Richtlinie auf „wahr“ gesetzt, wird die Ereignisverbreitung deaktiviert. Sie ist nicht mit den Eigenschaften von privaten Ereignissen identisch. Optional. Nicht veränderbar. Die Standardeinstellung ist "False".
recurrence[] list Liste der Zeilen RRULE, EXRULE, RDATE und EXDATE für ein wiederkehrendes Ereignis, wie in RFC5545 angegeben. Beachten Sie, dass DTSTART- und DTEND-Zeilen in diesem Feld nicht zulässig sind. Start- und Endzeiten für Ereignisse sind in den Feldern start und end angegeben. Dieses Feld wird für einzelne Ereignisse oder Instanzen wiederkehrender Ereignisse weggelassen. Bearbeitbar
recurringEventId string Für eine 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 Erinnerungen des Ereignisses für den authentifizierten Nutzer.
reminders.overrides[] list Falls für den Termin nicht die Standarderinnerungen verwendet werden, werden hier die spezifischen Erinnerungen für den Termin aufgeführt. Falls nicht, wird eine Erinnerung angezeigt. Die maximale Anzahl der Überschreibungserinnerungen beträgt 5. 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 UI-Pop-up gesendet.

Erforderlich beim Hinzufügen einer Erinnerung.

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

Erforderlich beim Hinzufügen einer Erinnerung.

Bearbeitbar
reminders.useDefault boolean Gibt an, ob die Standarderinnerungen für den Kalender auf den Termin angewendet werden. Bearbeitbar
sequence integer Sequenznummer gemäß iCalendar Bearbeitbar
source object Quelle, aus der das Ereignis erstellt wurde. Beispiele hierfür sind Webseiten, E-Mails oder Dokumente, die anhand einer URL ermittelt werden können, die das HTTP- oder HTTPS-Schema verwendet. Sie können nur vom Ersteller des Termins gesehen oder geändert werden.
source.title string Titel der Quelle, etwa ein Titel auf 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 nested object Der Beginn (einschließlich) des Ereignisses. 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 Wert für Datum/Uhrzeit (gemäß RFC3339 formatiert). Es muss eine Zeitzone angegeben werden, sofern in timeZone keine Zeitzone explizit angegeben ist. Bearbeitbar
start.timeZone string Die Zeitzone, in der die Zeit angegeben wird. Formatiert als IANA-Zeitzonendatenbankname, z.B. „Europa/Zürich“. Bei wiederkehrenden Terminen ist dieses Feld erforderlich und gibt die Zeitzone an, in der die Serie maximiert wird. Bei Einzelterminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn und das Ende des Termins an. Bearbeitbar
status string Der 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“: Der Termin wurde abgesagt (gelöscht). Die Methode list gibt abgebrochene Ereignisse nur bei schrittweiser Synchronisierung zurück, wenn syncToken oder updatedMin angegeben sind, oder wenn das Flag showDeleted auf true gesetzt ist. Sie werden mit der Methode get immer zurückgegeben.

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

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

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

    2. Alle anderen abgesagten Ereignisse stellen gelöschte Termine dar. Kunden sollten ihre lokal synchronisierten Kopien entfernen. Solche Termine werden demnächst nicht mehr verfügbar sein. Verlassen Sie sich also nicht darauf, dass sie auf unbestimmte Zeit verfügbar sind.

      Bei gelöschten Ereignissen kann das Feld id garantiert nur ausgefüllt werden.

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

    Wenn ein Organisator den Termin ändert (z. B. durch den Vorgang move) und der ursprüngliche Organisator nicht auf der Teilnehmerliste steht, bleibt ein Termin abgesagt, bei 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 gespeichert. Das entspricht der Einstellung Anzeigen als auf Beschäftigt in der Google Kalender-Benutzeroberfläche.
  • transparent“: Der Termin wird nicht in den Kalender eingetragen. Dies entspricht der Einstellung Anzeigen als in der Google Kalender-Benutzeroberfläche auf Verfügbar.
Bearbeitbar
updated datetime Zeitpunkt der letzten Änderung des Ereignisses (als RFC3339-Zeitstempel). Schreibgeschützt.
visibility string Sichtbarkeit des Termins Optional. Mögliche Werte sind:
  • 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“ – Der Termin ist privat und nur die Teilnehmer können die Termindetails sehen.
  • confidential“ – Der Termin ist privat. Dieser Wert wird aus Kompatibilitätsgründen angegeben.
Bearbeitbar
workingLocationProperties nested object Daten zu Arbeitsortereignissen. Bearbeitbar
workingLocationProperties.customLocation object Falls vorhanden, gibt dieser Wert 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, wird angegeben, dass der Nutzer zu Hause arbeitet. Bearbeitbar
workingLocationProperties.officeLocation object Falls vorhanden, wird angegeben, dass der Nutzer von einem Büro aus arbeitet. Bearbeitbar
workingLocationProperties.officeLocation.buildingId string Eine optionale Gebäude-ID. Dies 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 Kennung für den Mindestbetrag. Bearbeitbar
workingLocationProperties.officeLocation.floorSectionId string Eine optionale Kennung für den Bodenabschnitt. Bearbeitbar
workingLocationProperties.officeLocation.label string Der Name des Büros, der in Google Kalender-Web- und mobilen Clients angezeigt wird. Wir empfehlen, in der Ressourcendatenbank der Organisation auf einen Gebäudenamen zu verweisen. Bearbeitbar
workingLocationProperties.type string Typ des Arbeitsortes. Mögliche Werte sind:
  • homeOffice“: Der Nutzer arbeitet zu Hause.
  • officeLocation“: Der Nutzer arbeitet in einem Büro.
  • customLocation“: Der Nutzer arbeitet an einem benutzerdefinierten Standort.
. Details werden in einem untergeordneten Feld des angegebenen Namens angegeben. Es kann jedoch fehlen, wenn es leer ist. Alle anderen Felder werden ignoriert.

Erforderlich, wenn Eigenschaften für Arbeitsort hinzugefügt werden.

Bearbeitbar

Methoden

Delete
Löscht einen Termin.
Erwerben
Gibt einen Termin basierend auf der Google Kalender-ID zurück Wenn Sie ein Ereignis mit der iCalendar-ID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf.
Importieren
Importiert ein Ereignis. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt.
Einfügen
Erstellt ein Ereignis.
Instanzen
Gibt Instanzen des angegebenen wiederkehrenden Ereignisses zurück
list
Gibt Termine im angegebenen Kalender zurück.
verschieben
Es wird ein Termin in einen anderen Kalender verschoben, d.h. der Organisator eines Termins wird geändert.
Patch
Aktualisiert ein Ereignis. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass jede Patchanfrage drei Kontingenteinheiten verbraucht. Verwenden Sie vorzugsweise ein get, gefolgt von einem update. Die angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, falls angegeben, überschreiben die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
schnell hinzufügen
Erstellt ein Ereignis basierend auf einem einfachen Textstring.
Aktualisieren
Aktualisiert ein Ereignis. Diese Methode unterstützt keine Patchsemantik und aktualisiert immer die gesamte Ereignisressource. Für eine teilweise Aktualisierung führen Sie ein get gefolgt von einem update mit Etags aus, um für Vollständigkeit zu sorgen.
Ansehen
Achten Sie auf Änderungen an Ereignisressourcen.