Ereignisobjekte

Auf dieser Seite wird die Struktur von Ereignisobjekten für Google Workspace-Add-ons beschrieben.

Ereignisobjekte sind JSON-Strukturen, die automatisch erstellt und als Parameter an Trigger- oder Callback-Funktionen übergeben werden, wenn ein Nutzer mit einem Add-on interagiert. Ereignisobjekte enthalten clientseitige Informationen zur Hostanwendung und zum aktuellen Kontext für die serverseitige Callback-Funktion des Add-ons.

Google Workspace-Add-ons verwenden Ereignisobjekte an folgenden Stellen:

  • Startseitentrigger: Jeder homepageTrigger-Funktion, die Sie definieren, wird automatisch ein Ereignisobjekt übergeben, wenn die Homepage-Triggerfunktion ausgelöst wird. Sie können dieses Objekt in Ihrer Homepage-Triggerfunktion verwenden, um die aktive Host-App, die Plattform des Clients, das Gebietsschema des Nutzers und andere Informationen zu ermitteln.

    Die Ereignisobjekte, die beim Auslösen von Startseiten-Triggern erstellt werden, enthalten nicht alle Felder der anderen beiden Fälle. Felder für Widgets und Kontextinformationen werden ausgelassen.

  • Kontextbezogene Trigger: Jede Hostanwendung bietet eine andere Reihe von Kontext-Triggern, die ausgelöst werden, wenn der Nutzer einen bestimmten Kontext aufruft. Beispiel:

    Wenn ein kontextbezogener Trigger ausgelöst wird, ruft die Hostanwendung die entsprechende runFunction auf, die im Add-on-Manifest aufgeführt ist, und übergibt ihr ein Ereignisobjekt als Parameter. Die Ereignisobjekte, die beim Auslösen kontextbezogener Trigger erstellt werden, enthalten alle Felder, die in Ereignisobjekten für Homepage-Trigger enthalten sind, sowie Felder mit Kontextinformationen.

  • Widget-Aktionen: Ereignisobjekte werden auch verwendet, um Widgets interaktiv zu gestalten. Dabei wird dasselbe Aktionsmodell wie bei Gmail-Add-ons verwendet. Google Workspace-Add-ons verwenden dieselben Widget-Handler-Funktionen, Action-Objekte und Aktionsantworten. In Google Workspace-Add-ons enthalten die Aktionsereignisobjekte jedoch noch mehr Informationen, auf die eine Callback-Funktion reagieren kann.

    Die Ereignisobjekte, die als Ergebnis von Widget-Aktionen erstellt werden, enthalten alle Felder, die in kontextbezogenen Trigger-Ereignisobjekten enthalten sind, sowie Felder mit Widget-Informationen.

  • Vorschaulink-Trigger: In Google Docs, Sheets und Präsentationen können Sie Linkvorschauen für Drittanbieterdienste basierend auf bestimmten URL-Mustern konfigurieren. Wenn Nutzer mit einem Link interagieren, der dem Muster entspricht, wird linkPreviewTriggers ausgelöst und ein Ereignisobjekt, das den Link enthält, wird an die Callback-Funktion des Triggers übergeben. Ihr Add-on kann dieses Ereignisobjekt verwenden, um einen Smart-Chip und eine Karte zu erstellen, auf denen Informationen zum Link in der Hostanwendung angezeigt werden. Sie können auch Widget-Aktionen erstellen, damit Nutzer mit der Vorschaukarte und ihren Inhalten interagieren können.

  • Google Chat App-Trigger In Google Chat wird Ihr Add‑on für Nutzer als Chat-App angezeigt. Nutzer können damit interagieren, indem sie es Gruppenbereichen hinzufügen, Nachrichten senden, Slash-Befehle verwenden usw. Um interaktive Funktionen zu erstellen, richten Sie verschiedene Chat-App-Trigger ein und verwenden sie. Jeder Trigger sendet eine andere Nutzlast des Ereignisobjekts, mit der Sie jede Art von Interaktion verarbeiten oder darauf reagieren können.

Struktur von Ereignisobjekten

In der folgenden Tabelle wird die Struktur der Google Workspace-Add-ons-Ereignisobjekte auf oberster Ebene beschrieben. Die Struktur des Ereignisobjekts enthält ein commonEventObject-Feld der obersten Ebene für hostunabhängige Informationen. Jedes Ereignisobjekt kann auch eines der folgenden hostspezifischen Felder der obersten Ebene haben, die von der aktiven Host-App bestimmt werden: gmailEventObject, calendarEventObject oder driveEventObject.

Zur Abwärtskompatibilität enthalten Google Workspace-Add-ons-Ereignisobjekte auch alle ursprünglichen Felder, die in Gmail-Add-ons-Aktionsereignisobjekten verwendet werden. Diese Felder sind in der Tabelle unten unter „Originalfelder für Gmail-Add-on“ aufgeführt. Die Informationen in diesen Feldern werden in der neuen Objektstruktur wiedergegeben.

