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 } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
Property-Name | Wert | Beschreibung | Hinweise |
---|---|---|---|
anyoneCanAddSelf |
boolean |
Gibt an, ob jeder 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 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 |
|
attachments[].fileUrl |
string |
URL-Link zum Anhang. Verwenden Sie zum Hinzufügen von Google Drive-Dateianhängen dasselbe Format wie im Attribut Erforderlich beim Hinzufügen eines Anhangs. |
Bearbeitbar |
attachments[].iconLink |
string |
URL-Link zum Symbol des Anhangs. Dieses Feld kann nur für benutzerdefinierte Anhänge von Drittanbietern geändert werden. | |
attachments[].mimeType |
string |
Internetmedientyp (MIME-Typ) des Anhangs. | |
attachments[].title |
string |
Titel des Anhangs. | |
attendeesOmitted |
boolean |
Gibt an, ob Teilnehmer in der Darstellung des Termins weggelassen wurden. Beim Abrufen eines Ereignisses kann dies an einer Einschränkung liegen, 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 zur Planung von Terminen mit anderen Kalendernutzern finden Sie im Leitfaden Termine mit Teilnehmern. Dienstkonten müssen eine domainweite Delegierung von Befugnissen verwenden, um die Teilnehmerliste zu füllen. | Bearbeitbar |
attendees[].additionalGuests |
integer |
Anzahl der zusätzlichen Gäste. Optional. Der Standardwert ist 0. | Bearbeitbar |
attendees[].comment |
string |
Der Kommentar des Teilnehmers. Optional. | Bearbeitbar |
attendees[].displayName |
string |
Der Name des Gastes, falls verfügbar. Optional. | Bearbeitbar |
attendees[].email |
string |
Die E-Mail-Adresse des Gastes, falls verfügbar. Dieses Feld muss vorhanden sein, wenn ein Gast hinzugefügt wird. Es muss eine gültige E-Mail-Adresse gemäß RFC5322 sein. Erforderlich beim Hinzufügen eines Gastes. |
Bearbeitbar |
attendees[].id |
string |
Die Profil-ID des Teilnehmers, falls verfügbar. | |
attendees[].optional |
boolean |
Gibt an, ob dies ein optionaler Gast ist. Optional. Die Standardeinstellung ist "False". | Bearbeitbar |
attendees[].organizer |
boolean |
Gibt an, ob der Gast der Organisator des Termins ist. Schreibgeschützt. Die Standardeinstellung ist "False". | |
attendees[].resource |
boolean |
Gibt an, ob der Gast eine Ressource ist. Kann nur festgelegt werden, wenn ein Gast zum ersten Mal dem Termin hinzugefügt wird. Nachfolgende Änderungen werden ignoriert. Optional. Die Standardeinstellung ist "False". | Bearbeitbar |
attendees[].responseStatus |
string |
Der Antwortstatus des Gastes. Mögliche Werte sind:
|
Bearbeitbar |
attendees[].self |
boolean |
Gibt an, ob dieser Eintrag den Kalender darstellt, in dem diese Kopie des Termins angezeigt wird. Schreibgeschützt. Die Standardeinstellung ist "False". | |
colorId |
string |
Die Farbe des Termins. Dies ist eine ID, die sich auf einen Eintrag im Abschnitt event der Farbdefinition bezieht (siehe Endpunkt für Farben). Optional. |
Bearbeitbar |
conferenceData |
nested object |
Informationen zur Konferenz, z. B. Details zu einer Google Meet-Konferenz Verwenden Sie das Feld createRequest , um neue Konferenzdetails zu erstellen. Damit Ihre Änderungen erhalten bleiben, müssen Sie den conferenceDataVersion -Anfrageparameter für alle Anfragen zur Ereignisänderung 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 gebildet:
|
|
conferenceData.conferenceSolution |
nested object |
Die Konferenzlösung, z. B. Google Meet. Die Festlegung für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage wurde aufgehoben. Entweder |
|
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 diese Veranstaltung eindeutig identifizieren kann. | |
conferenceData.conferenceSolution.key.type |
string |
Der Konferenzlösungstyp. Wenn ein Client auf einen unbekannten oder leeren Typ stößt, sollten die Einstiegspunkte weiterhin angezeigt werden können. Änderungen sind jedoch nicht möglich. 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 Erstellen 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 |
|
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, sollten die Einstiegspunkte weiterhin angezeigt werden können. Änderungen sind jedoch nicht möglich. 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 die angegebene 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 Konferenzeinstiegspunkten, z. B. URLs oder Telefonnummern. Alle müssen zur selben Konferenz gehören. Entweder |
|
conferenceData.entryPoints[].accessCode |
string |
Der Zugangscode 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 Felder von { Optional. |
|
conferenceData.entryPoints[].entryPointType |
string |
Der Typ des Konferenzeinstiegspunkts. Folgende Werte sind möglich:
|
|
conferenceData.entryPoints[].label |
string |
Das Label für den URI. Für Endnutzer sichtbar. Nicht lokalisiert. Die maximale Länge beträgt 512 Zeichen. Beispiele:
Optional. |
|
conferenceData.entryPoints[].meetingCode |
string |
Der Besprechungscode 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 Felder von { Optional. |
|
conferenceData.entryPoints[].passcode |
string |
Den Sicherheitscode für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen. Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von { |
|
conferenceData.entryPoints[].password |
string |
Das Passwort für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen. Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von { Optional. |
|
conferenceData.entryPoints[].pin |
string |
Die PIN für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen. Wenn Sie neue Konferenzdaten erstellen, füllen Sie nur die Felder von { 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, die dem Nutzer angezeigt werden, z. B. Anweisungen des Domainadministrators oder rechtliche Hinweise. Kann HTML enthalten. Die maximale Länge beträgt 2.048 Zeichen. Optional. | |
conferenceData.signature |
string |
Die Signatur der Konferenzdaten. Wird serverseitig generiert. Die Festlegung für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage wurde aufgehoben. Optional für eine Konferenz mit einer ausstehenden Erstellungsanfrage. |
|
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 Creators, falls verfügbar. | |
creator.id |
string |
Die Profil-ID des Creators, 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 (exklusive) 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 Datum/Uhrzeit-Wert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist ausdrücklich in timeZone angegeben. |
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 und gibt die Zeitzone an, in der die Serie erweitert wird. Bei Einzelereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses 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 dieses 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 “ und „workingLocation “ erstellt werden. In späteren Versionen wird die erweiterte Unterstützung für andere Ereignistypen eingeführt. |
Bearbeitbar |
extendedProperties |
object |
Erweiterte Eigenschaften des Ereignisses. | |
extendedProperties.private |
object |
Eigenschaften, die auf die Kopie des Termins in diesem Kalender beschränkt sind. | Bearbeitbar |
extendedProperties.private.(key) |
string |
Der Name der Privateigenschaft und der entsprechende Wert. | |
extendedProperties.shared |
object |
Eigenschaften, die von Kopien des Termins in den Kalendern anderer Teilnehmer verwendet werden. | Bearbeitbar |
extendedProperties.shared.(key) |
string |
Der Name der gemeinsam genutzten Property und der entsprechende Wert. | |
focusTimeProperties |
nested object |
Fokuszeit-Ereignisdaten. Wird verwendet, wenn eventType den Wert focusTime hat. |
Bearbeitbar |
focusTimeProperties.autoDeclineMode |
string |
Gibt an, ob Besprechungseinladungen abgelehnt werden sollen, die sich mit Fokuszeit-Terminen überschneiden. Gültige Werte sind declineNone , was bedeutet, dass keine Besprechungseinladungen abgelehnt werden, declineAllConflictingInvitations – alle in Konflikt stehenden Besprechungseinladungen, die mit dem Termin in Konflikt stehen, und declineOnlyNewConflictingInvitations , was bedeutet, dass nur neue in Konflikt stehende Besprechungseinladungen, die während des Fokuszeit-Termins eingehen, abgelehnt werden. |
|
focusTimeProperties.chatStatus |
string |
Der Status zum Markieren des Nutzers in Google Chat und zugehörigen Produkten. Dies kann available oder doNotDisturb sein. |
|
focusTimeProperties.declineMessage |
string |
Antwortnachricht, die festgelegt werden soll, wenn ein bestehender Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird. | |
gadget |
object |
Ein Gerät, das diesen Termin verlängert. Gadgets sind veraltet; diese Struktur wird stattdessen nur verwendet, um Metadaten zum Geburtstagskalender zurückzugeben. | |
gadget.display |
string |
Anzeigemodus des Gadgets Veraltet. Mögliche Werte sind:
|
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.iconLink |
string |
Symbol-URL des Gadgets Das URL-Schema muss HTTPS verwenden. Veraltet. | Bearbeitbar |
gadget.link |
string |
Die URL des Gadgets. Das URL-Schema muss HTTPS verwenden. 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 andere Personen als der Organisator andere zum Termin einladen können. Optional. Der Standardwert ist „True“. | Bearbeitbar |
guestsCanModify |
boolean |
Gibt an, ob andere Gäste als der Organisator den Termin ändern können. Optional. Die Standardeinstellung ist "False". | Bearbeitbar |
guestsCanSeeOtherGuests |
boolean |
Gibt an, ob andere Teilnehmer als der Organisator sehen können, wer die Gäste des Termins sind. Optional. Der Standardwert ist „True“. | Bearbeitbar |
hangoutLink |
string |
Ein absoluter Link zu dem 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 |
Eindeutige Kennung des Ereignisses gemäß RFC5545. Sie wird verwendet, um Termine in verschiedenen Kalendersystemen eindeutig zu identifizieren, und muss beim Importieren von Terminen über die import-Methode angegeben werden. Beachten Sie, dass |
|
id |
string |
Intransparente Kennung des Ereignisses. Wenn Sie neue einzelne oder wiederkehrende Termine erstellen, können Sie die zugehörigen IDs angeben. Die angegebenen IDs müssen den folgenden Regeln entsprechen:
Wenn Sie keine ID angeben, wird sie automatisch vom Server generiert. Beachten Sie, dass |
Bearbeitbar |
kind |
string |
Typ der Ressource („calendar#event “) |
|
location |
string |
Der geografische Ort des Ereignisses als Freitext. Optional. | Bearbeitbar |
locked |
boolean |
Gibt an, ob es sich um eine gesperrte Terminkopie handelt, bei der keine Änderungen an den Hauptterminfeldern „summary“, „description“, „location“, „start“, „end“ oder „recurrence“ vorgenommen werden können. Die Standardeinstellung ist "False". Schreibgeschützt. | |
organizer |
object |
Der Organisator des Termins. Wenn der Organisator auch ein Gast ist, wird dies durch einen separaten Eintrag in attendees angezeigt, wobei das Feld organizer auf „True“ gesetzt ist. Mit dem Vorgang Verschieben können Sie den Organisator ändern. Schreibgeschützt, außer beim Importieren eines Termins |
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 einem wiederkehrenden Termin ist dies der Zeitpunkt, zu dem dieses Ereignis gemäß den Wiederholungsdaten des wiederkehrenden Termins, der durch „rekehrendEventId“ identifiziert wird, beginnen wird. Damit wird die Instanz innerhalb der wiederkehrenden Terminserie eindeutig identifiziert, 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 Datum/Uhrzeit-Wert (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist ausdrücklich in timeZone angegeben. |
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 und gibt die Zeitzone an, in der die Serie erweitert wird. Bei Einzelereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses an. | Bearbeitbar |
outOfOfficeProperties |
nested object |
Außer-Haus-Termindaten. Wird verwendet, wenn eventType den Wert outOfOffice hat. |
Bearbeitbar |
outOfOfficeProperties.autoDeclineMode |
string |
Gibt an, ob Besprechungseinladungen abgelehnt werden sollen, die sich überschneidende Außer-Haus-Termine überschneiden. Gültige Werte sind declineNone , was bedeutet, dass keine Besprechungseinladungen abgelehnt werden; declineAllConflictingInvitations bedeutet, dass alle in Konflikt stehenden Besprechungseinladungen, die mit dem Termin in Konflikt stehen, abgelehnt werden; und declineOnlyNewConflictingInvitations , was bedeutet, dass nur neue in Konflikt stehende Besprechungseinladungen, die eintreffen, während der Außer-Haus-Termin vorhanden ist, abgelehnt werden. |
|
outOfOfficeProperties.declineMessage |
string |
Antwortnachricht, die festgelegt werden soll, wenn ein bestehender 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: Dies ist nicht dasselbe wie Eigenschaften für private Termine. Optional. Nicht veränderbar. Die Standardeinstellung ist "False". | |
recurrence[] |
list |
Liste der RRULE-, EXRULE-, RDATE- und EXDATE-Zeilen für einen wiederkehrenden Termin, wie in RFC5545 angegeben. Beachten Sie, dass DTSTART- und DTEND-Zeilen in diesem Feld nicht zulässig sind. Start- und Endzeit eines Ereignisses werden in den Feldern start und end angegeben. Bei einzelnen Terminen oder wiederkehrenden Terminen wird dieses Feld weggelassen. |
Bearbeitbar |
recurringEventId |
string |
Bei einem wiederkehrenden Termin ist dies der id des wiederkehrenden Termins, zu dem diese Instanz gehört. Nicht veränderbar. |
|
reminders |
object |
Informationen zu den Terminerinnerungen für den authentifizierten Nutzer. | |
reminders.overrides[] |
list |
Falls für den Termin keine Standarderinnerungen verwendet werden, werden hier die spezifischen Erinnerungen für den Termin angezeigt. Ist dies nicht der Fall, werden für diesen Termin keine Erinnerungen eingerichtet. Es sind maximal fünf Erinnerungen zum Überschreiben. | Bearbeitbar |
reminders.overrides[].method |
string |
Die von dieser Erinnerung verwendete Methode. Mögliche Werte sind:
Erforderlich beim Hinzufügen einer Erinnerung. |
Bearbeitbar |
reminders.overrides[].minutes |
integer |
Anzahl der Minuten vor Beginn des Ereignisses, in 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 |
Legt fest, 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 anderes Dokument sein, das durch eine URL mit HTTP- oder HTTPS-Schema identifiziert werden kann. Sie ist nur für den Ersteller des Termins sichtbar und kann ihn ändern. | |
source.title |
string |
Titel der Quelle, z. B. der Titel einer Webseite oder der Betreff einer E-Mail. | Bearbeitbar |
source.url |
string |
URL der Quelle, die auf eine Ressource verweist. Das URL-Schema muss HTTP oder HTTPS sein. | Bearbeitbar |
start |
nested object |
Die (inklusive) Startzeit des Ereignisses. Bei wiederkehrenden Terminen ist dies der Beginn des ersten Termins. | |
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 (gemäß RFC3339 formatiert). Ein Zeitzonenversatz ist erforderlich, es sei denn, eine Zeitzone ist ausdrücklich in timeZone 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 und gibt die Zeitzone an, in der die Serie erweitert wird. Bei Einzelereignissen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für Beginn und Ende des Ereignisses an. | Bearbeitbar |
status |
string |
Der Status des Ereignisses. Optional. Mögliche Werte sind:
|
Bearbeitbar |
summary |
string |
Titel der Veranstaltung. | Bearbeitbar |
transparency |
string |
Gibt an, ob durch den Termin Zeit im Kalender blockiert wird. Optional. Mögliche Werte sind:
|
Bearbeitbar |
updated |
datetime |
Zeitpunkt der letzten Änderung des Ereignisses (als RFC3339-Zeitstempel). Schreibgeschützt. | |
visibility |
string |
Sichtbarkeit des Ereignisses. Optional. Mögliche Werte sind:
|
Bearbeitbar |
workingLocationProperties |
nested object |
Ereignisdaten zum Arbeitsort. | Bearbeitbar |
workingLocationProperties.customLocation |
object |
Gibt an, dass der Nutzer von einem benutzerdefinierten Standort aus arbeitet, falls vorhanden. | Bearbeitbar |
workingLocationProperties.customLocation.label |
string |
Ein optionales zusätzliches Label für zusätzliche Informationen. | Bearbeitbar |
workingLocationProperties.homeOffice |
any value |
Gibt an, dass der Nutzer zu Hause arbeitet, falls vorhanden. | Bearbeitbar |
workingLocationProperties.officeLocation |
object |
Falls vorhanden, wird angegeben, dass der Nutzer im Büro arbeitet. | Bearbeitbar |
workingLocationProperties.officeLocation.buildingId |
string |
Eine optionale Gebäude-ID. Sie 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 Etagen-ID. | Bearbeitbar |
workingLocationProperties.officeLocation.floorSectionId |
string |
Eine optionale Etage des Stockwerks. | Bearbeitbar |
workingLocationProperties.officeLocation.label |
string |
Der Büroname, der in den Web- und mobilen Clients von Google Kalender angezeigt wird. Wir empfehlen, in der Ressourcendatenbank der Organisation auf einen Gebäudenamen zu verweisen. | Bearbeitbar |
workingLocationProperties.type |
string |
Typ des Arbeitsorts. Mögliche Werte sind:
Erforderlich beim Hinzufügen von Eigenschaften für den Arbeitsort. |
Bearbeitbar |
Methoden
- delete
- Löscht einen Termin.
- get
- Gibt einen Termin basierend auf seiner Google Kalender-ID zurück. Wenn Sie einen Termin über seine iCalendar-ID abrufen möchten, rufen Sie die events.list-Methode mit dem
iCalUID
-Parameter auf. - import
- Importiert ein Ereignis. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt.
- insert
- Erstellt einen Termin.
- Instanzen
- Gibt Instanzen des angegebenen wiederkehrenden Termins zurück.
- list
- Gibt Termine für den angegebenen Kalender zurück.
- Verschieben
- Verschiebt einen Termin in einen anderen Kalender, d. h. ändert den Organisator des Termins Hinweis: Nur
default
-Ereignisse können verschoben werden.outOfOffice
-,focusTime
- undworkingLocation
-Ereignisse können nicht verschoben werden. - patch
- Aktualisiert einen Termin. Diese Methode unterstützt die Patch-Semantik. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise sollte
get
gefolgt vonupdate
verwendet werden. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, sofern angegeben, überschreiben die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen. - quickAdd
- Erstellt ein Ereignis basierend auf einem einfachen Textstring.
- Aktualisieren
- Aktualisiert einen Termin. Diese Methode unterstützt keine Patchsemantik und aktualisiert immer die gesamte Ereignisressource. Für eine teilweise Aktualisierung führen Sie einen
get
gefolgt von einemupdate
mit ETags aus, um die Atomarität sicherzustellen. - Smartwatch
- Achten Sie auf Änderungen an Ereignisressourcen.