Ereignisobjekte

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

Ereignisobjekte sind JSON-Strukturen, die automatisch erstellt und übergeben werden. als Parameter zum Auslösen oder Callback-Funktionen, wenn ein Nutzer mit einem Add-on. Ereignisobjekte enthalten clientseitige Informationen über die Host-App und den aktuellen Kontext zur serverseitigen Callback-Funktion des Add-ons hinzuzufügen.

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

• Startseiten-Trigger: Jeder homepageTrigger-Funktion, die Sie definieren, wird automatisch ein Ereignis übergeben. , wenn die Startseiten-Triggerfunktion ausgelöst wird. Sie können dieses Objekt in Ihrer Startseiten-Triggerfunktion, um die aktive Host-App, den Client Plattform, Sprache des Nutzers und andere Informationen.

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

• Kontextbezogene Trigger: Jede Hostanwendung bietet einen anderen Satz von kontextbezogenen Triggern, die wird ausgelöst, wenn der Nutzer in einen bestimmten Kontext eintritt. Beispiel:

  • Gmail bietet einen kontextbezogenen Trigger, wenn ein Nutzer öffnet eine Nachricht und ein anderes, wenn Nutzende verfasst eine Nachricht.
  • Google Kalender bietet einen kontextbezogenen Trigger, wenn ein Nutzer öffnet einen Termin.
  • Google Drive stellt einen kontextbezogenen Trigger bereit, wenn ein Nutzer Drive-Dateien auswählen

  Wenn ein kontextbezogener Trigger ausgelöst wird, ruft die Hostanwendung den Parameter entsprechende runFunction im Add-on-Manifest und übergibt ihr ein Ereignisobjekt als Parameter. Die Ereignisobjekte, die im kontextbezogenen Modus erstellt werden. Trigger enthalten alle Felder im Triggerereignis für die Startseite -Objekte sowie Felder mit Kontextinformationen.

• Widget-Aktionen: Ereignisobjekte werden auch verwendet, um ein Widget mit der gleichen Interaktivität Aktionsmodell, das Gmail-Add-ons verwenden. Google Workspace-Add-ons nutzen dieselben Widget-Handler-Funktionen. Objekte und Aktionen vom Typ Action Antworten. In Google Workspace-Add-ons ist jedoch Aktionsereignisobjekte noch mehr Informationen enthalten, auf die eine Callback-Funktion reagieren kann.

  Die Ereignisobjekte, die als Ergebnis von Widget-Aktionen erstellt wurden, enthalten alle Felder in kontextbezogenen Triggerereignisobjekten sowie Felder mit Widget-Informationen enthält.

• Trigger für Vorschaulinks. In Google Docs, Google Tabellen und Google Präsentationen haben Sie folgende Möglichkeiten: Linkvorschau für Drittanbieterdienste konfigurieren die auf bestimmten URL-Mustern basieren. Wenn Nutzende mit einem Link interagieren, das Muster, die linkPreviewTriggers ausgelöst und ein Ereignisobjekt, das den Link enthält, wird an das Ereignisobjekt Callback-Funktion verwendet werden. Das Add-on kann mit diesem Ereignisobjekt ein Smartchip und Karte, die Informationen zum Link innerhalb des Hosts anzeigt . Sie können auch Widgetaktionen erstellen, damit Nutzende mit die Vorschaukarte und ihren Inhalt.

Ereignisobjektstruktur

In der folgenden Tabelle wird die Top-Level-Struktur Ereignisobjekte für Google Workspace-Add-ons. Das Ereignis Objektstruktur enthält: commonEventObject -Top-Level-Feld für hostunabhängige Informationen. Jedes Ereignisobjekt kann auch eines der folgenden hostspezifischen Felder auf oberster Ebene haben, Aktive Host-App: gmailEventObject, calendarEventObject oder driveEventObject.

Aus Gründen der Abwärtskompatibilität: Google Workspace-Add-ons enthalten auch alle ursprünglichen Felder, die in Aktionsobjekte für Gmail-Add-ons. Diese Felder sind in der Tabelle unten unter „Ursprüngliche Gmail-Add-on-Felder“ aufgeführt. Die Informationen in diesen Feldern werden in der neuen Objektstruktur reproduziert.

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 senden. Dieses enthalten Details wie die Sprache des Nutzers, die Host-App und die Plattform.