Ereignisobjekt
eventObject.commonEventObject Common fields object
Ein Objekt mit Informationen, die für alle Ereignisobjekte unabhängig von der Hostanwendung gelten.
eventObject.calendar Calendar event object
Wird nur angezeigt, wenn der aufrufende Host Google Kalender ist. Ein Objekt mit Kalender- und Termininformationen.
eventObject.chat Chat event object
Nur vorhanden, wenn der Anruforganisator Google Chat ist. Ein Objekt mit Chat-Informationen.
eventObject.drive Drive event object
Nur vorhanden, wenn der aufrufende Host Google Drive ist. Ein Objekt mit Drive-Informationen.
eventObject.gmail Gmail event object
Wird nur angezeigt, wenn der Anrufer-Host Gmail ist. Ein Objekt mit Gmail-Informationen.
eventObject.docs Docs event object
Nur vorhanden, wenn der aufrufende Host Google Docs ist. Ein Objekt mit Informationen zu Google Docs.
eventObject.sheets Sheets event object
Nur vorhanden, wenn der aufrufende Host Google Sheets ist. Ein Objekt mit Informationen zu Google Tabellen.
eventObject.slides Slides event object
Nur vorhanden, wenn der aufrufende Host Google-Präsentationen ist. Ein Objekt mit Informationen zu Google-Präsentationen.
Originalfelder für Gmail-Add-ons
eventObject.messageMetadata.accessToken string
Veraltet. Ein Zugriffstoken Damit können Sie den Zugriff auf Nutzerdaten über temporäre Gmail-Add-on-Bereiche aktivieren.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Veraltet. Die Nachrichten-ID des Threads, der in der Gmail-Benutzeroberfläche geöffnet ist.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.gmail.messageId.

eventObject.clientPlatform string
Veraltet. Gibt an, wo das Ereignis stammt (Web, iOS oder Android).

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.commonEventObject.platform.

eventObject.formInput object
Veraltet. Eine Zuordnung der aktuellen Werte aller Formular-Widgets auf der Karte, beschränkt auf einen Wert pro Widget. Die Schlüssel sind die String-IDs, die mit den Widgets verknüpft sind, und die Werte sind Strings. Das Ereignisobjekt stellt formInput als praktische Funktion bereit, wenn Sie Daten aus mehreren Widgets mit erwarteten Einzelwerten lesen müssen, z. B. Texteingaben und Schalter. Bei Widgets mit mehreren Werten wie Checkboxen können Sie stattdessen jeden Wert aus formInputs lesen.

Bei Google Workspace-Add-ons finden Sie diese Informationen stattdessen im Feld eventObject.commonEventObject.formInputs. Widgets mit einzelnen Werten werden als Arrays mit einem einzelnen Element dargestellt.

eventObject.formInputs object
Veraltet. Eine Zuordnung der aktuellen Werte von Widgets auf der Karte, dargestellt als Stringlisten. Die Schlüssel sind die String-IDs, die dem Widget zugeordnet sind. Bei Widgets mit einem einzelnen Wert wird der Wert in einem Array mit einem Element dargestellt. Bei Widgets mit mehreren Werten, z. B. Kontrollkästchengruppen, werden alle Werte in einer Liste dargestellt.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.commonEventObject.formInputs.

eventObject.parameters object
Veraltet. Eine Zuordnung aller zusätzlichen Parameter, die Sie für Action mit Action.setParameters() angeben. Die Schlüssel und Werte der Zuordnung sind Strings.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.commonEventObject.parameters.

eventObject.userCountry string
Veraltet und standardmäßig deaktiviert. Der aus zwei Buchstaben bestehende Code, der das Land oder die Region des Nutzers angibt. Es kann auch ein numerischer UN M49-Ländercode sein.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Veraltet und standardmäßig deaktiviert. Der aus zwei Buchstaben bestehende ISO 639-Code, der die Sprache des Nutzers angibt. Weitere Informationen finden Sie unter Auf das Gebietsschema und die Zeitzone des Nutzers zugreifen.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Veraltet und standardmäßig deaktiviert. Die Zeitzonen-ID der Zeitzone des Nutzers. Beispiele: America/New_York, Europe/Vienna und Asia/Seoul. Weitere Informationen finden Sie unter Auf Nutzer-Locale und ‑Zeitzone zugreifen.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Veraltet und standardmäßig deaktiviert. Der Zeitversatz gegenüber der koordinierten Weltzeit (UTC) der Zeitzone des Nutzers in Millisekunden. Weitere Informationen finden Sie unter Auf Nutzer-Locale und ‑Zeitzone zugreifen.

Bei Google Workspace-Add‑ons finden Sie diese Informationen im Feld eventObject.commonEventObject.timeZone.offset.

Häufiges Ereignisobjekt

Das allgemeine Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der allgemeine, hostunabhängige Informationen vom Client des Nutzers an das Add-on überträgt. Dazu gehören Details wie das Gebietsschema, die Host-App und die Plattform des Nutzers.

Zusätzlich zu Startseiten- und Kontext-Triggern erstellen Add-ons Ereignisobjekte und übergeben sie an Aktions-Callback-Funktionen, wenn der Nutzer mit Widgets interagiert. Die Callback-Funktion Ihres Add-ons kann das gemeinsame Ereignisobjekt abfragen, um den Inhalt offener Widgets im Client des Nutzers zu ermitteln. Ihr Add-on kann beispielsweise den Text, den ein Nutzer in ein TextInput-Widget eingegeben hat, im eventObject.commentEventObject.formInputs-Objekt finden.

Häufige Felder für Ereignisobjekte
commonEventObject.platform string
Gibt an, woher das Ereignis stammt (`WEB`, `IOS` oder `ANDROID`).
commonEventObject.formInputs object
Eine Karte mit den aktuellen Werten der Widgets auf der angezeigten Karte. Die Kartenschlüssel sind die String-IDs, die jedem Widget zugewiesen sind.

Die Struktur des Zuordnungswertobjekts hängt vom Widget-Typ ab:

  • Widgets mit einem einzelnen Wert (z. B. ein Textfeld): eine Liste von Strings (nur ein Element).

    Beispiel: Für ein Texteingabe-Widget mit employeeName als ID greifen Sie mit e.commonEventObject.formInputs.employeeName.stringInputs.value[0] auf den Texteingabewert zu.

  • Mehrwertige Widgets (z. B. Checkbox-Gruppen): eine Liste von Strings.

    Beispiel: Für ein Widget mit mehreren Werten und der ID participants können Sie mit e.commonEventObject.formInputs.participants.stringInputs.value auf das Werte-Array zugreifen.

  • A date-time picker: a DateTimeInput object.

    Beispiel: Wenn Sie auf ein Auswahlfeld mit der ID myDTPicker zugreifen möchten, verwenden Sie e.commonEventObject.formInputs.myDTPicker.dateTimeInput, um auf das Objekt DateTimeInput zuzugreifen.

  • A date-only picker: a DateInput object.

    Beispiel: Für eine Auswahl mit der ID myDatePicker können Sie mit e.commonEventObject.formInputs.myDatePicker.dateInput auf das Objekt DateInput zugreifen.

  • A time-only picker: a TimeInput object.

    Beispiel: Für eine Auswahl mit der ID myTimePicker können Sie mit e.commonEventObject.formInputs.myTimePicker.timeInput auf das Objekt TimeInput zugreifen.
commonEventObject.hostApp string
Gibt die Host-App an, in der das Add-on aktiv ist, wenn das Ereignisobjekt generiert wird. Mögliche Werte:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Alle zusätzlichen Parameter, die Sie einer Aktion mit actionParameters oder Action.setParameters() übergeben.

Entwicklervorschau : Bei Add-ons, die Google Chat erweitern>, können Sie mit dem Wert des "autocomplete_widget_query"-Schlüssels (event.commonEventObject.parameters["autocomplete_widget_query"]) Elemente vorschlagen, die auf dem basieren, was die Nutzer in Mehrfachauswahlmenüs eingeben. Sie können diesen Wert verwenden, um eine Datenbank abzufragen und den Nutzern beim Tippen auswählbare Elemente vorzuschlagen. Weitere Informationen finden Sie unter Informationen von Google Chat-Nutzern erheben und verarbeiten.
commonEventObject.userLocale string
Standardmäßig deaktiviert. Die Sprache und die Länder-/Regionskennung des Nutzers im Format ISO 639-Sprachcode–ISO 3166-Länder-/Regionscode. Beispiel: en-US.

Wenn Sie dieses Feld aktivieren möchten, müssen Sie addOns.common.useLocaleFromApp in der Manifestdatei Ihres Add-ons auf true setzen. Die Bereichsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf das Gebietsschema und die Zeitzone des Nutzers zugreifen.

commonEventObject.timeZone string
Standardmäßig deaktiviert. Die Zeitzonen-ID und die Zeitverschiebung. Wenn Sie dieses Feld aktivieren möchten, müssen Sie in Ihrem Add-on-Manifest addOns.common.useLocaleFromApp auf true festlegen. Die Liste der Bereiche Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf das Gebietsschema und die Zeitzone des Nutzers zugreifen.
commonEventObject.timeZone.id string
Die Zeitzonen-ID der Zeitzone des Nutzers. Beispiele: America/New_York, Europe/Vienna und Asia/Seoul. Wenn Sie dieses Feld aktivieren möchten, müssen Sie in Ihrem Add-on-Manifest addOns.common.useLocaleFromApp auf true festlegen. Die Liste der Bereiche Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf Nutzer-Locale und ‑Zeitzone zugreifen.
commonEventObject.timeZone.offset string
Der Zeitversatz gegenüber der koordinierten Weltzeit (UTC) der Zeitzone des Nutzers in Millisekunden. Weitere Informationen finden Sie unter Auf Nutzer-Locale und ‑Zeitzone zugreifen.

Formulareingaben für die Datums-/Uhrzeitauswahl

Aktions-Callback-Funktionen können aktuelle Widget-Werte im Feld commonEventObject.formInputs empfangen. Dazu gehören die vom Nutzer ausgewählten Datums- oder Zeitwerte in Widgets für die Datums- oder Zeitauswahl. Die Struktur der Informationen hängt jedoch davon ab, ob das Widget als Datum/Uhrzeit-Auswahl, nur als Datumsauswahl oder nur als Uhrzeitauswahl konfiguriert wurde. Die strukturellen Unterschiede werden in der folgenden Tabelle beschrieben:

DateTimeInput-Objekt
dateTimeInput.hasDate boolean
true, wenn das Eingabedatum und die Eingabezeit ein Datum enthalten, andernfalls false, wenn nur eine Zeit enthalten ist.
dateTimeInput.hasTime boolean
true, wenn das Eingabedatum und die Eingabezeit eine Zeit enthalten, andernfalls false, wenn nur ein Datum enthalten ist.
dateTimeInput.msSinceEpoch string
Die vom Nutzer ausgewählte Zeit in Millisekunden seit der Epoche (00:00:00 UTC am 1. Januar 1970).
DateInput-Objekt
dateInput.msSinceEpoch string
Die vom Nutzer ausgewählte Zeit in Millisekunden seit der Epoche (00:00:00 UTC am 1. Januar 1970).
TimeInput-Objekt
timeInput.hours number
Die vom Nutzer ausgewählte Stundenzahl.
timeInput.minutes number
Die vom Nutzer ausgewählte Minutenzahl.

Chat-Ereignisobjekt

Das Chat-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zu den Interaktionen eines Nutzers mit einer Chat-App enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Chat erweitert.

Chat
chat.user object (User)
Der Chat-Nutzer, der mit der Chat-App interagiert hat.
chat.space object (Space)
Der Chat-Gruppenbereich, in dem ein Nutzer mit der Chat-App interagiert hat.
chat.eventTime

string (Timestamp format)

Die Uhrzeit, zu der die Interaktion stattgefunden hat.

Union-Feld payload.

Für payload ist nur einer der folgenden Werte zulässig:
chat.messagePayload

object (MessagePayload)

Die Nutzlast, die Chat-Apps von einem Message-Trigger empfangen.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Die Nutzlast, die Chat-Apps von einem Added to space-Trigger erhalten.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Die Nutzlast, die Chat-Apps über den Trigger Aus Gruppenbereich entfernt erhalten.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Die Nutzlast, die Chat-Apps empfangen, wenn Nutzer in einer Nachricht oder Karte auf eine Schaltfläche klicken. Wenn ein Nutzer auf eine Schaltfläche klickt, um Informationen zu senden, enthält das commonEventObject.formInputs-Objekt die vom Nutzer erhobenen Werte. Weitere Informationen finden Sie unter Informationen von Google Chat-Nutzern erfassen.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Die Nutzlast, die Chat-Apps empfangen, wenn Nutzer Text in das Mehrfachauswahlmenü eines selectionInput-Widgets eingeben. Chat-Apps können dieses Ereignisobjekt verwenden, um vorgeschlagene Elemente aus einer dynamischen Datenquelle zu generieren. Wenn Sie beispielsweise Supportanfragen aus einer externen Datenquelle abrufen möchten, kann eine Chat-App die Datenquelle basierend auf dem, was der Nutzer in das Menü eingibt, abfragen und dann alle übereinstimmenden Supportanfragen als auswählbare Elemente zurückgeben.

Das Objekt CommonEventObject.parameters['autocomplete_widget_query'] enthält den Stringwert, den der Nutzer in das Menü eingibt.

chat.appCommandPayload

object (AppCommandPayload)

Die Nutzlast, die Chat-Apps empfangen, wenn ein Nutzer einen Befehl der Chat-App verwendet.

Nutzlast

Je nach Art der Chat-App-Interaktion enthält das Ereignis eine Nutzlast mit einer oder mehreren Chat API-Ressourcen.

Nachrichtennutzlast
MessagePayload
chat.messagePayload.message object (Message)
Die Chatnachricht, die das Ereignis ausgelöst hat.
chat.messagePayload.space object (Space)
Der Chatbereich, in dem ein Nutzer die Nachricht gesendet hat, mit der die Chat-App aufgerufen wurde.
chat.messagePayload.configCompleteRedirectUri string
Die URL, zu der die Chat-App den Nutzer weiterleiten soll, nachdem er einen Autorisierungs- oder Konfigurationsvorgang außerhalb von Google Chat abgeschlossen hat. Weitere Informationen finden Sie unter Google Workspace-Add‑on mit einem Drittanbieterdienst verbinden.

Der Nutzlast des Gruppenbereichs hinzugefügt
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Der Chatbereich, dem der Nutzer die Chat-App hinzugefügt oder in dem er sie installiert hat.

Wenn Administratoren Chat-Apps installieren, wird das Feld space.adminInstalled auf true gesetzt.

chat.addedToSpacePayload.interactionAdd boolean
Gibt an, ob ein Nutzer die Chat-App einem Gruppenbereich über eine Nachricht hinzufügt. Beispielsweise durch @Erwähnungen der Chat-App oder durch die Verwendung eines Befehls. Wenn true, sendet Chat ein weiteres Ereignisobjekt mit einem messagePayload, das Informationen zur Nachricht enthält.
chat.addedToSpacePayload.configCompleteRedirectUri string
Die URL, zu der die Chat-App den Nutzer weiterleiten soll, nachdem er einen Autorisierungs- oder Konfigurationsvorgang außerhalb von Google Chat abgeschlossen hat. Weitere Informationen finden Sie unter Google Workspace-Add‑on mit einem Drittanbieterdienst verbinden.

Aus der Nutzlast des Gruppenbereichs entfernt
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Der Chat-Gruppenbereich, aus dem der Nutzer die Chat-App entfernt oder deinstalliert hat.

Wenn Administratoren Chat-Apps deinstallieren, wird das Feld space.adminInstalled auf false gesetzt.

Nutzlast für Klick auf Schaltfläche
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Die Chatnachricht, die die Schaltfläche enthält, auf die ein Nutzer geklickt hat.
chat.buttonClickedPayload.space object (Space)
Der Chat-Gruppenbereich, in dem der Nutzer in einer Nachricht einer Chat-App auf eine Schaltfläche geklickt hat.
chat.buttonClickedPayload.isDialogEvent boolean
Gibt an, ob der Nutzer auf die Schaltfläche geklickt hat, um mit einem Dialogfeld zu interagieren.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Wenn isDialogEvent gleich true ist, wird der Typ der Interaktion in einem Dialogfeld angegeben.

Enum DialogEventType.

Für dialogEventType ist nur einer der folgenden Werte zulässig:
TYPE_UNSPECIFIED Standardwert. Nicht angegeben
REQUEST_DIALOG Ein Nutzer fordert einen Dialog an. Sie verwenden beispielsweise einen Befehl oder klicken in einer Nachricht auf eine Schaltfläche.
SUBMIT_DIALOG Ein Nutzer klickt auf ein interaktives Element in einem Dialogfeld. Beispiel: Ein Nutzer gibt Informationen in einem Dialogfeld ein und klickt auf eine Schaltfläche, um die Informationen zu senden.

Nutzlast für aktualisiertes Widget
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Der Chatbereich, in dem die Interaktion stattgefunden hat.

Nutzlast für App-Befehle
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadaten dazu, welchen Befehl der Nutzer verwendet hat und wie er den Befehl ausgelöst hat.
chat.appCommandPayload.space object (Space)
Der Chatbereich, in dem ein Nutzer den Befehl verwendet hat.
chat.appCommandPayload.thread object (Thread)
Wenn die Interaktion in einem Thread stattgefunden hat, der Chat-Thread, in dem der Nutzer den Befehl verwendet hat.
chat.appCommandPayload.message object (Message)
Bei Slash-Befehlen die Nachricht, die den Slash-Befehl enthält.
chat.appCommandPayload.configCompleteRedirectUri string
Wenn für den Befehl eine Autorisierung oder Konfiguration erforderlich ist, eine URL, zu der der Nutzer weitergeleitet wird, nachdem er den Vorgang außerhalb von Google Chat abgeschlossen hat.
chat.appCommandPayload.isDialogEvent boolean
Gibt an, ob mit dem Befehl ein Dialogfeld geöffnet wird.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Der Interaktionstyp mit einem Dialogfeld.

Enum DialogEventType.

Für dialogEventType ist nur einer der folgenden Werte zulässig:
TYPE_UNSPECIFIED Standardwert. Nicht angegeben
REQUEST_DIALOG Ein Nutzer fordert einen Dialog an. Sie verwenden beispielsweise einen Befehl oder klicken in einer Nachricht auf eine Schaltfläche.
SUBMIT_DIALOG Ein Nutzer klickt auf ein interaktives Element in einem Dialogfeld. Beispiel: Ein Nutzer gibt Informationen in einem Dialogfeld ein und klickt auf eine Schaltfläche, um die Informationen zu senden.
Metadaten für App-Befehle
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

Die Befehls-ID.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Der Typ des Befehls.

Enum AppCommandType.

Für AppCommandType ist nur einer der folgenden Werte zulässig:
APP_COMMAND_TYPE_UNSPECIFIED Standardwert. Nicht angegeben
SLASH_COMMAND Ein Nutzer verwendet den Befehl, indem er eine Nachricht sendet, die mit einem Schrägstrich / beginnt.
QUICK_COMMAND Der Nutzer wählt den Befehl im Chatmenü im Antwortbereich der Nachricht aus.

Kalenderterminobjekt

Das Kalenderterminobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Kalender eines Nutzers und zu Kalenderterminen enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Kalender erweitert.

In der folgenden Tabelle sind die Felder aufgeführt, die im Feld calendarEventObject eines Ereignisobjekts vorhanden sind. Felder, die als Von Nutzern generierte Daten gekennzeichnet sind, sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalendertermin vorhanden sind und das Add-on das Feld addOns.calendar.currentEventAccess manifest auf READ oder READ_WRITE festlegt.

