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.
Ereignisobjekt | |
---|---|
eventObject.commonEventObject |
Common fields object
Objekt mit Informationen, die für alle Ereignisobjekte gelten unabhängig von der Host-Anwendung. |
eventObject.calendar |
Calendar event object
Nur vorhanden, wenn der anrufende Organisator Google Kalender ist. Objekt mit Kalender- und Termininformationen. |
eventObject.drive |
Drive event object
Nur vorhanden, wenn der anrufende Organisator Google Drive ist. Objekt mit Drive-Informationen. |
eventObject.gmail |
Gmail event object
Nur vorhanden, wenn Gmail der Gesprächshost ist. Objekt mit Gmail-Informationen. |
eventObject.docs |
Docs event object
Nur vorhanden, wenn der anrufende Organisator Google Docs ist. Objekt mit Informationen aus Google Docs. |
eventObject.sheets |
Sheets event object
Nur vorhanden, wenn der aufrufende Host Google Tabellen ist. Objekt mit Informationen aus Google Tabellen. |
eventObject.slides |
Slides event object
Nur vorhanden, wenn der anrufende Organisator Google Präsentationen ist. Objekt mit Informationen aus Google Präsentationen. |
Ursprüngliche Gmail-Add-on-Felder | |
eventObject.messageMetadata.accessToken |
string Eingestellt. Ein Zugriffstoken Sie können um den Zugriff auf Nutzerdaten mit temporären Gmail-Add-on-Bereichen zu aktivieren.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.messageMetadata.messageId |
string Eingestellt. Die Nachrichten-ID des Threads in der Gmail-Benutzeroberfläche öffnen.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.clientPlatform |
string Eingestellt. Gibt an, wo das Ereignis (Web, iOS oder Android).
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.formInput |
object Eingestellt. Eine Zuordnung der aktuellen Werte aller Formular-Widgets auf der Karte, beschränkt auf einen Wert pro Widget. Die Schlüssel sind die mit den Widgets verknüpften String-IDs und die Werte sind Zeichenfolgen. Das Ereignisobjekt stellt formInput als ein
wenn Sie Daten aus mehreren Widgets mit
erwartete Singularwerte wie Texteingaben und Schalter. Für
mehrwertige Widgets wie Kontrollkästchen, können Sie jeden Wert
Stattdessen formInputs .
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.formInputs |
object Eingestellt. Eine Zuordnung aktueller Werte von Widgets auf der Karte, die als Stringlisten dargestellt werden. Die Schlüssel sind die String-IDs, die mit dem Widget verknüpft sind. Bei einwertigen Widgets wird in einem Array mit einem einzelnen Element dargestellt. Für Widgets mit mehreren Werten wie Kästchengruppen, werden alle Werte in einer Liste angezeigt.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.parameters |
object Eingestellt. Eine Karte mit weiteren Parameter, die Sie für die <ph type="x-smartling-placeholder"></ph> Action verwenden
<ph type="x-smartling-placeholder"></ph>
Action.setParameters() Die Schlüssel und Werte der Zuordnung sind
Zeichenfolgen.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.userCountry |
string Eingestellt und standardmäßig deaktiviert. Die Code aus zwei Buchstaben, der das Land oder die Region des Nutzers angibt. Es kann auch sein, ein numerischer Wert UN M49-Ländercode.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.userLocale |
string Eingestellt und standardmäßig deaktiviert. Die aus zwei Buchstaben ISO 639 -Code, der die Sprache des Nutzers angibt. Weitere Informationen finden Sie unter Zugriff auf Nutzer Sprache und Zeitzone.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.userTimezone.id |
string Eingestellt und standardmäßig deaktiviert. Die <ph type="x-smartling-placeholder"></ph> Zeitzonenkennung der Zeitzone des Nutzers. Beispiele: America/New_York , Europe/Vienna und
Asia/Seoul Weitere Informationen finden Sie unter
<ph type="x-smartling-placeholder"></ph>
Auf Sprache und Zeitzone des Nutzers zugreifen, um weitere Informationen zu erhalten.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.userTimezone.offset |
string Eingestellt und standardmäßig deaktiviert. Die <ph type="x-smartling-placeholder"></ph> Zeitverschiebung gegenüber der koordinierten Weltzeit (UTC) der Einstellung Zeitzone, gemessen in Millisekunden. Weitere Informationen finden Sie unter <ph type="x-smartling-placeholder"></ph> Auf Sprache und Zeitzone des Nutzers zugreifen, um weitere Informationen zu erhalten.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
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.
Allgemeine Ereignisobjektfelder | |
---|---|
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 Zuordnungsschlüssel sind die String-IDs die den einzelnen Widgets zugewiesen sind. Die Struktur des Kartenwertobjekts ist abhängig vom Widget-Typ:
|
commonEventObject.hostApp |
string Gibt die Host-App an, in der das Add-on aktiv ist wenn das Ereignisobjekt generiert wird. Mögliche Werte sind die Folgendes: <ph type="x-smartling-placeholder">
|
commonEventObject.parameters |
object Zusätzliche Parameter, die Sie an
Action mithilfe von
Action.setParameters() .
|
commonEventObject.userLocale |
string Standardmäßig deaktiviert. Sprache des Nutzers und Länder-/Regionskennung im Format ISO 639 Sprachcode: ISO 3166 Länder-/Regionscode. Beispiel: en-US .
Wenn Sie dieses Feld aktivieren möchten, müssen Sie für |
commonEventObject.timeZone |
string Standardmäßig deaktiviert. Die Zeitzonen-ID und Versatz. Zum Aktivieren dieses Felds müssen Sie Folgendes festlegen: addOns.common.useLocaleFromApp im Manifest Ihres Add-ons auf true .
Die Liste der Bereiche Ihres Add-ons muss außerdem
https://www.googleapis.com/auth/script.locale
Weitere Informationen finden Sie unter .
Auf Sprache und Zeitzone des Nutzers zugreifen, um weitere Informationen zu erhalten.
|
commonEventObject.timeZone.id |
string Die <ph type="x-smartling-placeholder"></ph> Zeitzonenkennung der Zeitzone des Nutzers. Beispiele: America/New_York , Europe/Vienna und
Asia/Seoul Zum Aktivieren dieses Felds müssen Sie Folgendes festlegen:
addOns.common.useLocaleFromApp im Manifest Ihres Add-ons auf true .
Die Liste der Bereiche Ihres Add-ons muss außerdem
https://www.googleapis.com/auth/script.locale Weitere Informationen finden Sie unter
<ph type="x-smartling-placeholder"></ph>
Auf Sprache und Zeitzone des Nutzers zugreifen, um weitere Informationen zu erhalten.
|
commonEventObject.timeZone.offset |
string Die <ph type="x-smartling-placeholder"></ph> Zeitverschiebung gegenüber der koordinierten Weltzeit (UTC) der Einstellung Zeitzone, gemessen in Millisekunden. Weitere Informationen finden Sie unter <ph type="x-smartling-placeholder"></ph> Auf Sprache und Zeitzone des Nutzers zugreifen, um weitere Informationen zu erhalten. |
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
.
Kalenderterminobjekt | |
---|---|
calendar.attendees[] |
list of attendee objects Von Nutzern erstellte Daten: Eine Liste der Teilnehmer des Kalenders . |
calendar.calendarId |
string Die Kalender-ID. |
calendar.capabilities |
object Von Nutzern erstellte Daten. Objekt beschreibt die Funktionen des Add-ons zum Ansehen oder Aktualisieren von Ereignissen Informationen. |
calendar.capabilities.canAddAttendees |
boolean Von Nutzern erstellte Daten. true
ob mit dem Add-on neue Teilnehmer zur Teilnehmerliste hinzugefügt werden können;
Andernfalls false . |
calendar.capabilities.canSeeAttendees |
boolean Von Nutzern erstellte Daten. true
ob das Add-on die Teilnehmerliste der Veranstaltung lesen kann; false
sonst. |
calendar.capabilities.canSeeConferenceData |
boolean Von Nutzern erstellte Daten. true
ob das Add-on die Veranstaltungskonferenzdaten lesen kann; false
sonst. |
calendar.capabilities.canSetConferenceData |
boolean Von Nutzern erstellte Daten. true
ob das Add-on die Daten der Terminkonferenzen aktualisieren kann; false
sonst. |
calendar.capabilities.canAddAttachments |
boolean Von Nutzern erstellte Daten. true
Ob dem Termin mit dem Add-on neue Anhänge hinzugefügt werden können
Andernfalls false .
|
calendar.conferenceData |
Conference data object Von Nutzern erstellte Daten: Ein Objekt, das Konferenzdaten darstellt die mit diesem Termin verknüpft sind, z. B. Details zur Google Meet-Konferenz. |
calendar.id |
string Die Ereignis-ID. |
calendar.organizer |
object Ein Objekt, das den Organisator der . |
calendar.organizer.email |
string E-Mail-Adresse des Organisators |
calendar.recurringEventId |
string ID eines wiederkehrenden Termins. |
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
.
Teilnehmerobjekt | |
---|---|
attendee.additionalGuests |
number Die Anzahl der zusätzlichen Gäste des Gastes dass sie mitbringen. Der Standardwert ist null. |
attendee.comment |
string Der Kommentar der Antwort des Teilnehmers, falls vorhanden. |
attendee.displayName |
string Der angezeigte Name des Teilnehmers. |
attendee.email |
string E-Mail-Adresse des Teilnehmers |
attendee.optional |
boolean true , wenn die Teilnahme an diesem
Teilnehmer ist als optional gekennzeichnet; Andernfalls false .
|
attendee.organizer |
boolean true , wenn der Teilnehmer ein
Organisator dieses Termins an.
|
attendee.resource |
boolean true , wenn der Teilnehmer einen
Ressource, z. B. Raum oder Ausstattung, false
sonst.
|
attendee.responseStatus |
string Der Antwortstatus des Teilnehmers. Möglich Folgende Werte sind möglich: <ph type="x-smartling-placeholder">
|
attendee.self |
boolean true , wenn dieser Teilnehmer an
den Kalender, in dem dieser Termin angezeigt wird Andernfalls false .
|
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
.
Konferenzdatenobjekt | |
---|---|
conferenceData.conferenceId |
string ID der Konferenz. Diese ID soll damit Anwendungen den Überblick über Konferenzen behalten können; sollten Sie nicht Nutzern diese ID anzuzeigen. |
conferenceData.conferenceSolution |
object Ein Objekt, das die Konferenz repräsentiert wie Hangouts oder Google Meet. |
conferenceData.conferenceSolution.iconUri |
string Der URI für das für den Nutzer sichtbare Symbol, das für diese Konferenzlösung. |
conferenceData.conferenceSolution.key |
object Der Schlüssel, der die Property eindeutig identifiziert Konferenzlösung für diese Veranstaltung. |
conferenceData.conferenceSolution.key.type |
string Der Lösungstyp für Konferenzen. Mögliche Werte umfassen Folgendes: <ph type="x-smartling-placeholder">
|
conferenceData.conferenceSolution.name |
string Der für den Nutzer sichtbare Name dieser Konferenz (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. Anleitungen von Domainadministrator oder rechtliche Hinweise) zur Konferenz die für den Nutzer angezeigt werden sollen. Kann HTML enthalten. Die maximale Länge beträgt 2.048 Zeichen. Zeichen. |
conferenceData.parameters |
object Ein Objekt mit einer Karte von definierten Parameterdaten zur Verwendung durch das Add-on. |
conferenceData.parameters.addOnParameters |
object Eine Zuordnung von Schlüsseln und Werten für Parameterstrings. Diese Schlüssel und Werte werden vom Add-on-Entwickler definiert, um sie anzuhängen Informationen zur Verwendung des Add-ons an eine bestimmte Konferenz. |
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
.
Einstiegspunktobjekt | |
---|---|
entryPoint.accessCode |
string Der Zugriffscode für die Teilnahme an der Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter in der Regel nur eine Teilmenge von { accessCode , meetingCode ,
passcode , password , pin } nach
Zugang zu Konferenzen ermöglichen. Stimmt überein und zeigt nur die Felder an
die der Konferenzanbieter nutzt.
|
entryPoint.entryPointFeatures |
list Funktionen des Einstiegspunkts. Aktuell Features gelten nur für phone Einstiegspunkte:
<ph type="x-smartling-placeholder">
|
entryPoint.entryPointType |
string Der Typ des Einstiegspunkts. Mögliche Werte sind Folgendes: <ph type="x-smartling-placeholder">
|
entryPoint.label |
string Das für den Nutzer sichtbare Label für den Einstiegspunkt-URI (nicht lokalisiert). |
entryPoint.meetingCode |
string Der Besprechungscode für die Teilnahme an der Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter in der Regel nur eine Teilmenge von { accessCode , meetingCode ,
passcode , password , pin } nach
Zugang zu Konferenzen ermöglichen. Stimmt überein und zeigt nur die Felder an
die der Konferenzanbieter nutzt.
|
entryPoint.passcode |
string Der Sicherheitscode, mit dem auf die Konferenz zugegriffen wurde. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter in der Regel nur eine Teilmenge von { accessCode , meetingCode ,
passcode , password , pin } nach
Zugang zu Konferenzen ermöglichen. Stimmt überein und zeigt nur die Felder an
die der Konferenzanbieter nutzt.
|
entryPoint.password |
string Das Passwort für die Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter in der Regel nur eine Teilmenge von { accessCode , meetingCode ,
passcode , password , pin } nach
Zugang zu Konferenzen ermöglichen. Stimmt überein und zeigt nur die Felder an
die der Konferenzanbieter nutzt.
|
entryPoint.pin |
string Die PIN für den Zugriff auf die Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter in der Regel nur eine Teilmenge von { accessCode , meetingCode ,
passcode , password , pin } nach
Zugang zu Konferenzen ermöglichen. Stimmt überein und zeigt nur die Felder an
die der Konferenzanbieter nutzt.
|
entryPoint.regionCode |
string Regionscode der Telefonnummer. Erforderlich von Nutzer, wenn die URI keinen Ländercode enthält. Werte basieren auf der Öffentlichkeit CLDR-Liste der Regionscodes |
entryPoint.uri |
string Der URI des Einstiegspunkts. Das Maximum die Länge 1300 Zeichen beträgt. Die Formatierung hängt vom Einstiegspunkt ab Typ: <ph type="x-smartling-placeholder">
|
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-Ereignisobjekt | |
---|---|
drive.activeCursorItem |
Drive item object Die derzeit aktive Drive-Datei. |
drive.selectedItems[] |
list of Drive item objects Eine Liste der in Google Drive ausgewählten Elemente (Dateien oder Ordner). |
Drive-Element
Drive-Elementobjekte enthalten Informationen zu bestimmten Drive-Elementen, z. B. Dateien oder Ordner einplanen können.
Drive-Elementobjekt | |
---|---|
item.addonHasFileScopePermission |
boolean Wenn true , wurde vom Add-on Folgendes angefordert:
und erhielt https://www.googleapis.com/auth/drive.file
Umfang der Autorisierung für dieses Element Andernfalls ist dieses Feld
false
|
item.id |
string ID des ausgewählten Elements. |
item.iconUrl |
string Die URL des Symbols für das ausgewähltes Element. |
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. Ist nur in einem Ereignisobjekt vorhanden wenn die Host-Anwendung Gmail ist.
Gmail-Ereignisobjekt | |
---|---|
gmail.accessToken |
string Das Gmail-spezifische Zugriffstoken. Sie können dieses Token mit dem <ph type="x-smartling-placeholder"></ph> GmailApp.setCurrentMessageAccessToken(accessToken) .
können Sie Ihrem Add-on vorübergehenden Zugriff auf die
öffnen Sie eine Gmail-Nachricht oder lassen Sie das Add-on neue Entwürfe schreiben.
|
gmail.bccRecipients[] |
list of strings Standardmäßig deaktiviert. Die Liste von "Bcc:" die derzeit im Entwurf der ein Add-on erstellt. Um dieses Feld zu aktivieren, müssen Sie den addOns.gmail.composeTrigger.draftAccess in deinem Manifest, um
METADATA .
|
gmail.ccRecipients[] |
list of strings Standardmäßig deaktiviert. Die Liste auf "Cc:" die derzeit im Entwurf der ein Add-on erstellt. Um dieses Feld zu aktivieren, müssen Sie den addOns.gmail.composeTrigger.draftAccess in deinem Manifest, um
METADATA .
|
gmail.messageId |
string Die ID der aktuell geöffneten Gmail-Nachricht. |
gmail.threadId |
string Die aktuell geöffnete Gmail-Thread-ID. |
gmail.toRecipients[] |
list of strings Standardmäßig deaktiviert. Die Liste von "An:" die derzeit im Entwurf der ein Add-on erstellt. Um dieses Feld zu aktivieren, müssen Sie den addOns.gmail.composeTrigger.draftAccess in deinem Manifest, um
METADATA .
|
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-Ereignisobjekt | |
---|---|
docs.id |
string Nur vorhanden, wenn der Bereich
https://www.googleapis.com/auth/drive.file
vom Nutzer autorisiert.Die ID des Dokuments, das in der Google Docs-Benutzeroberfläche geöffnet wird. |
docs.title |
string Nur vorhanden, wenn der Bereich
https://www.googleapis.com/auth/drive.file
vom Nutzer autorisiert.Der Titel des Dokuments, das in der Google Docs-Benutzeroberfläche geöffnet wird. |
docs.addonHasFileScopePermission |
boolean Wenn true , wurde vom Add-on Folgendes angefordert:
und erhielt https://www.googleapis.com/auth/drive.file
Genehmigung des Bereichs für das in der Docs-Benutzeroberfläche geöffnete Dokument Andernfalls
ist false .
|
docs.matchedUrl.url |
string
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind: <ph type="x-smartling-placeholder">
Die URL des Links, über den eine Vorschau in Google Docs erstellt wird. Wenn Sie dieses Feld verwenden möchten, müssen Sie die LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.
Nutzlastbeispiel für den Fall, dass ein Nutzer eine Vorschau des Links "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.
Google Tabellen-Ereignisobjekt | |
---|---|
sheets.id |
string Nur vorhanden, wenn der Bereich
https://www.googleapis.com/auth/drive.file
vom Nutzer autorisiert wurde. Die ID der in Google Tabellen geöffneten Tabelle.
|
sheets.title |
string Nur vorhanden, wenn der Bereich
https://www.googleapis.com/auth/drive.file
vom Nutzer autorisiert wurde. Der Titel der in Google Tabellen geöffneten Tabelle.
UI.
|
sheets.addonHasFileScopePermission |
boolean Wenn true , wurde vom Add-on Folgendes angefordert:
und erhielt https://www.googleapis.com/auth/drive.file
die Bereichsautorisierung für die Tabelle, die auf der Benutzeroberfläche von Google Tabellen geöffnet ist. sonst
hat dieses Feld den Wert false .
|
sheets.matchedUrl.url |
string
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind: <ph type="x-smartling-placeholder">
Die URL des Links, über den eine Vorschau in Google Tabellen erstellt wird. Wenn Sie dieses Feld verwenden möchten, müssen Sie die LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.
Nutzlastbeispiel für den Fall, dass ein Nutzer eine Vorschau des Links "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.
Google Präsentationen-Ereignisobjekt | |
---|---|
slides.id |
string Nur vorhanden, wenn der Bereich
https://www.googleapis.com/auth/drive.file
vom Nutzer autorisiert wurde. Die ID der in Google Präsentationen geöffneten Präsentation
UI.
|
slides.title |
string Nur vorhanden, wenn der Bereich
https://www.googleapis.com/auth/drive.file
vom Nutzer autorisiert wurde. Der Titel der Präsentation wird im
Benutzeroberfläche von Google Präsentationen
|
slides.addonHasFileScopePermission |
boolean Wenn true , wurde vom Add-on Folgendes angefordert:
und erhielt https://www.googleapis.com/auth/drive.file
Genehmigung des Bereichs für die Präsentation in der Google Präsentationen-Benutzeroberfläche. sonst
hat dieses Feld den Wert false .
|
slides.matchedUrl.url |
string
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind: <ph type="x-smartling-placeholder">
Die URL des Links, über den eine Vorschau in Google Präsentationen erstellt wird. Wenn Sie dieses Feld verwenden möchten, müssen Sie die LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren.
Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.
Nutzlastbeispiel für den Fall, dass ein Nutzer eine Vorschau des Links "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |