Die Calendar API bietet verschiedene Arten 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
}
],
"birthdayProperties": {
"contact": string,
"type": string,
"customTypeName": string
},
"eventType": string
}| Property-Name | Wert | Beschreibung | Hinweise |
|---|---|---|---|
anyoneCanAddSelf |
boolean |
Gibt an, ob sich Nutzer selbst zur Veranstaltung einladen können (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 sind maximal 25 Anhänge möglich. |
|
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 in der Erforderlich beim Hinzufügen eines Anhangs. |
Bearbeitbar |
attachments[].iconLink |
string |
URL-Link zum Symbol der Anlage. 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 nicht in der Darstellung des Termins enthalten sind. Beim Abrufen eines Ereignisses kann dies an einer Einschränkung liegen, die durch den Abfrageparameter maxAttendee angegeben wird. Beim Aktualisieren eines Ereignisses kann damit nur die Antwort des Teilnehmers aktualisiert werden. Optional. Die Standardeinstellung ist "False". |
Bearbeitbar |
attendees[] |
list |
Die Teilnehmer der Veranstaltung. Weitere Informationen zum Planen von Terminen mit anderen Kalendernutzern finden Sie im Leitfaden Termine mit Teilnehmern. Dienstkonten müssen die 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 Antwortkommentar 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, sofern verfügbar. Dieses Feld muss beim Hinzufügen eines Teilnehmers angegeben werden. 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 es sich um einen optionalen Teilnehmer handelt. 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 der 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:
|
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". | |
birthdayProperties |
nested object |
Daten zu Geburtstagen oder besonderen Ereignissen. Wird verwendet, wenn eventType "birthday" ist. Nicht veränderbar. |
Bearbeitbar |
birthdayProperties.contact |
string |
Ressourcenname des Kontakts, mit dem dieses Geburtstagsereignis verknüpft ist. Damit können Kontaktdetails aus der People API abgerufen werden. Format: "people/c12345". Schreibgeschützt. |
|
birthdayProperties.customTypeName |
string |
Für dieses Ereignis wurde ein benutzerdefiniertes Typ-Label angegeben. Dieses Feld wird ausgefüllt, wenn birthdayProperties.type auf "custom" gesetzt ist. Schreibgeschützt. |
|
birthdayProperties.type |
string |
Art des Geburtstags oder besonderen Ereignisses. Mögliche Werte:
"birthday" erstellt werden. 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 Farben-Endpunkt). 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 beibehalten 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 Videokonferenzlösung, z. B. Google Meet. Nicht festgelegt für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage. 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, 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 möglich 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 |
Ein Request zum Erstellen einer neuen Videokonferenz und zum Anhängen an den Termin. Die Daten werden asynchron generiert. Prüfen Sie das Feld status, um festzustellen, 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 trotzdem angezeigt werden können. Änderungen sollten jedoch nicht möglich 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 angegebene ID mit der ID der vorherigen Anfrage übereinstimmt, wird die Anfrage ignoriert. |
|
conferenceData.createRequest.status |
nested object |
Der Status der Anfrage zum Erstellen der Videokonferenz. | |
conferenceData.createRequest.status.statusCode |
string |
Der aktuelle Status der Anfrage zum Erstellen einer Videokonferenz. 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 Zugriffscode 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 { 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 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, die dem Nutzer angezeigt werden sollen, 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. Serverseitig generiert. Nicht festgelegt für eine Konferenz mit einer fehlgeschlagenen Erstellungsanfrage. Optional für eine Videokonferenz mit einer ausstehenden Erstellungsanfrage. |
|
created |
datetime |
Erstellungszeit 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, sofern 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 (ausgeschlossene) Endzeit des Ereignisses. Bei einem wiederkehrenden Termin ist dies die Endzeit 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 Zeit als kombinierter Datums- und Zeitwert (gemäß RFC3339 formatiert). Eine Zeitzonenabweichung ist erforderlich, sofern in timeZone keine Zeitzone explizit angegeben ist. |
Bearbeitbar |
end.timeZone |
string |
Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name aus der IANA-Zeitzonendatenbank, z.B. „Europe/Zurich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die Wiederholung erweitert wird. Bei einzelnen Terminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Start/das Ende des Termins 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 |
Die genaue Art des Ereignisses. Dies kann nach dem Erstellen des Ereignisses nicht mehr geändert werden. Mögliche Werte:
|
Bearbeitbar |
extendedProperties |
object |
Erweiterte Eigenschaften des Ereignisses. | |
extendedProperties.private |
object |
Eigenschaften, die nur für die Kopie des Termins gelten, die in diesem Kalender angezeigt wird. | Bearbeitbar |
extendedProperties.private.(key) |
string |
Der Name des privaten Attributs 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 Eigenschaft und der entsprechende Wert. | |
focusTimeProperties |
nested object |
Fokuszeit-Termindaten. Wird verwendet, wenn eventType focusTime ist. |
Bearbeitbar |
focusTimeProperties.autoDeclineMode |
string |
Ob Besprechungseinladungen abgelehnt werden sollen, die sich mit Fokuszeit-Terminen überschneiden. Gültige Werte sind declineNone (keine Besprechungseinladungen werden abgelehnt), declineAllConflictingInvitations (alle Besprechungseinladungen, die sich mit dem Termin überschneiden, werden abgelehnt) und declineOnlyNewConflictingInvitations (nur neue Besprechungseinladungen, die während des Fokuszeit-Termins eingehen und sich mit ihm überschneiden, werden abgelehnt). |
|
focusTimeProperties.chatStatus |
string |
Der Status, mit dem der Nutzer in Chat und zugehörigen 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 sind veraltet. Diese Struktur wird stattdessen nur zum Zurückgeben von Metadaten für 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 |
Gibt an, ob andere Teilnehmer als der Organisator andere zum Termin einladen können. Optional. Der Standardwert ist „True“. | Bearbeitbar |
guestsCanModify |
boolean |
Gibt an, ob andere Teilnehmer 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 Teilnehmer des Termins sind. Optional. Der Standardwert ist „True“. | Bearbeitbar |
hangoutLink |
string |
Ein absoluter Link zum Google Hangout, das mit diesem Termin verknüpft ist. Schreibgeschützt. | |
htmlLink |
string |
Ein absoluter Link zu diesem Termin in der Google Kalender-Web-UI. Schreibgeschützt. | |
iCalUID |
string |
Eindeutige Kennung des Ereignisses gemäß RFC5545. Sie dient zur eindeutigen Identifizierung von Ereignissen in verschiedenen Kalendersystemen und muss beim Importieren von Ereignissen über die Methode import angegeben werden. Beachten Sie, dass |
|
id |
string |
Opake Kennung des Ereignisses. Wenn Sie neue einmalige oder wiederkehrende Ereignisse erstellen, können Sie deren IDs angeben. Die bereitgestellten IDs müssen die folgenden Regeln erfüllen:
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 Ereigniskopie handelt, in der keine Änderungen an den Hauptereignisfeldern „Zusammenfassung“, „Beschreibung“, „Ort“, „Start“, „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 angegeben, wobei das Feld organizer auf „True“ gesetzt ist. Wenn Sie den Organisator ändern möchten, verwenden Sie den Vorgang move. 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 |
Für eine Instanz eines wiederkehrenden Termins ist dies die Uhrzeit, zu der dieser Termin gemäß den Wiederholungsdaten im wiederkehrenden Termin mit der ID „recurringEventId“ beginnen würde. Sie identifiziert die Instanz innerhalb der Reihe wiederkehrender Termine eindeutig, 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 Zeit als kombinierter Datums- und Zeitwert (gemäß RFC3339 formatiert). Eine Zeitzonenabweichung ist erforderlich, sofern in timeZone keine Zeitzone explizit angegeben ist. |
Bearbeitbar |
originalStartTime.timeZone |
string |
Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name aus der IANA-Zeitzonendatenbank, z.B. „Europe/Zurich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die Wiederholung erweitert wird. Bei einzelnen Terminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Start/das Ende des Termins an. | Bearbeitbar |
outOfOfficeProperties |
nested object |
Außer-Haus-Termine Wird verwendet, wenn eventType outOfOffice ist. |
Bearbeitbar |
outOfOfficeProperties.autoDeclineMode |
string |
Ob Besprechungseinladungen, die sich mit Außer-Haus-Terminen überschneiden, abgelehnt werden sollen. 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, die während des Abwesenheitstermins eingehen, abgelehnt werden. |
|
outOfOfficeProperties.declineMessage |
string |
Antwortnachricht, die festgelegt wird, wenn ein vorhandener Termin oder eine neue Einladung automatisch von Google Kalender abgelehnt wird. | |
privateCopy |
boolean |
Wenn auf „True“ gesetzt, wird die Ereignisweitergabe deaktiviert. Das ist nicht dasselbe wie Properties für private Ereignisse. Optional. Nicht veränderbar. Die Standardeinstellung ist "False". | |
recurrence[] |
list |
Liste der RRULE-, EXRULE-, RDATE- und EXDATE-Zeilen für ein wiederkehrendes Ereignis, wie in RFC5545 angegeben. Die Zeilen DTSTART und DTEND sind in diesem Feld nicht zulässig. Start- und Endzeiten von Veranstaltungen werden in den Feldern start und end angegeben. Dieses Feld wird bei einzelnen Terminen oder Instanzen wiederkehrender Termine ausgelassen. |
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 Erinnerungen des Ereignisses für den authentifizierten Nutzer. Wenn Sie Erinnerungen ändern, wird das Attribut updated des umschließenden Ereignisses nicht geändert. |
|
reminders.overrides[] |
list |
Wenn für den Termin nicht die Standarderinnerungen verwendet werden, werden hier die spezifischen Erinnerungen für den Termin aufgeführt. Wenn keine Erinnerungen festgelegt sind, wird angegeben, dass für diesen Termin keine Erinnerungen festgelegt sind. Die maximale Anzahl von Erinnerungen zum Überschreiben beträgt 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 des Termins, 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. Das kann z. B. eine Webseite, eine E‑Mail oder ein beliebiges Dokument sein, das über eine URL mit HTTP- oder HTTPS-Schema identifiziert werden kann. Kann nur vom Ersteller des Events gesehen oder geändert werden. | |
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 einem wiederkehrenden Termin ist dies 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 Zeit als kombinierter Datums- und Zeitwert (gemäß RFC3339 formatiert). Eine Zeitzonenabweichung ist erforderlich, sofern in timeZone keine Zeitzone explizit angegeben ist. |
Bearbeitbar |
start.timeZone |
string |
Die Zeitzone, in der die Zeit angegeben ist. (Formatiert als Name aus der IANA-Zeitzonendatenbank, z.B. „Europe/Zurich“.) Bei wiederkehrenden Terminen ist dieses Feld erforderlich. Es gibt die Zeitzone an, in der die Wiederholung erweitert wird. Bei einzelnen Terminen ist dieses Feld optional und gibt eine benutzerdefinierte Zeitzone für den Start/das Ende des Termins 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). Das Aktualisieren von Terminerinnerungen führt nicht zu einer Änderung. Schreibgeschützt. | |
visibility |
string |
Sichtbarkeit des Ereignisses. Optional. Mögliche Werte:
|
Bearbeitbar |
workingLocationProperties |
nested object |
Arbeitsort-Ereignisdaten. | 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 weitere Informationen. | Bearbeitbar |
workingLocationProperties.homeOffice |
any value |
Falls vorhanden, gibt an, dass der Nutzer von zu Hause aus arbeitet. | Bearbeitbar |
workingLocationProperties.officeLocation |
object |
Falls vorhanden, gibt das Attribut an, dass der Nutzer in einem Büro arbeitet. | Bearbeitbar |
workingLocationProperties.officeLocation.buildingId |
string |
Eine optionale Gebäude-ID. Hier sollte auf eine Gebäude-ID in der Ressourcendatenbank der Organisation verwiesen werden. | Bearbeitbar |
workingLocationProperties.officeLocation.deskId |
string |
Eine optionale Arbeitsplatz-ID. | Bearbeitbar |
workingLocationProperties.officeLocation.floorId |
string |
Eine optionale Etagen-ID. | Bearbeitbar |
workingLocationProperties.officeLocation.floorSectionId |
string |
Eine optionale Kennung für den Etagenabschnitt. | Bearbeitbar |
workingLocationProperties.officeLocation.label |
string |
Der Name des Büros, der in den Web- und Mobilclients von Google Kalender angezeigt wird. Wir empfehlen, auf einen Gebäudenamen in der Ressourcendatenbank der Organisation zu verweisen. | Bearbeitbar |
workingLocationProperties.type |
string |
Typ des Arbeitsorts. Mögliche Werte:
Erforderlich, wenn Sie Eigenschaften für den Arbeitsort hinzufügen. |
Bearbeitbar |
Methoden
- Delete
- Löscht einen Termin.
- get
- Gibt einen Termin basierend auf 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
iCalUIDauf. - import
- Importiert einen Termin. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Ereignisse mit einem
eventTypevondefaultimportiert werden.Eingestelltes Verhalten:Wenn ein Ereignis importiert wird, das nicht
defaultist, wird sein Typ indefaultgeändert und alle ereignistyp-spezifischen Eigenschaften werden entfernt. - insert
- Erstellt einen Termin.
- Instanzen
- Gibt Instanzen des angegebenen wiederkehrenden Termins zurück.
- list
- Gibt Termine im angegebenen Kalender zurück.
- Verschieben
- Verschiebt einen Termin in einen anderen Kalender, d.h. ändert den Organisator eines Termins. Nur
default-Ereignisse können verschoben werden.birthday-,focusTime-,fromGmail-,outOfOffice- undworkingLocation-Ereignisse können nicht verschoben werden. - patch
- Aktualisiert einen Termin. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass für jede Patch-Anfrage drei Kontingenteinheiten verbraucht werden. Verwenden Sie daher lieber ein
getgefolgt von einemupdate. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Array-Felder überschreiben, sofern angegeben, 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 die Patch-Semantik nicht und aktualisiert immer die gesamte Ereignisressource. Für eine partielle Aktualisierung führen Sie einen
getgefolgt von einemupdatemit ETags aus, um die Atomizität zu gewährleisten. - Smartwatch
- Nach Änderungen an Ereignisressourcen suchen.