Kalenderterminobjekt
calendar.attendees[] list of attendee objects
Von Nutzern erstellte Daten: Eine Liste der Teilnehmer des Kalendertermins.
calendar.calendarId string
Die Kalender-ID.
calendar.capabilities object
Von Nutzern erstellte Daten. Ein Objekt, das die Funktionen des Add-ons zum Aufrufen oder Aktualisieren von Ereignisinformationen beschreibt.
calendar.capabilities.canAddAttendees boolean
Von Nutzern erstellte Daten. true wenn das Add-on der Teilnehmerliste des Termins neue Teilnehmer hinzufügen kann; false andernfalls.
calendar.capabilities.canSeeAttendees boolean
Von Nutzern erstellte Daten. true wenn das Add-on die Liste der Teilnehmer des Termins lesen kann; false andernfalls.
calendar.capabilities.canSeeConferenceData boolean
Von Nutzern erstellte Daten. true wenn das Add-on die Konferenzdaten des Termins lesen kann; false andernfalls.
calendar.capabilities.canSetConferenceData boolean
Von Nutzern erstellte Daten. true wenn das Add-on die Konferenzdaten des Termins aktualisieren kann; false andernfalls.
calendar.capabilities.canAddAttachments boolean
Von Nutzern erstellte Daten. true wenn das Add-on dem Termin neue Anhänge hinzufügen kann; false andernfalls.
calendar.conferenceData Conference data object
Von Nutzern erstellte Daten: Ein Objekt, das alle mit diesem Termin verknüpften Konferenzdaten darstellt, z. B. Google Meet-Konferenzdetails.
calendar.id string
Die Ereignis-ID.
calendar.organizer object
Ein Objekt, das den Organisator der Veranstaltung darstellt.
calendar.organizer.email string
Die E-Mail-Adresse des Veranstaltungs-Organisators.
calendar.recurringEventId string
Die ID eines wiederkehrenden Termins.

Teilnehmer

Teilnehmerobjekte enthalten Informationen zu einzelnen Teilnehmern von Google Kalender-Terminen. Diese Informationen sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalendertermin vorhanden sind und das Add-on das Feld addOns.calendar.currentEventAccess im Manifest auf READ oder READ_WRITE festlegt.

Teilnehmerobjekt
attendee.additionalGuests number
Die Anzahl der zusätzlichen Gäste, die der Teilnehmer mitbringt. Der Standardwert ist null.
attendee.comment string
Der Antwortkommentar des Teilnehmers, falls vorhanden.
attendee.displayName string
Der Anzeigename des Teilnehmers.
attendee.email string
Die E-Mail-Adresse des Teilnehmers.
attendee.optional boolean
true, wenn die Teilnahme für diesen Teilnehmer als optional markiert ist; andernfalls false.
attendee.organizer boolean
true, wenn der Teilnehmer der Organisator dieses Termins ist.
attendee.resource boolean
true, wenn der Teilnehmer eine Ressource wie einen Raum oder ein Gerät darstellt, andernfalls false.
attendee.responseStatus string
Der Antwortstatus des Teilnehmers. Mögliche Werte:
  • accepted: Der Teilnehmer hat die Einladung zur Veranstaltung angenommen.
  • declined: Der Teilnehmer hat die Termineinladung abgelehnt.
  • needsAction: Der Teilnehmer hat nicht auf die Termineinladung reagiert.
  • tentative: Der Teilnehmer hat die Einladung zur Veranstaltung vorläufig angenommen.
attendee.self boolean
true, wenn dieser Teilnehmer den Kalender darstellt, in dem dieser Termin angezeigt wird, andernfalls false.

Konferenzdaten

Konferenzdatenobjekte enthalten Informationen zu Konferenzen, die an Google Kalender-Termine angehängt sind. Dabei kann es sich um Konferenzlösungen von Google wie Google Meet oder um Konferenzen von Drittanbietern handeln. Diese Informationen sind im Ereignisobjekt vorhanden, wenn und nur wenn die Daten im Kalendertermin vorhanden sind und das Add-on das addOns.calendar.currentEventAccess-Feld Manifest auf READ oder READ_WRITE festlegt.