Neben den Triggern auf der Startseite und dem Kontext werden Add-ons erstellt und übergeben, Ereignisobjekte für Aktions-Callback-Funktionen wenn Nutzende mit Widgets interagieren. Die Callback-Funktion Ihres Add-ons kann Abfragen Das allgemeine Ereignisobjekt, um den Inhalt von geöffneten Widgets im Feld Client. Ihr Add-on kann beispielsweise den Text finden, den Nutzende in eine TextInput-Widget im eventObject.commentEventObject.formInputs-Objekt.

Eingaben für Datums-/Uhrzeitauswahl

Aktions-Callback-Funktionen kann aktuelle Widget-Werte im Feld commonEventObject.formInputs erhalten. Dazu gehören auch die vom Nutzer in der Datums- oder Uhrzeitauswahl ausgewählten Datums- oder Uhrzeitwerte Widgets. Die Struktur der Informationen hängt jedoch davon ab, Das Widget wurde als Datums-/Uhrzeitauswahl, reine Datums- oder Uhrzeitauswahl konfiguriert Auswahl. Die strukturellen Unterschiede sind in der folgenden Tabelle beschrieben:

Kalenderterminobjekt

Das Kalenderereignisobjekt ist der Teil des gesamten Ereignisobjekts, enthält Informationen über den Kalender und die Kalendertermine eines Nutzers. Es ist nur in einem Ereignisobjekt vorhanden, wenn die Host-Anwendung Google Kalender ist.

In der folgenden Tabelle sind die Felder der Datei calendarEventObject aufgeführt. eines Ereignisobjekts. Felder, die mit Nutzergenerierte Daten gekennzeichnet sind, sind im Terminobjekt vorhanden, wenn und nur wenn die Daten im Kalender vorhanden sind und das Add-on legt seine addOns.calendar.currentEventAccess fest. Manifest in READ oder READ_WRITE.

Teilnehmer

Teilnehmerobjekte übertragen Informationen über einzelne Teilnehmer in Google Kalender Ereignisse. Diese Informationen sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalendertermin vorhanden ist und das Add-on die addOns.calendar.currentEventAccess Manifest in READ oder READ_WRITE.

Konferenzdaten

Konferenzdatenobjekte enthalten Informationen über angehängte Konferenzen. zu Google Kalender-Terminen. Das können Google-Konferenzlösungen sein, z. B. Google Meet oder Konferenzen von Drittanbietern. Diese Informationen sind in der wenn die Daten im Kalendertermin vorhanden sind und addOns.calendar.currentEventAccess legt das Add-on fest. Manifest in READ oder READ_WRITE.

Einstiegspunkt

Einstiegspunktobjekte enthalten Informationen über die etablierten Zugriffsmittel z. B. per Telefon oder Video. Diese Informationen sind in und nur dann, wenn die Daten im Kalendertermin vorhanden sind und legt das Add-on seine addOns.calendar.currentEventAccess fest. Manifest in READ oder READ_WRITE.

Drive-Ereignisobjekt

Das Drive-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, enthält Informationen über das Google Drive-Konto eines Nutzers und dessen Inhalte. Es ist nur in einem Ereignisobjekt vorhanden, wenn die Host-Anwendung Google Drive ist.

Drive-Element

Drive-Elementobjekte enthalten Informationen zu bestimmten Drive-Elementen, z. B. Dateien oder Ordner einplanen können.

Gmail-Ereignisobjekt

Das Gmail-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zu den Gmail-Nachrichten eines Nutzers. Ist nur in einem Ereignisobjekt vorhanden wenn die Host-Anwendung Gmail ist.

Docs-Ereignisobjekt

Das Docs-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen über das Dokument eines Nutzers und seinen Inhalt. Kommt nur in einer -Ereignisobjekt, wenn die Host-Anwendung Google Docs ist.

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

Google Tabellen-Ereignisobjekt

Das Google Sheets-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen über das Dokument eines Nutzers und seinen Inhalt. Kommt nur in einer -Ereignisobjekt, wenn die Host-Anwendung Google Tabellen ist.

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

Google Präsentationen-Ereignisobjekt

Das Präsentationen-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen über das Dokument eines Nutzers und seinen Inhalt. Kommt nur in einer -Ereignisobjekt, wenn die Host-Anwendung Google Präsentationen ist.

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