Events

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Die Calendar API bietet verschiedene Ressourcen für Termine. 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": {
    "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 Anfrageparameter supportsAttachments auf true gesetzt sein.

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.

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
attachments[].mimeType string Internetmedientyp (MIME-Typ) des Anhangs.
attachments[].title string Titel des Anhangs.
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
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[].id string Die Profil-ID des Teilnehmers, falls verfügbar.
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 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
attendees[].self boolean Gibt an, ob dieser Eintrag den Kalender darstellt, in dem diese Kopie des Termins erscheint. Schreibgeschützt. Die Standardeinstellung ist "False".
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
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 definiert:

  • eventHangout: ID nicht festgelegt. Dieser Konferenztyp wurde eingestellt.
  • eventNamedHangout: ID ist der Name des Hangouts. 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 Die Konferenzlösung, z. B. Google Meet.

Für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage aufgehoben.

Entweder conferenceSolution und mindestens eine entryPoint oder createRequest ist erforderlich.

conferenceData.conferenceSolution.iconUri string Das für den Nutzer sichtbare Symbol für diese Lösung.
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 auf einen unbekannten oder leeren Typ stößt, sollte er dennoch die Einstiegspunkte anzeigen können. Änderungen sollten jedoch nicht zulässig sein.

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; für vorhandene Termine wird dieser Lösungstyp für Konferenzen möglicherweise angezeigt, aber es können keine neuen Konferenzen erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace (eingestellt; für vorhandene Termine wird dieser Lösungstyp angezeigt, aber es können 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 die 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. Im Feld status sehen Sie, ob die Daten vorhanden sind.

Entweder conferenceSolution und mindestens eine entryPoint oder createRequest ist erforderlich.

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

Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollte er dennoch die Einstiegspunkte anzeigen können. Änderungen sollten jedoch nicht zulässig sein.

Die möglichen Werte sind:

  • "eventHangout" für Hangouts für Privatnutzer (eingestellt; für vorhandene Termine wird dieser Lösungstyp für Konferenzen möglicherweise angezeigt, aber es können keine neuen Konferenzen erstellt werden)
  • "eventNamedHangout" für Nutzer des klassischen Hangouts für Google Workspace (eingestellt; für vorhandene Termine wird dieser Lösungstyp angezeigt, aber es können 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 für jede neue Anfrage neu generieren. Wenn eine bereitgestellte ID mit der ID für die vorherige 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 werden ausgefüllt.
  • "failure": Die Anfrage zum Erstellen der Konferenz ist fehlgeschlagen. Es gibt keine Einstiegspunkte.

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

Alle müssen zu derselben Konferenz gehören.

Entweder conferenceSolution und mindestens eine 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 den Teil der Felder {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 über Konferenz über HTTP. Eine Konferenz kann null oder einen video-Einstiegspunkt haben.
  • "phone" – Sie können an einer Konferenz teilnehmen, 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 null oder einen sip-Einstiegspunkt haben.
  • "more": weitere Anleitung 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 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-Courier
  • 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 die Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur den Teil der Felder {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 Der Sicherheitscode für die Konferenz. Die maximale Länge beträgt 128 Zeichen.

Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur den Teil der Felder {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 den Teil der Felder {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 den Teil der Felder {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 ein sip:-Schema erforderlich, z.B. sip:12345678@meinanbieter.de.
  • Für more-, http:- oder https:-Schema ist erforderlich.

conferenceData.notes string Zusätzliche Hinweise (z. B. Anweisungen vom Domainadministrator, rechtliche Hinweise), die dem Nutzer angezeigt werden. Kann HTML enthalten. Die maximale Länge beträgt 2048 Zeichen. Optional.
conferenceData.signature string Die Signatur der Konferenzdaten.

Serverseitig generiert.

Für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage aufgehoben.

Optional für eine Konferenz mit einer ausstehenden Erstellungsanfrage.

created datetime Zeitpunkt der Erstellung des Ereignisses (als RFC3339-Zeitstempel). Schreibgeschützt.
creator object Der Ersteller der Veranstaltung. Schreibgeschützt.
creator.displayName string Der Name des Erstellers, 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 Das Ende der Veranstaltung (exklusiv). Bei einem wiederkehrenden Termin ist dies die Endzeit 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 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
endTimeUnspecified boolean Gibt an, ob die Endzeit tatsächlich nicht angegeben ist. Aus Kompatibilitätsgründen wird weiterhin eine Endzeit angegeben, auch wenn dieses Attribut auf „True“ gesetzt ist. Die Standardeinstellung ist "False".
etag etag ETag der Ressource.
eventType string Bestimmter Ereignistyp. Schreibgeschützt. Mögliche Werte sind:
  • default“ – Ein reguläres Ereignis oder wird nicht näher spezifiziert.
  • outOfOffice“ – Außer-Haus-Termin
  • focusTime“: Fokuszeit-Ereignis
  • workingLocation“ – ein Arbeitsort-Ereignis.
extendedProperties object Erweiterte Eigenschaften des Ereignisses.
extendedProperties.private object Properties, die nur für die Kopie des Termins verfügbar sind, der 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 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 sind veraltet. Diese Struktur wird nur für die Rückgabe von Geburtstagskalender-Metadaten verwendet.
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.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 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
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.

id string Undurchsichtige Kennung des Ereignisses. Beim Erstellen neuer einzelner oder wiederkehrender Termine können Sie deren IDs angeben. Bereitgestellte IDs müssen den folgenden Regeln entsprechen:
  • In der ID sind die Zeichen zulässig, 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 muss zwischen 5 und 1.024 Zeichen lang sein.
  • Die ID muss für jeden Kalender eindeutig sein
Aufgrund der global verteilten Beschaffenheit des Systems können wir nicht garantieren, dass ID-Kollisionen zum Zeitpunkt der Ereigniserstellung erkannt werden. Zur Vermeidung von Kollisionen empfehlen wir die Verwendung eines etablierten UUID-Algorithmus wie in RFC4122.

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

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.

Bearbeitbar
kind string Typ der Ressource („calendar#event“).
location string Der geografische Ort des Ereignisses in freiem Format. Optional. Bearbeitbar
locked boolean Gibt an, ob es sich um eine gesperrte Ereigniskopie handelt, bei 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 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
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 dieser Termin gemäß den wiederkehrenden Daten im wiederkehrenden Termin beginnt, der durch wiederkehrende Ereignisse identifiziert wird. Damit wird die Instanz innerhalb der wiederkehrenden Terminserie eindeutig identifiziert, auch wenn die Instanz zu einem anderen Zeitpunkt 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 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
privateCopy boolean Bei der Einstellung „True“ ist die Ereignisverteilung deaktiviert. Hinweis: Das ist nicht dasselbe wie Eigenschaften für private Termine. 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. 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
recurringEventId string Bei einem wiederkehrenden Termin ist das der id des wiederkehrenden Termins. Nicht veränderbar.
reminders object Informationen zu den Terminerinnerungen für den authentifizierten Nutzer.
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 object Quelle, aus der das Ereignis erstellt wurde. Dies kann beispielsweise eine Webseite, eine E-Mail-Nachricht oder ein Dokument sein, das anhand einer URL im HTTP- oder HTTPS-Schema identifiziert werden kann. Können nur vom Ersteller des Termins gesehen oder geändert werden.
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 nested object Die Startzeit der Veranstaltung (inklusive). Bei einem wiederkehrenden Termin ist das die Startzeit 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 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
updated datetime Zeitpunkt der letzten Änderung des Ereignisses (als RFC3339-Zeitstempel). Schreibgeschützt.
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
workingLocationProperties nested object Ereignisdaten für Arbeitsort. Schreibgeschützt.
workingLocationProperties.customLocation object Falls vorhanden: Gibt an, dass der Nutzer von einem benutzerdefinierten Standort aus arbeitet.
workingLocationProperties.customLocation.label string Ein optionales zusätzliches Label für weitere Informationen.
workingLocationProperties.homeOffice any value Falls vorhanden: Gibt an, dass der Nutzer zu Hause arbeitet.
workingLocationProperties.officeLocation object Falls vorhanden: Gibt an, dass der Nutzer von einem Büro aus arbeitet.
workingLocationProperties.officeLocation.buildingId string Eine optionale Gebäude-ID. Sie sollte auf eine Gebäude-ID in der Ressourcendatenbank der Organisation verweisen.
workingLocationProperties.officeLocation.deskId string Eine optionale beliebige Desktop-ID.
workingLocationProperties.officeLocation.floorId string Eine optionale Mindestbetrags-ID.
workingLocationProperties.officeLocation.floorSectionId string Eine optionale Kennung für einen beliebigen Bereich des Stockwerks.
workingLocationProperties.officeLocation.label string Ein optionales zusätzliches Label für weitere Informationen.

Methoden

Delete
Löscht ein Ereignis.
erhalten
Gibt einen Termin basierend auf seiner Google Kalender-ID zurück. Wenn Sie einen Termin mit seiner iCalendar-ID abrufen möchten, rufen Sie die events.list-Methode mit dem Parameter iCalUID auf.
Importieren
Importiert ein Ereignis. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt.
Einfügen
Erstellt einen Termin.
Instanzen
Gibt Instanzen des angegebenen wiederkehrenden Termins zurück.
list
Gibt Termine im angegebenen Kalender zurück.
Verschieben
Wenn Sie einen Termin in einen anderen Kalender verschieben, wird der Organisator 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 von Ihnen 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 Teilaktualisierung führen Sie ein get gefolgt von einem update aus und verwenden dabei ETags, um die Atomarität zu gewährleisten.
ansehen
Achten Sie auf Änderungen an Veranstaltungsressourcen.