Konferenzdatenobjekt
conferenceData.conferenceId string
Die ID der Konferenz. Mit dieser ID können Anwendungen Konferenzen verfolgen. Sie sollte Nutzern nicht angezeigt werden.
conferenceData.conferenceSolution object
Ein Objekt, das die Konferenzlösung wie Hangouts oder Google Meet darstellt.
conferenceData.conferenceSolution.iconUri string
Der URI für das für Nutzer sichtbare Symbol, das diese Videokonferenzlösung darstellt.
conferenceData.conferenceSolution.key object
Der Schlüssel, der die Videokonferenzlösung für dieses Ereignis eindeutig identifiziert.
conferenceData.conferenceSolution.key.type string
Der Konferenzlösungstyp. Mögliche Werte:
  • eventHangout für Hangouts für Privatnutzer (http://hangouts.google.com).
  • eventNamedHangout für das klassische Hangouts für Google Workspace-Nutzer (http://hangouts.google.com).
  • hangoutsMeet für Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Der für den Nutzer sichtbare Name dieser Konferenzlösung (nicht lokalisiert).
conferenceData.entryPoints[] list of entry point objects
Die Liste der Konferenzeinstiegspunkte, z. B. URLs oder Telefonnummern.
conferenceData.notes string
Zusätzliche Hinweise (z. B. Anweisungen des Domainadministrators oder rechtliche Hinweise) zur Videokonferenz, die dem Nutzer angezeigt werden sollen. Kann HTML enthalten. Die maximale Länge beträgt 2.048 Zeichen.
conferenceData.parameters object
Ein Objekt mit einer Karte der definierten Parameterdaten, die vom Add-on verwendet werden sollen.
conferenceData.parameters.addOnParameters object
Eine Zuordnung von Parameter-Stringschlüsseln und -werten. Diese Schlüssel und Werte werden vom Add-on-Entwickler definiert, um Informationen für die Verwendung des Add-ons an eine bestimmte Videokonferenz anzuhängen.

Einstiegspunkt

Einstiegspunktobjekte enthalten Informationen zu den etablierten Zugriffsmethoden für eine bestimmte Konferenz, z. B. per Telefon oder Video. Diese Informationen sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalendertermin vorhanden sind und das Add-on das Feld addOns.calendar.currentEventAccess manifest auf READ oder READ_WRITE festlegt.

Einstiegspunktobjekt
entryPoint.accessCode string
Der Zugriffscode für die Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur eine Teilmenge von {accessCode, meetingCode, passcode, password, pin}, um den Zugriff auf Konferenzen zu ermöglichen. Stimmen Sie die Felder ab und zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.entryPointFeatures list
Funktionen des Einstiegspunkts. Derzeit gelten diese Funktionen nur für phone-Einstiegspunkte:
  • toll: Der Einstiegspunkt ist ein gebührenpflichtiger Anruf.
  • toll_free: Der Einstiegspunkt ist ein gebührenfreier Anruf.
entryPoint.entryPointType string
Der Typ des Einstiegspunkts. Folgende Werte sind möglich:
  • more: Zusätzliche Anleitungen zum Beitreten von Videokonferenzen, z. B. alternative Telefonnummern. Eine Videokonferenz kann nur einen more-Einstiegspunkt haben. Wenn ein solcher Einstiegspunkt vorhanden ist, ist mindestens ein weiterer Einstiegspunkt erforderlich.
  • phone: Über eine Telefonnummer an der Videokonferenz teilnehmen. Eine Videokonferenz kann null oder mehr phone-Einstiegspunkte haben. In Google Kalender werden nur die ersten beiden Telefonnummern angezeigt, nachdem sie formatiert und alphabetisch sortiert wurden.
  • sip: Über SIP an der Videokonferenz teilnehmen. Eine Videokonferenz kann höchstens einen sip-Einstiegspunkt haben.
  • video: Über HTTP an der Videokonferenz teilnehmen. Eine Videokonferenz kann höchstens einen video-Einstiegspunkt haben.
entryPoint.label string
Das für den Nutzer sichtbare Label für den Einstiegs-URI (nicht lokalisiert).
entryPoint.meetingCode string
Der Besprechungscode für den Zugriff auf die Videokonferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur eine Teilmenge von {accessCode, meetingCode, passcode, password, pin}, um den Zugriff auf Konferenzen zu ermöglichen. Stimmen Sie die Felder ab und zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.passcode string
Der Sicherheitscode für den Zugriff auf die Videokonferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur eine Teilmenge von {accessCode, meetingCode, passcode, password, pin}, um den Zugriff auf Konferenzen zu ermöglichen. Stimmen Sie die Felder ab und zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.password string
Das Passwort für den Zugriff auf die Videokonferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur eine Teilmenge von {accessCode, meetingCode, passcode, password, pin}, um den Zugriff auf Konferenzen zu ermöglichen. Stimmen Sie die Felder ab und zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.pin string
Die PIN, die für den Zugriff auf die Videokonferenz verwendet wird. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur eine Teilmenge von {accessCode, meetingCode, passcode, password, pin}, um den Zugriff auf Konferenzen zu ermöglichen. Stimmen Sie die Felder ab und zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.regionCode string
Regionscode der Telefonnummer. Wird von Nutzern benötigt, wenn der URI keinen Ländercode enthält. Die Werte basieren auf der öffentlichen CLDR-Liste der Regionalcodes.
entryPoint.uri string
Der URI des Einstiegspunkts. Die maximale Länge beträgt 1.300 Zeichen. Die Formatierung hängt vom Typ des Einstiegspunkts ab:
  • more: Ein http:- oder https:-Schema ist erforderlich.
  • phone: Ein tel:-Schema ist erforderlich. Der URI sollte die gesamte Wählabfolge enthalten (z. B. „tel:+12345678900,,,12345678;1234“).
  • sip: Ein sip:- oder sips:-Schema ist erforderlich. Beispiel: „sip:12345678@myprovider.com“.
  • video: Ein http:- oder https:-Schema ist erforderlich.

Drive-Ereignisobjekt

Das Drive-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Google Drive eines Nutzers und dessen Inhalt enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Drive erweitert.

Drive-Ereignisobjekt
drive.activeCursorItem Drive item object
Das derzeit aktive Drive-Element.
drive.selectedItems[] list of Drive item objects
Eine Liste der in Drive ausgewählten Elemente (Dateien oder Ordner).

Drive-Element

Drive-Elementobjekte enthalten Informationen zu bestimmten Drive-Elementen wie Dateien oder Ordnern.

Drive-Elementobjekt
item.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Bereich https://www.googleapis.com/auth/drive.file für dieses Element angefordert und erhalten. Andernfalls ist dieses Feld false.
item.id string
Die ID des ausgewählten Elements.
item.iconUrl string
Die URL des Symbols, das das ausgewählte Element darstellt.
item.mimeType string
Der MIME-Typ des ausgewählten Elements.
item.title string
Der Titel des ausgewählten Elements.

Gmail-Ereignisobjekt

Das Gmail-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zu den Gmail-Nachrichten eines Nutzers enthält. Sie ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Gmail ist.

Gmail-Ereignisobjekt
gmail.accessToken string
Das Gmail-spezifische Zugriffstoken. Sie können dieses Token mit der Methode GmailApp.setCurrentMessageAccessToken(accessToken) verwenden, um Ihrem Add-on temporären Zugriff auf die aktuell geöffnete Gmail-Nachricht eines Nutzers zu gewähren oder Ihrem Add-on zu erlauben, neue Entwürfe zu erstellen.
gmail.bccRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der E‑Mail-Adressen der „BCC:“-Empfänger, die derzeit in einem Entwurf enthalten sind, den das Add-on erstellt. Wenn Sie dieses Feld aktivieren möchten, müssen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA setzen.
gmail.ccRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der E‑Mail-Adressen der „Cc“-Empfänger, die derzeit in einem Entwurf enthalten sind, den das Add-on erstellt. Wenn Sie dieses Feld aktivieren möchten, müssen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA setzen.
gmail.messageId string
Die ID der aktuell geöffneten Gmail-Nachricht.
gmail.threadId string
Die ID des derzeit geöffneten Gmail-E-Mail-Verlaufs.
gmail.toRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der E‑Mail-Adressen der Empfänger in der Zeile „An:“, die derzeit in einem Entwurf enthalten sind, den das Add-on erstellt. Wenn Sie dieses Feld aktivieren möchten, müssen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA setzen.

Docs-Ereignisobjekt

Das Docs-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und dessen Inhalt enthält. Sie ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Docs erweitert.

Docs-Ereignisobjekt
docs.id string
Nur vorhanden, wenn der Nutzer den https://www.googleapis.com/auth/drive.file-Bereich autorisiert hat.
Die ID des in der Docs-Benutzeroberfläche geöffneten Dokuments.
docs.title string
Nur vorhanden, wenn der Nutzer den https://www.googleapis.com/auth/drive.file-Bereich autorisiert hat.
Der Titel des Dokuments, das in der Docs-Benutzeroberfläche geöffnet ist.
docs.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Bereich https://www.googleapis.com/auth/drive.file für das in der Google Docs-Benutzeroberfläche geöffnete Dokument angefordert und erhalten. Andernfalls ist dieses Feld false.
docs.matchedUrl.url string
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:
  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL entspricht dem im LinkPreviewTriggers-Trigger angegebenen Hostmuster.

Die URL des Links, der eine Vorschau in Google Docs generiert. Wenn Sie dieses Feld verwenden möchten, müssen Sie LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen

Beispielnutzlast, wenn ein Nutzer eine Vorschau des Links https://www.example.com/12345 aufruft: 

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Sheets-Ereignisobjekt

Das Sheets-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und dessen Inhalt enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Sheets erweitert.

Sheets-Ereignisobjekt
sheets.id string
Nur vorhanden, wenn der Nutzer den https://www.googleapis.com/auth/drive.file-Bereich autorisiert hat. Die ID der Tabelle, die in der Google Sheets-Benutzeroberfläche geöffnet ist.
sheets.title string
Nur vorhanden, wenn der Nutzer den https://www.googleapis.com/auth/drive.file-Bereich autorisiert hat. Der Titel der Tabelle, die in der Google Sheets-Benutzeroberfläche geöffnet ist.
sheets.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Bereich https://www.googleapis.com/auth/drive.file für die in der Sheets-Benutzeroberfläche geöffnete Tabelle angefordert und erhalten. Andernfalls ist dieses Feld false.
sheets.matchedUrl.url string
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:
  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL entspricht dem im LinkPreviewTriggers-Trigger angegebenen Hostmuster.

Die URL des Links, der eine Vorschau in Google Tabellen generiert. Wenn Sie dieses Feld verwenden möchten, müssen Sie LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen

Beispielnutzlast, wenn ein Nutzer eine Vorschau des Links https://www.example.com/12345 aufruft:

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Google-Präsentationen-Ereignisobjekt

Das Google Präsentationen-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und dessen Inhalt enthält. Sie ist nur in einem Ereignisobjekt vorhanden, wenn das Add‑on Google Präsentationen erweitert.

Google-Präsentationen-Ereignisobjekt
slides.id string
Nur vorhanden, wenn der Nutzer den https://www.googleapis.com/auth/drive.file-Bereich autorisiert hat. Die ID der Präsentation, die in der Google Präsentationen-Benutzeroberfläche geöffnet ist.
slides.title string
Nur vorhanden, wenn der Nutzer den https://www.googleapis.com/auth/drive.file-Bereich autorisiert hat. Der Titel der Präsentation, die in der Google Präsentationen-Benutzeroberfläche geöffnet ist.
slides.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den https://www.googleapis.com/auth/drive.file-Bereich für die in der Google-Präsentationen-Benutzeroberfläche geöffnete Präsentation angefordert und erhalten. Andernfalls ist dieses Feld false.
slides.matchedUrl.url string
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:
  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL entspricht dem im LinkPreviewTriggers-Trigger angegebenen Hostmuster.

Die URL des Links, der eine Vorschau in Google Präsentationen generiert. Wenn Sie dieses Feld verwenden möchten, müssen Sie LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen

Beispielnutzlast, wenn ein Nutzer eine Vorschau des Links https://www.example.com/12345 aufruft:

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}