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.
Ereignisobjekt | |
---|---|
eventObject.commonEventObject |
Common fields object
Ein Objekt mit Informationen, die für alle Ereignisobjekte gemeinsam sind, unabhängig von der Hostanwendung. |
eventObject.calendar |
Calendar event object
Wird nur angezeigt, wenn der anrufende Host Google Kalender ist. Ein Objekt mit Kalender- und Termininformationen. |
eventObject.drive |
Drive event object
Nur vorhanden, wenn der anrufende Host Google Drive ist. Ein 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 aufrufende Host Google Docs ist. Objekt mit Informationen aus Google Docs. |
eventObject.sheets |
Sheets event object
Nur vorhanden, wenn der aufrufende Host Google Tabellen ist. Ein Objekt mit Google Tabellen-Informationen. |
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 über temporäre Gmail-Add-on-Bereiche zu aktivieren.
Informationen zu Google Workspace-Add-ons finden Sie in der
|
eventObject.messageMetadata.messageId |
string Eingestellt. 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.clientPlatform |
string Eingestellt. Gibt an, wo das Ereignis (Web, iOS oder Android).
Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld |
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. Bei mehrwertigen Widgets wie Kästchen können Sie stattdessen jeden Wert aus formInputs lesen.
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 Widgets mit einem einzelnen Wert wird der Wert in einem Array mit einem Element dargestellt. Bei mehrwertigen Widgets 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 Action verwenden
Action.setParameters() Die Schlüssel und Werte der Zuordnung sind Strings.
Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld |
eventObject.userCountry |
string Eingestellt und standardmäßig deaktiviert. Der aus zwei Buchstaben bestehende Code, der das Land oder die Region des Nutzers angibt. Es kann auch sein, ein numerischer Wert UN M49-Ländercode.
Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld |
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 Auf die Sprache und Zeitzone des Nutzers zugreifen.
Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld |
eventObject.userTimezone.id |
string Eingestellt 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 die Sprache und Zeitzone des Nutzers zugreifen.
Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld |
eventObject.userTimezone.offset |
string Eingestellt und standardmäßig deaktiviert. Der Zeitversatz gegenüber der koordinierten Weltzeit (UTC) der Zeitzone des Nutzers, gemessen in Millisekunden. Weitere Informationen finden Sie unter Auf die Sprache und Zeitzone des Nutzers zugreifen.
Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld |
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.
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 Zuordnungswertobjekts hängt vom Widgettyp ab:
|
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:
|
commonEventObject.parameters |
object Zusätzliche Parameter, die Sie an
Action mithilfe von
Action.setParameters() .
|
commonEventObject.userLocale |
string Standardmäßig deaktiviert. Die Sprache und die Länder-/Regionskennung des Nutzers im Format ISO 639-ISO 3166-Länder-/Regionscode. Beispiel: en-US .
Wenn Sie dieses Feld aktivieren möchten, müssen Sie im Manifest Ihres Add-ons |
commonEventObject.timeZone |
string Standardmäßig deaktiviert. Die Zeitzonen-ID und die Zeitzonenverschiebung. Wenn Sie dieses Feld aktivieren möchten, müssen Sie im Manifest Ihres Add-ons addOns.common.useLocaleFromApp auf true festlegen.
Die Zuständigkeitsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten.
Weitere Informationen finden Sie unter Auf die 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 Zum Aktivieren dieses Felds müssen Sie Folgendes festlegen:
addOns.common.useLocaleFromApp im Manifest Ihres Add-ons auf true .
Die Zuständigkeitsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf die Sprache und Zeitzone des Nutzers zugreifen.
|
commonEventObject.timeZone.offset |
string Der Zeitversatz 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, um weitere Informationen zu erhalten. |
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.currentEventAccess
manifest auf READ
oder READ_WRITE
festlegt.
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 Ein Objekt, das die Funktionen des Add-ons zum Ansehen oder Aktualisieren von Ereignisinformationen beschreibt. |
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
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 E-Mail-Adresse des Organisators. |
calendar.recurringEventId |
string Die 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, die der Teilnehmer angegeben hat. 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 Die 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. Zulässige Werte:
|
attendee.self |
boolean true , wenn dieser Teilnehmer den Kalender darstellt, in dem dieser Termin angezeigt wird, andernfalls false .
|
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.currentEventAccess
manifest auf READ
oder READ_WRITE
festlegt.
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 Konferenz repräsentiert wie 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 Property eindeutig identifiziert Konferenzlösung für diese Veranstaltung. |
conferenceData.conferenceSolution.key.type |
string Der Konferenzlösungstyp. Mögliche Werte:
|
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 Konferenz, 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 Zuordnung von definierten Parameterdaten für die Verwendung durch das Add-on. |
conferenceData.parameters.addOnParameters |
object Eine Zuordnung von Parameterstringschlüsseln und ‑werten. 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 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.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 Zugriff auf Konferenzen zu gewähren. Die Felder des Konferenzanbieters werden abgeglichen und nur angezeigt.
|
entryPoint.entryPointFeatures |
list Funktionen des Einstiegspunkts. Aktuell Features gelten nur für phone Einstiegspunkte:
|
entryPoint.entryPointType |
string Die Art des Einstiegspunkts. Folgende Werte sind möglich:
|
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. Die Felder des Konferenzanbieters werden abgeglichen und nur angezeigt.
|
entryPoint.passcode |
string Der Sicherheitscode, mit dem auf die Konferenz zugegriffen wurde. 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. Die Felder des Konferenzanbieters werden abgeglichen und nur angezeigt.
|
entryPoint.password |
string Das Passwort 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 Zugriff auf Konferenzen zu gewähren. Stimmt überein und zeigt nur die Felder an
die der Konferenzanbieter nutzt.
|
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. Die Felder des Konferenzanbieters werden abgeglichen und nur angezeigt.
|
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:
|
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-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 Ordnern.
Drive-Elementobjekt | |
---|---|
item.addonHasFileScopePermission |
boolean Wenn true , hat das Add-on eine https://www.googleapis.com/auth/drive.file -Autorisierung für diesen Artikel angefordert und erhalten. Andernfalls ist dieses Feld false .
|
item.id |
string Die ID des ausgewählten Artikels. |
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. Sie können dieses Token mit der Methode GmailApp.setCurrentMessageAccessToken(accessToken) verwenden, um Ihrem Add-on vorübergehenden Zugriff auf die aktuell geöffnete Gmail-Nachricht eines Nutzers zu gewähren oder es Ihr Add-on neue Entwürfe schreiben lassen.
|
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 gerade verfasst. 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 der E-Mail-Adressen der Cc-Empfänger, die derzeit in einem Entwurf enthalten sind, der vom Add-on erstellt wird. 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 ID des derzeit geöffneten Gmail-Threads. |
gmail.toRecipients[] |
list of strings Standardmäßig deaktiviert. Die Liste der E-Mail-Adressen der Empfänger, die derzeit in einem Entwurf enthalten sind, den das Add-on gerade verfasst. 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 zum Dokument eines Nutzers und seinem Inhalt enthält. Kommt nur in einer -Ereignisobjekt, wenn die Host-Anwendung Google Docs ist.
Google 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 Nutzer den Umfang
https://www.googleapis.com/auth/drive.file autorisiert hat.Der Titel des Dokuments, das in der Docs-Benutzeroberfläche geöffnet ist. |
docs.addonHasFileScopePermission |
boolean Wenn true , hat das Add-on
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 folgende Bedingungen erfüllt sind:
Die URL des Links, über den eine Vorschau in Google Docs generiert wird. Wenn Sie dieses Feld verwenden möchten, müssen Sie 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. Sie ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Tabellen ist.
Google Tabellen-Ereignisobjekt | |
---|---|
sheets.id |
string Nur vorhanden, wenn der Nutzer den Umfang
https://www.googleapis.com/auth/drive.file autorisiert hat. Die ID der Tabelle, die in der Google Tabellen-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 in Google Tabellen geöffneten Tabelle.
UI.
|
sheets.addonHasFileScopePermission |
boolean Wenn true , hat das Add-on
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 folgende Bedingungen erfüllt sind:
Die URL des Links, über den eine Vorschau in Google Tabellen generiert wird. Wenn Sie dieses Feld verwenden möchten, müssen Sie LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips erstellen.
Beispielnutzlast für die Vorschau eines 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.
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 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 Benutzeroberfläche von Google Präsentationen sonst
hat dieses Feld den Wert false .
|
slides.matchedUrl.url |
string
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:
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.
Beispielnutzlast für die Vorschau eines Links "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |