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 Host-App und zum aktuellen Kontext für die serverseitige Callback-Funktion des Add-ons.

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

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

    Die Ereignisobjekte, die beim Auslösen von Startseitentriggern erstellt werden, enthalten nicht alle Felder, die in den anderen Fällen enthalten sind. Felder, die sich auf Widgets und Kontextinformationen beziehen, werden weggelassen.

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

    Wenn ein kontextbezogener Trigger ausgelöst wird, ruft die gehostete Anwendung 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 von Kontext-Triggern erstellt werden, enthalten alle Felder, die in Ereignisobjekten für Startseiten-Trigger enthalten sind, sowie Felder mit Kontextinformationen.

  • Widget-Aktionen: Ereignisobjekte bieten Widget-Interaktivität und verwenden dasselbe Aktionsmodell wie Gmail-Add-ons. Google Workspace-Add-ons verwenden dieselben Widget-Handler-Funktionen, Action-Objekte und Aktionsantworten. In Google Workspace-Add-ons enthalten Aktionsereignisobjekte zusätzliche Informationen, die von einer Callback-Funktion verarbeitet werden können.

    Die aus Widget-Aktionen erstellten Ereignisobjekte enthalten alle Felder, die in Ereignisobjekten mit Kontext-Triggern enthalten sind, sowie Felder mit Widget-Informationen.

  • Auslöser für die Vorschau In Google Docs, Google Sheets und Google 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 der linkPreviewTriggers ausgelöst und ein Ereignisobjekt mit dem Link wird an die Callback-Funktion des Triggers übergeben. Ihr Add-on kann dieses Ereignisobjekt verwenden, um einen Smartchip und eine Karte zu erstellen, die Informationen zum Link in der Hostanwendung enthalten. Sie können auch Widget-Aktionen erstellen, damit Nutzer mit der Vorschaukarte und ihren Inhalten interagieren können.

  • Trigger für Google Chat-Apps In Google Chat wird Ihr Add‑on für Nutzer als Chat-App angezeigt. Nutzer können mit ihm interagieren, indem sie es Gruppenbereichen hinzufügen, Nachrichten senden, Slash-Befehle verwenden und mehr. Wenn Sie interaktive Funktionen erstellen möchten, müssen Sie verschiedene Chat-App-Trigger einrichten und verwenden. Jeder Trigger sendet eine andere Ereignisobjekt-Nutzlast, mit der Sie die einzelnen Interaktionstypen verarbeiten oder darauf reagieren können.

Struktur des Ereignisobjekts

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

Aus Gründen der Abwärtskompatibilität enthalten die Ereignisobjekte von Google Workspace-Add-ons die ursprünglichen Felder, die in Aktionsereignisobjekten von Gmail-Add-ons verwendet werden. Diese Felder befinden sich unter „Original Gmail add-on fields“ und sind nicht Teil von commonEventObject.

Die ursprünglichen Felder für Gmail-Add-ons wurden eingestellt. Verwenden Sie beim Entwickeln oder Migrieren von Google Workspace-Add-ons stattdessen die neuere Ereignisobjektstruktur. Diese Felder werden möglicherweise in einem zukünftigen Update entfernt.

Ereignisobjekt
eventObject.commonEventObject Common fields object
Ein Objekt, das Informationen enthält, die für alle Ereignisobjekte unabhängig von der gehosteten Anwendung gelten.
eventObject.calendar Calendar event object
Nur vorhanden, wenn der aufrufende Host Google Kalender ist. Ein Objekt mit Kalender- und Termininformationen.
eventObject.chat Chat event object
Nur vorhanden, wenn der aufrufende Host 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
Nur vorhanden, wenn der aufrufende 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 Google Sheets-Informationen.
eventObject.slides Slides event object
Nur vorhanden, wenn der aufrufende Host Google Präsentationen ist. Ein Objekt mit Informationen zu Präsentationen.
Ursprüngliche Felder des Gmail-Add-ons
eventObject.messageMetadata.accessToken string
Verworfen. Ein Zugriffstoken Damit können Sie den Zugriff auf Nutzerdaten mithilfe temporärer Gmail-Add-on-Bereiche aktivieren.

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

eventObject.messageMetadata.messageId string
Verworfen. 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
Verworfen. Gibt an, woher das Ereignis stammt (Web, iOS oder Android).

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

