Ereignisobjekte

Auf dieser Seite wird die Struktur von Ereignisobjekten von 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 übertragen clientseitige Informationen zur Host-App und zum aktuellen Kontext an die serverseitige Rückruffunktion des Add-ons.

In Google Workspace-Add-ons werden Ereignisobjekte an den folgenden Stellen verwendet:

• Startseiten-Trigger: Jede von Ihnen definierte homepageTrigger-Funktion erhält automatisch ein Ereignisobjekt, wenn die Triggerfunktion für die Startseite ausgelöst wird. Sie können dieses Objekt in Ihrer Startseiten-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 Startseitenauslösern erstellt werden, enthalten nicht alle Felder, die in den anderen beiden Fällen enthalten sind. Felder zu Widgets und Kontextinformationen werden weggelassen.

• Kontextbezogene Trigger: Jede Hostanwendung bietet eine andere Reihe von Kontexttriggern, die ausgelöst werden, wenn der Nutzer einen bestimmten Kontext betritt. 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 beim Auslösen von Kontexttriggern erstellt werden, enthalten alle Felder, die in Ereignisobjekten für Startseitentrigger enthalten sind, sowie Felder mit Kontextinformationen.

• Widget-Aktionen: Ereignisobjekte werden auch verwendet, um Widgets interaktiv zu gestalten. Dabei wird dasselbe Aktionsmodell verwendet, das auch in Gmail-Add-ons verwendet wird. 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 durch Widget-Aktionen erstellt werden, enthalten alle Felder, die in Ereignisobjekten für kontextbezogene Trigger enthalten sind, sowie Felder mit Widget-Informationen.

• Auslöser 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 Nutzer mit einem Link interagieren, der dem Muster entspricht, wird das Ereignis linkPreviewTriggers ausgelöst und ein Ereignisobjekt mit dem Link wird an die Rückruffunktion des Trigger übergeben. Ihr Add-on kann dieses Ereignisobjekt verwenden, um einen Smartchip und eine Karte zu erstellen, die Informationen zum Link in der Hostanwendung anzeigen. Sie können auch Widgetaktionen erstellen, damit Nutzende mit die Vorschaukarte und ihren Inhalt.

Ereignisobjektstruktur

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

Aus Gründen der Abwärtskompatibilität enthalten Ereignisobjekte für Google Workspace-Add-ons auch alle ursprünglichen Felder, die in Ereignisobjekten für Gmail-Add-on-Aktionen verwendet wurden. Diese Felder sind in der folgenden Tabelle unter „Originale Gmail-Add-on-Felder“ aufgeführt. Die Informationen in diesen Feldern werden in der neuen Objektstruktur reproduziert.

Gemeinsames Ereignisobjekt

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

Neben Startseiten- und Kontexttriggern erstellen Add-ons Ereignisobjekte und übergeben sie an Aktions-Callback-Funktionen, wenn der Nutzer mit Widgets interagiert. 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 ein Nutzer in ein TextInput-Widget im eventObject.commentEventObject.formInputs-Objekt eingegeben hat.

Eingaben für Datums-/Uhrzeitauswahl

Aktion-Callback-Funktionen können aktuelle Widget-Werte im Feld commonEventObject.formInputs empfangen. 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, der Informationen zum Kalender und zu den Kalenderterminen eines Nutzers enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Kalender ist.

In der folgenden Tabelle sind die Felder der Datei calendarEventObject aufgeführt. eines Ereignisobjekts. Felder, die als Nutzergenerierte Daten gekennzeichnet sind, sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalenderereignis vorhanden sind und das Add-on das Feld addOns.calendar.currentEventAccessmanifest auf READ oder READ_WRITE festlegt.

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 Konferenzlösungen von Google wie Google Meet oder Konferenzen von Drittanbietern sein. Diese Informationen sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalenderereignis vorhanden sind und das Add-on das Feld addOns.calendar.currentEventAccessmanifest auf READ oder READ_WRITE festlegt.

Einstiegspunkt

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

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 Hostanwendung Google Drive ist.

Drive-Element

Drive-Elementobjekte enthalten Informationen zu bestimmten Drive-Elementen, z. B. Dateien oder Ordnern.

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.

Docs-Ereignisobjekt

Das Docs-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und seinem Inhalt enthält. 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. Sie ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung 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"
  }
}