Die Calendar API bietet verschiedene Varianten von Terminressourcen. 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": { "type": string, "homeOffice": (value), "customLocation": { "label": string }, "officeLocation": { "buildingId": string, "floorId": string, "floorSectionId": string, "deskId": string, "label": string } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "birthdayProperties": { "contact": string, "type": string, "customTypeName": string }, "eventType": string }
Property-Name | Wert | Beschreibung | Hinweise |
---|---|---|---|
anyoneCanAddSelf |
boolean |
Ob sich jeder zu dem Termin selbst 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 Pro Ereignis können maximal 25 Anhänge vorhanden sein. |
|
attachments[].fileId |
string |
ID der angehängten Datei. Schreibgeschützt. Bei Google Drive-Dateien ist dies die ID des entsprechenden |
|
attachments[].fileUrl |
string |
URL-Link zum Anhang. Verwenden Sie für das Hinzufügen von Google Drive-Dateianhängen dasselbe Format wie in der Erforderlich, wenn ein Anhang hinzugefügt wird. |
Bearbeitbar |
attachments[].iconLink |
string |
URL-Link zum Symbol des Anhangs. Dieses Feld kann nur für benutzerdefinierte Drittanbieteranhänge geändert werden. | |
attachments[].mimeType |
string |
Der Internet-Medientyp (MIME-Typ) des Anhangs. | |
attachments[].title |
string |
Titel des Anhangs. | |
attendeesOmitted |
boolean |
Gibt an, ob Teilnehmer möglicherweise aus der Darstellung der Veranstaltung ausgelassen wurden. Wenn beim Abrufen eines Ereignisses keine Daten zurückgegeben werden, kann das an einer Einschränkung liegen, die durch den Abfrageparameter maxAttendee festgelegt wurde. Wenn Sie ein Ereignis aktualisieren, können Sie damit nur die Antwort des Teilnehmers aktualisieren. Optional. Die Standardeinstellung ist "False". |
Bearbeitbar |
attendees[] |
list |
Die Teilnehmer der Veranstaltung. Weitere Informationen zum Planen von Terminen mit anderen Kalendernutzern finden Sie im Hilfeartikel Termine mit Teilnehmern. Für Dienstkonten muss die domainweite Delegierung von Befugnissen verwendet werden, um die Teilnehmerliste zu erstellen. | Bearbeitbar |
attendees[].additionalGuests |
integer |
Anzahl der zusätzlichen Gäste. Optional. Der Standardwert ist 0. | Bearbeitbar |
attendees[].comment |
string |
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 beim Hinzufügen eines Gasts vorhanden sein. Es muss eine gültige E-Mail-Adresse gemäß RFC5322 sein. Erforderlich, wenn ein Teilnehmer hinzugefügt wird. |
Bearbeitbar |
attendees[].id |
string |
Die Profil-ID des Teilnehmers, falls verfügbar. | |
attendees[].optional |
boolean |
Gibt an, ob dies ein optionaler Teilnehmer ist. Optional. Die Standardeinstellung ist "False". | Bearbeitbar |
attendees[].organizer |
boolean |
Gibt an, ob der Teilnehmer der Organisator der Veranstaltung ist. Schreibgeschützt. Die Standardeinstellung ist "False". | |
attendees[].resource |
boolean |
Gibt an, ob der Gast eine Ressource ist. Kann nur festgelegt werden, wenn der Teilnehmer der Veranstaltung 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:
|
Bearbeitbar |
attendees[].self |
boolean |
Gibt an, ob dieser Eintrag für den Kalender steht, in dem diese Kopie des Termins angezeigt wird. Schreibgeschützt. Die Standardeinstellung ist "False". | |
birthdayProperties |
nested object |
Daten zu Geburtstagen oder besonderen Ereignissen Wird verwendet, wenn eventType den Wert "birthday" hat. Nicht veränderbar. |
Bearbeitbar |
birthdayProperties.contact |
string |
Ressourcenname des Kontakts, mit dem dieser Geburtstagstermin verknüpft ist. Damit können Kontaktdaten aus der People API abgerufen werden. Format: "people/c12345" . Schreibgeschützt. |
|
birthdayProperties.customTypeName |
string |
Für dieses Ereignis angegebenes Label für benutzerdefinierten Typ. Dieser Wert wird ausgefüllt, wenn birthdayProperties.type auf "custom" festgelegt ist. Schreibgeschützt. |
|
birthdayProperties.type |
string |
Art des Geburtstags oder besonderen Ereignisses. Mögliche Werte sind:
"birthday" . Der Typ kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. |
Bearbeitbar |
colorId |
string |
Die Farbe des Ereignisses. Dies ist eine ID, die sich auf einen Eintrag im Abschnitt event der Farbdefinition bezieht (siehe Farbenendpunkt). 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 gespeichert werden, müssen Sie den Anfrageparameter conferenceDataVersion für alle Anfragen zur Ereignisänderung auf 1 festlegen. |
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 gebildet:
|
|
conferenceData.conferenceSolution |
nested object |
Die Konferenzlösung, z. B. Google Meet. Wird für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage zurückgesetzt. Entweder |
|
conferenceData.conferenceSolution.iconUri |
string |
Das für Nutzer sichtbare Symbol für diese Lösung. | |
conferenceData.conferenceSolution.key |
nested object |
Der Schlüssel, mit dem die Konferenzlösung für dieses Ereignis eindeutig identifiziert werden kann. | |
conferenceData.conferenceSolution.key.type |
string |
Der Konferenzlösungstyp. Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollten die Einstiegspunkte trotzdem angezeigt werden können. Änderungen sollten jedoch nicht zulässig sein. Die möglichen Werte sind:
|
|
conferenceData.conferenceSolution.name |
string |
Der für den Nutzer sichtbare Name dieser Lösung. Nicht lokalisiert. | |
conferenceData.createRequest |
nested object |
Eine Anfrage zum Generieren einer neuen Konferenz und zum Anhängen an das Ereignis. Die Daten werden asynchron generiert. Im Feld status sehen Sie, ob die Daten vorhanden sind. Es muss entweder |
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
Die Konferenzlösung, z. B. Hangouts oder Google Meet. | |
conferenceData.createRequest.conferenceSolutionKey.type |
string |
Der Lösungstyp für Konferenzen. Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollten die Einstiegspunkte trotzdem angezeigt werden können. Änderungen sollten jedoch nicht zulässig sein. Die möglichen Werte sind:
|
|
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 ID mit der der vorherigen 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:
|
|
conferenceData.entryPoints[] |
list |
Informationen zu einzelnen Konferenzzugangspunkten, z. B. URLs oder Telefonnummern. Sie müssen alle zur selben Konferenz gehören. Es muss entweder |
|
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 { Optional. |
|
conferenceData.entryPoints[].entryPointType |
string |
Der Typ des Konferenzeinstiegspunkts. Folgende Werte sind möglich:
|
|
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:
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 { Optional. |
|
conferenceData.entryPoints[].passcode |
string |
Der Sicherheitscode 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 { |
|
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 { 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 { Optional. |
|
conferenceData.entryPoints[].uri |
string |
Der URI des Einstiegspunkts. Die maximale Länge beträgt 1.300 Zeichen. Format:
|
|
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. Festlegung für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage aufgehoben. Optional für eine Konferenz mit einer ausstehenden Anfrage zum Erstellen. |
|
created |
datetime |
Erstellungszeit des Ereignisses (als RFC3339-Zeitstempel). Schreibgeschützt. | |
creator |
object |
Der Ersteller der Veranstaltung. Schreibgeschützt. | |
creator.displayName |
string |
Der Name des Creators, 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 |
Die (ausschließliche) Endzeit des Ereignisses. Bei einem wiederkehrenden Termin ist dies das Ende des ersten Termins. | |
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 Datums- und Zeitwert (formatiert gemäß RFC3339). Ein Zeitzonenversatz ist erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. |
Bearbeitbar |
end.timeZone |
string |
Die Zeitzone, in der die Uhrzeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die wiederkehrende Termine angezeigt werden. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn/das Ende des Ereignisses an. | Bearbeitbar |
endTimeUnspecified |
boolean |
Gibt an, ob die Endzeit nicht angegeben ist. Aus Kompatibilitätsgründen wird immer ein Endzeitpunkt angegeben, auch wenn dieses Attribut auf „True“ gesetzt ist. Die Standardeinstellung ist "False". | |
etag |
etag |
ETag der Ressource. | |
eventType |
string |
Spezifischer Ereignistyp. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte:
|
Bearbeitbar |
extendedProperties |
object |
Erweiterte Properties des Ereignisses. | |
extendedProperties.private |
object |
Eigenschaften, die nur für die Kopie des in diesem Kalender angezeigten Termins gelten. | 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 geteilt werden. | Bearbeitbar |
extendedProperties.shared.(key) |
string |
Der Name der freigegebenen Property und der entsprechende Wert. | |
focusTimeProperties |
nested object |
Fokuszeit-Ereignisdaten. Wird verwendet, wenn eventType focusTime ist. |
Bearbeitbar |
focusTimeProperties.autoDeclineMode |
string |
Ob Besprechungseinladungen abgelehnt werden sollen, die mit Fokuszeit-Terminen übereinstimmen. Gültige Werte sind declineNone , was bedeutet, dass keine Besprechungseinladungen abgelehnt werden; declineAllConflictingInvitations , was bedeutet, dass alle Besprechungseinladungen, die mit dem Termin in Konflikt stehen, abgelehnt werden; und declineOnlyNewConflictingInvitations , was bedeutet, dass nur neue Besprechungseinladungen abgelehnt werden, die während der Fokuszeit eingehen. |
|
focusTimeProperties.chatStatus |
string |
Der Status, mit dem der Nutzer in Google Chat und ähnlichen Produkten gekennzeichnet wird. Dies kann available oder doNotDisturb sein. |
|
focusTimeProperties.declineMessage |
string |
Antwortnachricht, die festgelegt wird, wenn ein vorhandener Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird. | |
gadget |
object |
Ein Gadget, das dieses Ereignis erweitert. Gadgets werden nicht mehr unterstützt. Diese Struktur wird stattdessen nur noch für die Rückgabe von Metadaten für den Geburtstagskalender verwendet. | |
gadget.display |
string |
Der Anzeigemodus des Gadgets. Verworfen. Mögliche Werte:
|
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.iconLink |
string |
Die Symbol-URL des Gadgets. Das URL-Schema muss HTTPS sein. Verworfen. | Bearbeitbar |
gadget.link |
string |
Die URL des Gadgets. Das URL-Schema muss HTTPS sein. Verworfen. | 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. 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 |
Ob andere Teilnehmer als der Organisator andere zum Termin einladen können. Optional. Der Standardwert ist „True“. | Bearbeitbar |
guestsCanModify |
boolean |
Ob andere Teilnehmer als der Organisator die Veranstaltung ändern können. Optional. Die Standardeinstellung ist "False". | Bearbeitbar |
guestsCanSeeOtherGuests |
boolean |
Ob andere Teilnehmer als der Organisator sehen können, wer die Teilnehmer der Veranstaltung sind. Optional. Der Standardwert ist „True“. | Bearbeitbar |
hangoutLink |
string |
Ein absoluter Link zum Google Hangout, der mit diesem Ereignis verknüpft ist. Schreibgeschützt. | |
htmlLink |
string |
Ein absoluter Link zu diesem Termin in der Weboberfläche von Google Kalender. Schreibgeschützt. | |
iCalUID |
string |
Die eindeutige Kennung des Ereignisses gemäß RFC5545. Sie wird verwendet, um Ereignisse in allen Kalendersystemen eindeutig zu identifizieren, und muss beim Importieren von Ereignissen über die Methode import bereitgestellt werden.
|
|
id |
string |
Intransparente Kennung des Ereignisses. Wenn Sie neue einmalige oder wiederkehrende Ereignisse erstellen, können Sie deren IDs angeben. Angegebene IDs müssen den folgenden Regeln entsprechen:
Wenn Sie keine ID angeben, wird sie vom Server automatisch generiert. Beachten Sie, dass |
Bearbeitbar |
kind |
string |
Typ der Ressource („calendar#event “). |
|
location |
string |
Der geografische Standort des Ereignisses als Freitext. Optional. | Bearbeitbar |
locked |
boolean |
Ob es sich um eine gesperrte Terminkopie handelt, bei der keine Änderungen an den Hauptereignisfeldern „Zusammenfassung“, „Beschreibung“, „Ort“, „Beginn“, „Ende“ oder „Wiederholung“ 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. Verwenden Sie den Vorgang move, um den Organisator zu ändern. 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 |
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 einer Instanz eines wiederkehrenden Ereignisses ist dies die Uhrzeit, zu der dieses Ereignis gemäß den Wiederholungsdaten im wiederkehrenden Ereignis mit der ID „recurringEventId“ beginnen würde. Sie dient der eindeutigen Identifizierung der Instanz innerhalb der wiederkehrenden Ereignisreihe, auch wenn die Instanz auf eine andere 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 Datums- und Zeitwert (formatiert gemäß RFC3339). Ein Zeitzonenversatz ist erforderlich, sofern in timeZone nicht explizit eine Zeitzone angegeben ist. |
Bearbeitbar |
originalStartTime.timeZone |
string |
Die Zeitzone, in der die Uhrzeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die wiederkehrende Termine angezeigt werden. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn/das Ende des Ereignisses an. | Bearbeitbar |
outOfOfficeProperties |
nested object |
Daten zu Abwesenheitsereignissen Wird verwendet, wenn eventType outOfOffice ist. |
Bearbeitbar |
outOfOfficeProperties.autoDeclineMode |
string |
Ob Besprechungseinladungen mit sich überschneidenden Außer-Haus-Terminen abgelehnt werden sollen. Gültige Werte sind declineNone , was bedeutet, dass keine Besprechungseinladungen abgelehnt werden; declineAllConflictingInvitations , was bedeutet, dass alle Besprechungseinladungen abgelehnt werden, die mit dem Termin in Konflikt stehen; und declineOnlyNewConflictingInvitations , was bedeutet, dass nur neue Besprechungseinladungen abgelehnt werden, die mit dem Abwesenheitsereignis in Konflikt stehen. |
|
outOfOfficeProperties.declineMessage |
string |
Antwortnachricht, die festgelegt wird, wenn ein vorhandener Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird. | |
privateCopy |
boolean |
Wenn die Richtlinie auf „True“ gesetzt ist, ist die Ereignisweitergabe deaktiviert. Hinweis: Das ist nicht dasselbe wie Properties für private Ereignisse. Optional. Nicht veränderbar. Die Standardeinstellung ist "False". | |
recurrence[] |
list |
Liste der Zeilen RRULE, EXRULE, RDATE und EXDATE für ein wiederkehrendes Ereignis gemäß RFC5545. In diesem Feld sind keine DTSTART- und DTEND-Zeilen zulässig. Beginn und Ende der Veranstaltung werden in den Feldern start und end angegeben. Dieses Feld wird für einzelne Ereignisse oder Instanzen wiederkehrender Ereignisse weggelassen. |
Bearbeitbar |
recurringEventId |
string |
Bei einer 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 Terminerinnerungen für den authentifizierten Nutzer. Hinweis: Wenn Sie Erinnerungen ändern, ändert sich nicht auch die Eigenschaft updated des einschließenden Termins. |
|
reminders.overrides[] |
list |
Wenn für das Ereignis nicht die Standarderinnerungen verwendet werden, werden hier die für das Ereignis spezifischen Erinnerungen aufgeführt. Andernfalls wird angezeigt, dass für dieses Ereignis keine Erinnerungen festgelegt sind. Die maximale Anzahl von Erinnerungen zum Überschreiben ist 5. | Bearbeitbar |
reminders.overrides[].method |
string |
Die von dieser Erinnerung verwendete Methode. Mögliche Werte:
Erforderlich, wenn Sie eine Erinnerung hinzufügen. |
Bearbeitbar |
reminders.overrides[].minutes |
integer |
Anzahl der Minuten vor Beginn der Veranstaltung, zu der die Erinnerung ausgelöst werden soll. Gültige Werte liegen zwischen 0 und 40.320 (4 Wochen in Minuten). Erforderlich, wenn Sie eine Erinnerung hinzufügen. |
Bearbeitbar |
reminders.useDefault |
boolean |
Gibt an, ob die Standarderinnerungen des Kalenders für den Termin gelten. | Bearbeitbar |
sequence |
integer |
Sequenznummer gemäß iCalendar | Bearbeitbar |
source |
object |
Quelle, aus der das Ereignis erstellt wurde. Zum Beispiel eine Webseite, eine E-Mail-Nachricht oder ein Dokument, das durch eine URL mit HTTP- oder HTTPS-Schema erkennbar ist. Kann nur vom Ersteller des Ereignisses angesehen oder geändert werden. | |
source.title |
string |
Der 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 |
nested object |
Die Startzeit des Ereignisses (inklusive). 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 Datums- und Zeitwert (formatiert gemäß RFC3339). Eine Zeitzonenverschiebung ist erforderlich, es sei denn, in timeZone ist eine Zeitzone explizit angegeben. |
Bearbeitbar |
start.timeZone |
string |
Die Zeitzone, in der die Uhrzeit angegeben ist. (Formatiert als Name der IANA-Zeitzonendatenbank, z.B. „Europa/Zürich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die wiederkehrende Termine angezeigt werden. Bei einzelnen Ereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Beginn/das Ende des Ereignisses an. | Bearbeitbar |
status |
string |
Status des Ereignisses. Optional. Mögliche Werte:
|
Bearbeitbar |
summary |
string |
Titel der Veranstaltung. | Bearbeitbar |
transparency |
string |
Gibt an, ob der Termin Zeit im Kalender blockiert. Optional. Mögliche Werte:
|
Bearbeitbar |
updated |
datetime |
Zeitpunkt der letzten Änderung der Hauptereignisdaten (als RFC3339-Zeitstempel). Dies ändert sich nicht, wenn Sie Terminerinnerungen aktualisieren. Schreibgeschützt. | |
visibility |
string |
Sichtbarkeit des Ereignisses. Optional. Mögliche Werte:
|
Bearbeitbar |
workingLocationProperties |
nested object |
Ereignisdaten zu Arbeitsorten. | Bearbeitbar |
workingLocationProperties.customLocation |
object |
Falls vorhanden: Gibt an, dass der Nutzer von einem benutzerdefinierten Standort aus arbeitet. | Bearbeitbar |
workingLocationProperties.customLocation.label |
string |
Ein optionales zusätzliches Label für zusätzliche Informationen. | Bearbeitbar |
workingLocationProperties.homeOffice |
any value |
Falls vorhanden: Gibt an, dass der Nutzer zu Hause arbeitet. | Bearbeitbar |
workingLocationProperties.officeLocation |
object |
Gibt an, dass der Nutzer in einem Büro arbeitet. | Bearbeitbar |
workingLocationProperties.officeLocation.buildingId |
string |
Eine optionale Gebäudekennzeichnung. Diese 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 Stockwerkskennzeichnung. | Bearbeitbar |
workingLocationProperties.officeLocation.floorSectionId |
string |
Eine optionale Etagenabschnitts-ID. | Bearbeitbar |
workingLocationProperties.officeLocation.label |
string |
Der Büroname, der in Google Kalender Web und Mobile-Clients angezeigt wird. Wir empfehlen, einen Gebäudenamen in der Ressourcendatenbank der Organisation anzugeben. | Bearbeitbar |
workingLocationProperties.type |
string |
Art des Arbeitsorts. Mögliche Werte:
Erforderlich, wenn Properties für den Arbeitsort hinzugefügt werden. |
Bearbeitbar |
Methoden
- Delete
- Löst einen Termin.
- get
- Gibt einen Termin anhand seiner Google Kalender-ID zurück. Wenn Sie einen Termin anhand seiner iCalendar-ID abrufen möchten, rufen Sie die Methode „events.list“ mit dem Parameter „
iCalUID
“ auf. - import
- Ereignisse importieren. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Ereignisse mit einer
eventType
vondefault
importiert werden.Eingestelltes Verhalten:Wenn ein Ereignis importiert wird, das nicht zu
default
gehört, wird sein Typ indefault
geändert und alle ereignisbasierten Eigenschaften, die es möglicherweise hat, werden entfernt. - insert
- Erstellt einen Termin.
- Instanzen
- Gibt Instanzen des angegebenen wiederkehrenden Termins zurück.
- list
- Gibt Termine im angegebenen Kalender zurück.
- move
- Verschiebt einen Termin in einen anderen Kalender, d.h. ändert den Organisator eines Termins. Hinweis: Nur
default
-Ereignisse können verschoben werden.birthday
-,focusTime
-,fromGmail
-,outOfOffice
- undworkingLocation
-Ereignisse können nicht verschoben werden. - patch
- Aktualisiert ein Ereignis. Diese Methode unterstützt die Patch-Semantik. Hinweis: Jede Patchanfrage belegt drei Kontingenteinheiten. Verwenden Sie daher vorzugsweise
get
gefolgt vonupdate
. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Wenn Arrayfelder angegeben werden, werden die vorhandenen Arrays überschrieben. Alle vorherigen Arrayelemente werden dabei verworfen. - quickAdd
- Erstellt ein Ereignis basierend auf einem einfachen Textstring.
- aktualisieren
- Aktualisiert ein Ereignis. Diese Methode unterstützt keine Patch-Semantik und aktualisiert immer die gesamte Ereignisressource. Führen Sie für eine teilweise Aktualisierung eine
get
gefolgt von einerupdate
mit ETags aus, um für Atomarität zu sorgen. - watch
- Achten Sie auf Änderungen an den Ressourcen für Ereignisse.