eventObject.formInput object
Verworfen. 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 den Widgets zugeordnet sind, und die Werte sind Strings. Das Ereignisobjekt stellt formInput bereit, wenn Sie Daten aus mehreren Widgets mit erwarteten Einzelwerten wie Texteingaben und Schaltern lesen müssen. Bei Widgets mit mehreren Werten, z. B. Kästchen, lesen Sie stattdessen jeden Wert aus formInputs.

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
Verworfen. Eine Zuordnung der aktuellen Werte von Widgets auf der Karte, dargestellt als Listen von Strings. 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 einzelnen Element dargestellt. Bei mehrwertigen Widgets wie Gruppen von Kästchen werden alle Werte in einer Liste dargestellt.

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

eventObject.parameters object
Verworfen. Eine Zuordnung aller zusätzlichen Parameter, die Sie mit Action.setParameters an Action übergeben. Die Zuordnungsschlüssel und -werte sind Strings.

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

eventObject.userCountry string
Verworfen und standardmäßig deaktiviert. Der aus zwei Buchstaben bestehende Code für das Land oder die Region des Nutzers. 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
Verworfen und standardmäßig deaktiviert. Der zweistellige ISO 639-Code, der die Sprache des Nutzers angibt. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.

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

eventObject.userTimezone.id string
Verworfen und standardmäßig deaktiviert. Die Zeitzonenkennung der Zeitzone des Nutzers. Beispiele: America/New_York, Europe/Vienna und Asia/Seoul. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.

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

eventObject.userTimezone.offset string
Verworfen und standardmäßig deaktiviert. Der zeitliche Versatz gegenüber der koordinierten Weltzeit (UTC) der Zeitzone des Nutzers, gemessen in Millisekunden. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.

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

CommonEvent-Objekt

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

Zusätzlich zu Startseiten- und Kontext-Triggern erstellen und übergeben Add-ons Ereignisobjekte an Aktions-Callback-Funktionen, wenn der Nutzer mit Widgets interagiert. Die Callback-Funktion Ihres Add-ons kann das allgemeine 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.

Felder für allgemeine Ereignisobjekte
commonEventObject.platform string
Gibt an, woher das Ereignis stammt (`WEB`, `IOS` oder `ANDROID`).
commonEventObject.formInputs object
Eine Zuordnung 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 der ID employeeName können Sie mit e.commonEventObject.formInputs.employeeName.stringInputs.value[0] auf den Texteingabewert zugreifen.

  • Widgets mit mehreren Werten (z. B. Gruppen von Kästchen): eine Liste von Strings.

    Beispiel: Für ein Widget mit mehreren Werten und der ID participants greifen Sie mit e.commonEventObject.formInputs.participants.stringInputs.value auf das Wertarray zu.

  • A date-time picker: ein DateTimeInput object.

    Beispiel: Für eine Auswahl mit der ID myDTPicker greifen Sie mit e.commonEventObject.formInputs.myDTPicker.dateTimeInput auf das Objekt DateTimeInput zu.

  • A date-only picker: ein DateInput object.

    Beispiel: Für eine Auswahl mit der ID myDatePicker greifen Sie mit e.commonEventObject.formInputs.myDatePicker.dateInput auf das Objekt DateInput zu.

  • A time-only picker: ein TimeInput object.

    Beispiel: Für eine Auswahl mit der ID myTimePicker greifen Sie mit e.commonEventObject.formInputs.myTimePicker.timeInput auf das Objekt TimeInput zu.
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 Google Chat-Apps können Sie den Wert des Schlüssels "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]) verwenden, um Elemente basierend auf den Eingaben der Nutzer in Menüs mit Mehrfachauswahl vorzuschlagen. Sie können diesen Wert verwenden, um eine Datenbank abzufragen und Nutzern während der Eingabe auswählbare Elemente vorzuschlagen. Weitere Informationen finden Sie unter Informationen von Google Chat-Nutzern erfassen und verarbeiten.
commonEventObject.userLocale string
Standardmäßig deaktiviert. Die Kennung für die Sprache und das Land bzw. die Region 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 im Manifest Ihres Add-ons addOns.common.useLocaleFromApp auf true setzen. Die Bereichsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf Sprache und 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 im Manifest Ihres Add-ons addOns.common.useLocaleFromApp auf true festlegen. Die Bereichsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.
commonEventObject.timeZone.id string
Die Zeitzonenkennung der Zeitzone des Nutzers. Beispiele: America/New_York, Europe/Vienna und Asia/Seoul. Wenn Sie dieses Feld aktivieren möchten, müssen Sie im Manifest Ihres Add-ons addOns.common.useLocaleFromApp auf true festlegen. Die Bereichsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.
commonEventObject.timeZone.offset string
Der zeitliche Versatz gegenüber der koordinierten Weltzeit (UTC) der Zeitzone des Nutzers, gemessen in Millisekunden. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.

Formulareingaben für die Auswahl von Datum und Uhrzeit

Aktions-Callback-Funktionen können aktuelle Widget-Werte im Feld commonEventObject.formInputs empfangen. Dazu gehören die vom Nutzer ausgewählten Datums- oder Uhrzeitwerte in Widgets zur Datums- oder Uhrzeitauswahl. Die Informationsstruktur unterscheidet sich je nachdem, ob das Widget als Datum/Uhrzeit-Auswahl, Nur-Datum-Auswahl oder Nur-Uhrzeit-Auswahl konfiguriert wurde. Die strukturellen Unterschiede werden in der folgenden Tabelle beschrieben:

DateTimeInput-Objekt
dateTimeInput.hasDate boolean
true, wenn der Eingabe-Datetime-Wert ein Datum enthält; wenn false, ist nur eine Uhrzeit enthalten.
dateTimeInput.hasTime boolean
true, wenn der Eingabe-Datetime-Wert eine Uhrzeit enthält; wenn false, ist nur ein Datum enthalten.
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 Stunde.
timeInput.minutes number
Die vom Nutzer ausgewählte Minute.

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-Bereich, in dem ein Nutzer mit der Chat-App interagiert hat.
chat.eventTime

string (Timestamp format)

Der Zeitpunkt, zu dem die Interaktion stattgefunden hat.

Union-Feld payload. Bei einem App Home-Trigger (wenn ein Nutzer den Tab Startseite öffnet) ist payload nicht festgelegt und chat enthält chat.user und chat.eventTime.

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

object (MessagePayload)

Die Nutzlast, die Chat-Apps von einem Nachrichtentrigger erhalten.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Die Nutzlast, die Chat-Apps von einem Zu Gruppenbereich hinzugefügt-Trigger erhalten.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Die Nutzlast, die Chat-Apps von einem Aus Gruppenbereich entfernt-Trigger erhalten.
chat.buttonClickedPayload

object (ButtonClickedPayload)

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

object (WidgetUpdatedPayload)

Die Nutzlast, die Chat-Apps erhalten, 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 füllen. Wenn Sie beispielsweise Supportanfragen aus einer externen Datenquelle abrufen möchten, kann eine Chat-App die Datenquelle anhand der Eingaben des Nutzers im Menü abfragen und dann übereinstimmende 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 erhalten, wenn ein Nutzer einen Befehl der Chat-App verwendet.

Nutzlast

Je nach Art der Interaktion mit der Chat-App 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, die die Chat-App aufgerufen hat.
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.
In Gruppenbereich aufgenommen – Nutzlast
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Der Chat-Bereich, 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 wird die Chat-App mit @ erwähnt oder ein Befehl verwendet. Wenn true, sendet Google 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 Gruppenbereich entfernt
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Der Chatbereich, 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 Chatbereich, in dem der Nutzer auf eine Schaltfläche in einer Chat-App-Nachricht 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 den Wert true hat, der Interaktionstyp in einem Dialog.

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. Beispielsweise verwenden sie einen Befehl oder klicken auf eine Schaltfläche in einer Nachricht.
SUBMIT_DIALOG Ein Nutzer klickt auf ein interaktives Element in einem Dialogfeld. Beispiel: Ein Nutzer gibt Informationen in ein 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 des App-Befehls
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadaten darüber, welchen Befehl der Nutzer verwendet und wie er ihn 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 mit dem Slash-Befehl.
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 der Befehl ein Dialogfeld öffnet.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Die Art der Interaktion 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. Beispielsweise verwenden sie einen Befehl oder klicken auf eine Schaltfläche in einer Nachricht.
SUBMIT_DIALOG Ein Nutzer klickt auf ein interaktives Element in einem Dialogfeld. Beispiel: Ein Nutzer gibt Informationen in ein 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 Chat-Menü im Antwortbereich der Nachricht aus.

Kalenderterminobjekt

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

In der folgenden Tabelle sind die Felder im Feld calendarEventObject eines Ereignisobjekts aufgeführt. 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 im Manifest auf READ oder READ_WRITE setzt.

Viele Felder in diesem Objekt und seinen Unterstrukturen entsprechen direkt den gleichnamigen Feldern der Calendar API-Ereignisressource. Wenn die Feldbeschreibungen voneinander abweichen, sind die Informationen in der folgenden Tabelle korrekt.

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 generierte Daten. Ein Objekt, das die Funktionen des Add-ons zum Aufrufen oder Aktualisieren von Termininformationen beschreibt.
calendar.capabilities.canAddAttendees boolean
Von Nutzern generierte Daten. true, wenn das Add-on der Teilnehmerliste des Termins neue Teilnehmer hinzufügen kann; andernfalls false.
calendar.capabilities.canSeeAttendees boolean
Von Nutzern generierte Daten. true, wenn das Add-on die Teilnehmerliste des Termins lesen kann, andernfalls false.
calendar.capabilities.canSeeConferenceData boolean
Von Nutzern generierte Daten. true, wenn das Add-on die Konferenzdaten des Termins lesen kann; andernfalls false.
calendar.capabilities.canSetConferenceData boolean
Von Nutzern generierte Daten. true, wenn das Add-on die Konferenzdaten des Termins aktualisieren kann; andernfalls false.
calendar.capabilities.canAddAttachments boolean
Von Nutzern generierte Daten. true, wenn das Add-on dem Termin neue Anhänge hinzufügen kann; andernfalls false.
calendar.conferenceData Conference data object
Von Nutzern erstellte Daten. Ein Objekt, das alle mit diesem Termin verknüpften Konferenzdaten darstellt, z. B. Details zu Google Meet-Konferenzen.
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 Organisators des Termins.
calendar.recurringEventId string
Die ID eines wiederkehrenden Termins.

Teilnehmer

Attendee-Objekte 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 setzt.

Attendee-Objekt
attendee.additionalGuests number
Die Anzahl der zusätzlichen Gäste, die der Teilnehmer angegeben hat. 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 ein 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 Termineinladung angenommen.
  • declined: Der Teilnehmer hat die Termineinladung abgelehnt.
  • needsAction: Der Teilnehmer hat nicht auf die Termineinladung geantwortet.
  • tentative: Der Teilnehmer hat die Termineinladung 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. Das können Google-Konferenzlösungen wie Google Meet oder Konferenzen von Drittanbietern sein. 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 setzt.

Konferenzdatenobjekt
conferenceData.conferenceId string
Die ID der Konferenz. Diese ID soll es Anwendungen ermöglichen, Konferenzen im Blick zu behalten. Sie sollte Nutzern nicht angezeigt werden.
conferenceData.conferenceSolution object
Ein Objekt, das die Konferenzlösung darstellt, z. B. Hangouts oder Google Meet.
conferenceData.conferenceSolution.iconUri string
Der URI für das für Nutzer sichtbare Symbol, das diese Konferenzlösung darstellt.
conferenceData.conferenceSolution.key object
Der Schlüssel, der die Konferenzlösung für diesen Termin eindeutig identifiziert.
conferenceData.conferenceSolution.key.type string
Der Typ der Konferenzlösung. 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 Einstiegspunkte für die Konferenz, z. B. URLs oder Telefonnummern.
conferenceData.notes string
Zusätzliche Hinweise zur Konferenz, 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.
conferenceData.parameters object
Ein Objekt, das eine Zuordnung definierter Parameterdaten zur Verwendung durch das Add-on enthält.
conferenceData.parameters.addOnParameters object
Eine Zuordnung von Stringschlüsseln und -werten für Parameter. Diese Schlüssel und Werte werden vom Add-on-Entwickler definiert, um Informationen an eine bestimmte Konferenz anzuhängen, die vom Add-on verwendet werden sollen.

Einstiegspunkt

Einstiegspunktobjekte enthalten Informationen zu den festgelegten Möglichkeiten für den Zugriff auf 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 Manifestfeld addOns.calendar.currentEventAccess auf READ oder READ_WRITE setzt.

Einstiegspunktobjekt
entryPoint.accessCode string
Der Zugriffscode, der für den Zugriff auf die Konferenz 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 Zugriff auf Konferenzen zu gewähren. Zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.entryPointFeatures list
Features 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 Anweisungen für die Teilnahme an der Konferenz, z. B. alternative Telefonnummern. Eine Videokonferenz kann nur einen more-Einstiegspunkt haben. Wenn ein solcher vorhanden ist, ist auch mindestens ein anderer Einstiegspunkttyp erforderlich.
  • phone: Über eine Telefonnummer an der Konferenz teilnehmen. Eine Konferenz kann keinen, einen oder mehrere phone-Einstiegspunkte haben. In Google Kalender werden nur die ersten beiden Telefoneinstiegspunkte angezeigt, nachdem sie formatiert und alphabetisch sortiert wurden.
  • sip: Nehmen Sie über SIP an der Konferenz teil. Eine Konferenz kann höchstens einen sip-Einstiegspunkt haben.
  • video: Nehmen Sie über HTTP an der Konferenz teil. Eine Konferenz kann höchstens einen video-Einstiegspunkt haben.
entryPoint.label string
Das für den Nutzer sichtbare Label für den Einstiegspunkt-URI (nicht lokalisiert).
entryPoint.meetingCode string
Der Besprechungscode, der für den Zugriff auf die Konferenz 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 Zugriff auf Konferenzen zu gewähren. Zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.passcode string
Der Sicherheitscode für den Zugriff auf 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 Zugriff auf Konferenzen zu gewähren. Zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.password string
Das Passwort für den Zugriff auf 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 Zugriff auf Konferenzen zu gewähren. Zeigen Sie nur die Felder an, die der Konferenzanbieter verwendet.
entryPoint.pin string
Die PIN, die für den Zugriff auf die Konferenz 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 Zugriff auf Konferenzen zu gewähren. 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ählsequenz 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 Inhalten 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, z. B. 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. Es ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Gmail ist.

Gmail-Ereignisobjekt
gmail.accessToken string
Das Gmail-spezifische Zugriffstoken. Verwenden Sie dieses Token mit der Methode GmailApp.setCurrentMessageAccessToken, um Ihrem Add-on vorübergehend Zugriff auf die aktuell geöffnete Gmail-Nachricht eines Nutzers zu gewähren oder um Ihrem Add-on das Erstellen neuer Entwürfe zu ermöglichen.
gmail.bccRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der E‑Mail-Adressen von „Bcc“-Empfängern, die derzeit in einem Entwurf enthalten sind, den das Add‑on erstellt. Wenn Sie dieses Feld aktivieren möchten, setzen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA.
gmail.ccRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der „Cc:“-Empfänger-E-Mail-Adressen, die derzeit in einem Entwurf enthalten sind, den das Add-on erstellt. Wenn Sie dieses Feld aktivieren möchten, setzen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA.
gmail.messageId string
Die ID der aktuell geöffneten Gmail-Nachricht.
gmail.threadId string
Die ID des aktuell geöffneten Gmail-Threads.
gmail.toRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der E‑Mail-Adressen der Empfänger im Feld „An“, die derzeit in einem Entwurf enthalten sind, den das Add-on erstellt. Wenn Sie dieses Feld aktivieren möchten, setzen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA.

Ereignisobjekt für Google Docs

Das Docs-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 Docs erweitert.

Ereignisobjekt für Google Docs
docs.id string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde.
Die ID des Dokuments, das in der Docs-Benutzeroberfläche geöffnet ist.
docs.title string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde.
Der Titel des Dokuments, das in der Docs-Benutzeroberfläche geöffnet ist.
docs.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Bereichsautorisierung 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 Trigger LinkPreviewTriggers angegebenen Hostmuster.

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

Beispielnutzlast für die Vorschau des Links https://www.example.com/12345 durch einen Nutzer: 

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

Ereignisobjekt für Google Sheets

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.

Ereignisobjekt für Google Sheets
sheets.id string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde. Die ID der Tabelle, die in der Google Sheets-Benutzeroberfläche geöffnet ist.
sheets.title string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde. Der Titel der Tabelle, die in der Google Sheets-Benutzeroberfläche geöffnet ist.
sheets.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Bereichsautorisierung https://www.googleapis.com/auth/drive.file für die in der Google 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 Trigger LinkPreviewTriggers angegebenen Hostmuster.

Die URL des Links, der eine Vorschau in Google Sheets generiert. Wenn Sie dieses Feld verwenden möchten, konfigurieren Sie LinkPreviewTriggers im Manifest Ihres Add-ons. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

Beispielnutzlast für die Vorschau des Links https://www.example.com/12345 durch einen Nutzer:

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

Ereignisobjekt für Google Präsentationen

Das Präsentationen-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 Präsentationen erweitert.

Ereignisobjekt für Google Präsentationen
slides.id string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde. Die ID der Präsentation, die in der Google Präsentationen-Benutzeroberfläche geöffnet ist.
slides.title string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde. 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 Bereich https://www.googleapis.com/auth/drive.file 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 Trigger LinkPreviewTriggers angegebenen Hostmuster.

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

Beispielnutzlast für die Vorschau des Links https://www.example.com/12345 durch einen Nutzer:

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