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 übergeben werden, um Funktionen auszulösen oder zurückzurufen, wenn ein Nutzer mit einem Add-on interagiert. Ereignisobjekte enthalten clientseitige Informationen zur Host-App und dem aktuellen Kontext für die serverseitige Callback-Funktion des Add-ons.

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

  • Startseiten-Trigger: 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 der Triggerfunktion Ihrer Startseite verwenden, um die aktive Host-App, die Plattform des Clients, die Sprache des Nutzers und andere Informationen zu identifizieren.

    Die Ereignisobjekte, die beim Auslösen von Triggern für die Startseite erstellt werden, enthalten nicht alle Felder, die in den anderen beiden Fällen enthalten sind. Felder, die zu Widgets und Kontextinformationen gehören, werden ausgelassen.

  • Kontextabhängige Trigger: Jede Hostanwendung stellt einen anderen Satz kontextbezogener Trigger bereit, die ausgelöst werden, wenn der Nutzer einen bestimmten Kontext öffnet. Beispiel:

    Wenn ein kontextbezogener Trigger ausgelöst wird, ruft die Hostanwendung das entsprechende runFunction auf, das im Add-on-Manifest aufgeführt ist, und übergibt ihm ein Ereignisobjekt als Parameter. Die Ereignisobjekte, die beim Auslösen von kontextbezogenen Triggern erstellt werden, enthalten alle Felder der Ereignisobjekte von Startseiten-Triggern sowie Felder mit Kontextinformationen.

  • Widget-Aktionen: Außerdem werden Ereignisobjekte verwendet, um mit demselben Aktionsmodell wie Gmail-Add-ons Widgets-Interaktionen bereitzustellen. Google Workspace-Add-ons verwenden dieselben Widget-Handler-Funktionen, Action-Objekte und Aktionsantworten. In den Google Workspace-Add-ons enthalten die Aktionsereignisobjekte jedoch noch mehr Informationen, auf die eine Callback-Funktion angewendet werden kann.

    Die durch Widget-Aktionen erstellten Ereignisobjekte enthalten alle Felder der kontextabhängigen Trigger-Ereignisobjekte sowie Felder mit Widgetinformationen.

  • Trigger für Vorschaulinks: In Google Docs, Google Tabellen und Google Präsentationen können Sie eine Linkvorschau für Drittanbieterdienste anhand bestimmter URL-Muster konfigurieren. Wenn Nutzer mit einem Link interagieren, der dem Muster entspricht, wird der linkPreviewTriggers ausgelöst und ein Ereignisobjekt, das den Link enthält, an die Callback-Funktion des Triggers übergeben. Das 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 ihrem Inhalt interagieren können.

Struktur des Ereignisobjekts

In der folgenden Tabelle wird die übergeordnete Struktur der Ereignisobjekte von Google Workspace-Add-ons beschrieben. Die Struktur des Ereignisobjekts umfasst ein Feld auf der obersten Ebene commonEventObject für hostunabhängige Informationen. Jedes Ereignisobjekt kann auch eines der folgenden hostspezifischen Felder auf oberster Ebene haben, die von der aktiven Host-App festgelegt werden: gmailEventObject, calendarEventObject oder driveEventObject.

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

Ereignisobjekt
eventObject.commonEventObject Common fields object
Ein Objekt mit Informationen, die für alle Ereignisobjekte gelten, unabhängig von der Hostanwendung.
eventObject.calendar Calendar event object
Nur vorhanden, wenn der aufrufende Organisator Google Kalender ist Ein Objekt, das Kalender- und Termininformationen enthält.
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 Gmail als Organisator des Anrufs verwendet wird Ein Objekt mit Gmail-Informationen.
eventObject.docs Docs event object
Nur vorhanden, wenn der aufrufende Organisator Google Docs ist. Ein Objekt, das Informationen zu Google Docs enthält.
eventObject.sheets Sheets event object
Nur vorhanden, wenn Google Tabellen der aufrufende Organisator ist Ein Objekt mit Informationen aus Google Tabellen.
eventObject.slides Slides event object
Nur vorhanden, wenn Google Präsentationen der aufrufende Organisator ist Ein Objekt mit Informationen zu Google Präsentationen.
Felder des ursprünglichen Gmail-Add-ons
eventObject.messageMetadata.accessToken string
Eingestellt. Ein Zugriffstoken Damit können Sie den Zugriff auf Nutzerdaten mit temporären Gmail-Add-on-Bereichen aktivieren.

Für Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Eingestellt. Die Nachrichten-ID des Threads, der in der Gmail-Benutzeroberfläche geöffnet wird.

Für Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.gmail.messageId.

eventObject.clientPlatform string
Eingestellt. Gibt an, woher das Ereignis stammt (Web, iOS oder Android).

Für Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.commonEventObject.platform.

eventObject.formInput object
Eingestellt. Eine Übersicht 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 einzelnen Werten wie Texteingaben und Schaltern lesen müssen. Bei mehrwertigen Widgets wie Kästchen können Sie stattdessen jeden Wert aus formInputs lesen.

Für 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
Eingestellt. Eine Karte mit den aktuellen Werten von Widgets in der Karte, dargestellt als Listen von Strings. Die Schlüssel sind die mit dem Widget verknüpften String-IDs. Bei einwertigen Widgets wird der Wert in einem Array mit einem Element angegeben. Bei mehrwertigen Widgets wie Kästchengruppen werden alle Werte in einer Liste angezeigt.

Für Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.commonEventObject.formInputs.

eventObject.parameters object
Eingestellt. Eine Zuordnung aller zusätzlichen Parameter, die Sie mit Action.setParameters() dem Action angeben. Die Zuordnungsschlüssel und -werte sind Strings.

Für Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.commonEventObject.parameters.

eventObject.userCountry string
Eingestellt 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.

Für Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Eingestellt und standardmäßig deaktiviert. Der aus zwei Buchstaben bestehende Code gemäß ISO 639, der die Sprache des Nutzers angibt. Weitere Informationen finden Sie unter Auf die Sprache und Zeitzone des Nutzers zugreifen.

Für Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Eingestellt 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 das Gebietsschema und die Zeitzone des Nutzers zugreifen.

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

eventObject.userTimezone.offset string
Eingestellt und standardmäßig deaktiviert. Die Zeitverschiebung zur koordinierten Weltzeit (UTC) in der Zeitzone des Nutzers, gemessen in Millisekunden. Weitere Informationen finden Sie unter Auf das Gebietsschema und die Zeitzone des Nutzers zugreifen.

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

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. Dazu gehören Details wie Sprache, Host-App und Plattform des Nutzers.

Zusätzlich zu den Startseiten- und kontextbezogenen Triggern können mit Add-ons Ereignisobjekte erstellt und an Aktions-Callback-Funktionen übergeben werden, wenn der Nutzer mit Widgets interagiert. Die Callback-Funktion Ihres Add-ons kann das allgemeine Ereignisobjekt abfragen, um den Inhalt der geöffneten Widgets im Client des Nutzers zu ermitteln. Ihr Add-on kann beispielsweise den Text finden, den ein Nutzer in ein TextInput-Widget im eventObject.commentEventObject.formInputs-Objekt eingegeben hat.

Allgemeine Felder für Ereignisobjekte
commonEventObject.platform string
Gibt den Ursprung des Ereignisses an („WEB“, „IOS“ oder „ANDROID“).
commonEventObject.formInputs object
Eine Karte 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 Kartenwertobjekts hängt vom Widget-Typ ab:

  • Einwertige Widgets (z. B. ein Textfeld): eine Liste von Strings (nur ein Element).

    Beispiel: Greifen Sie bei einem Texteingabe-Widget mit employeeName als ID auf den Texteingabewert mit e.commonEventObject.formInputs.employeeName.stringInputs.value[0] zu.

  • Mehrwertige Widgets (z. B. Kästchengruppen): eine Liste von Strings.

    Beispiel: Greifen Sie bei einem mehrwertigen Widget mit participants als ID auf das Wertearray zu: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

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

  • A date-only picker: DateInput object.

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

  • A time-only picker: TimeInput object.

    Beispiel: Greifen Sie für eine Auswahl mit der ID myTimePicker 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. Zulässige Werte:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Alle zusätzlichen Parameter, die Sie mit Action.setParameters() an die Action übergeben.
commonEventObject.userLocale string
Standardmäßig deaktiviert. Die Sprach- und Landes-/Regionskennung des Nutzers im Format des ISO 639-Sprachcodes – ISO 3166-Länder-/Regionscode. Beispiel: en-US.

Wenn du dieses Feld aktivieren möchtest, musst du im Manifest des Add-ons addOns.common.useLocaleFromApp auf true setzen. Die Bereichsliste des Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf das Gebietsschema und die Zeitzone des Nutzers zugreifen.

commonEventObject.timeZone string
Standardmäßig deaktiviert. Die Zeitzonen-ID und der Offset. Wenn Sie dieses Feld aktivieren möchten, müssen Sie im Manifest des Add-ons addOns.common.useLocaleFromApp auf true setzen. Die Liste der Bereiche des Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf das Gebietsschema und die 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 des Add-ons addOns.common.useLocaleFromApp auf true setzen. Die Liste der Bereiche des Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf das Gebietsschema und die Zeitzone des Nutzers zugreifen.
commonEventObject.timeZone.offset string
Die Zeitverschiebung zur koordinierten Weltzeit (UTC) in der Zeitzone des Nutzers, gemessen in Millisekunden. Weitere Informationen finden Sie unter Auf das Gebietsschema und die Zeitzone des Nutzers zugreifen.

Formulareingaben für Datums-/Uhrzeitauswahl

Callback-Funktionen für Aktionen können aktuelle Widget-Werte im Feld commonEventObject.formInputs empfangen. Dazu gehören auch die vom Nutzer ausgewählten Datums- und Uhrzeitwerte in Datums- oder Uhrzeitauswahl-Widgets. Die Struktur der Informationen hängt jedoch davon ab, ob das Widget als Datums-/Uhrzeitauswahl, nur als Datumsauswahl oder nur für die Uhrzeit konfiguriert wurde. Die strukturellen Unterschiede werden in der folgenden Tabelle beschrieben:

Objekt „DateTimeInput“
dateTimeInput.hasDate boolean
true, wenn die Eingabe für Datum und Uhrzeit ein Datum enthält; wenn false nur eine Uhrzeit enthält.
dateTimeInput.hasTime boolean
true, wenn das eingegebene Datum/Uhrzeit eine Uhrzeit enthält; wenn false nur ein Datum enthält.
dateTimeInput.msSinceEpoch string
Die vom Nutzer ausgewählte Zeit in Millisekunden seit der Epoche (00:00:00 Uhr UTC am 1. Januar 1970).
Objekt „DateInput“
dateInput.msSinceEpoch string
Die vom Nutzer ausgewählte Zeit in Millisekunden seit der Epoche (00:00:00 Uhr UTC am 1. Januar 1970).
TimeInput-Objekt
timeInput.hours number
Die vom Nutzer ausgewählte Stundenzahl.
timeInput.minutes number
Die vom Nutzer ausgewählte Minutenangabe.

Kalenderereignisobjekt

Das Kalenderereignisobjekt ist der Teil des gesamten Terminobjekts, der Informationen zu den Kalendern und Kalenderterminen eines Nutzers enthält. Er ist nur dann in einem Terminobjekt vorhanden, wenn die Host-Anwendung Google Kalender ist.

In der folgenden Tabelle sind die im Feld calendarEventObject eines Ereignisobjekts vorhandenen Felder aufgeführt. Felder, die als Von Nutzern erstellte 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.

Kalenderereignisobjekt
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 erstellte Daten Ein Objekt, das die Funktionen des Add-ons zum Anzeigen oder Aktualisieren von Ereignisinformationen beschreibt.
calendar.capabilities.canAddAttendees boolean
Von Nutzern erstellte Daten true Wenn das Add-on neue Teilnehmer zur Teilnehmerliste des Termins hinzufügen kann; andernfalls false.
calendar.capabilities.canSeeAttendees boolean
Von Nutzern erstellte Daten true, wenn das Add-on die Teilnehmerliste lesen kann; andernfalls false.
calendar.capabilities.canSeeConferenceData boolean
Von Nutzern erstellte Daten true, wenn das Add-on die Konferenzdaten lesen kann; andernfalls false.
calendar.capabilities.canSetConferenceData boolean
Von Nutzern erstellte Daten true, wenn das Add-on die Veranstaltungskonferenzdaten aktualisieren kann; andernfalls false.
calendar.capabilities.canAddAttachments boolean
Von Nutzern erstellte 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 Konferenzdaten darstellt, die mit diesem Termin verknüpft sind, z. B. Google Meet-Konferenzdetails.
calendar.id string
Die Ereignis-ID.
calendar.organizer object
Ein Objekt, das den Organisator des Termins darstellt.
calendar.organizer.email string
E-Mail-Adresse des Organisators
calendar.recurringEventId string
Die ID eines wiederkehrenden Termins.

Teilnehmer

Teilnehmerobjekte enthalten Informationen über einzelne Teilnehmer in 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 manifest auf READ oder READ_WRITE festlegt.

Teilnehmerobjekt
attendee.additionalGuests number
Die Anzahl der zusätzlichen Gäste, die der Teilnehmer mitbringt. Der Standardwert ist null.
attendee.comment string
Der Kommentar des Teilnehmers, falls vorhanden.
attendee.displayName string
Der Name des Teilnehmers.
attendee.email string
Die E-Mail-Adresse des Teilnehmers.
attendee.optional boolean
true, wenn die Teilnahme für diesen Teilnehmer als optional gekennzeichnet ist; andernfalls false.
attendee.organizer boolean
true, wenn der Teilnehmer ein Organisator dieses Termins ist.
attendee.resource boolean
true, wenn der Teilnehmer für eine Ressource steht, z. B. einen Raum oder ein Gerät; falseansonsten.
attendee.responseStatus string
Antwortstatus des Teilnehmers. Zulässige Werte:
  • accepted: Der Teilnehmer hat die Termineinladung angenommen.
  • declined: Der Teilnehmer hat die Einladung zur Veranstaltung 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 dem Kalender entspricht, in dem der Termin erscheint; andernfalls false.

Konferenzdaten

Konferenzdatenobjekte enthalten Informationen über Konferenzen, die an Google Kalender-Termine angehängt sind. Dies 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 manifest auf READ oder READ_WRITE festlegt.

Konferenzdatenobjekt
conferenceData.conferenceId string
Die ID der Konferenz. Mit dieser ID können Anwendungen Konferenzen verfolgen. 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 den Nutzer sichtbare Symbol, das diese Konferenzlösung darstellt.
conferenceData.conferenceSolution.key object
Der Schlüssel, der die Konferenzlösung für diese Veranstaltung eindeutig identifiziert.
conferenceData.conferenceSolution.key.type string
Die Art der Konferenzlösung. Zulässige 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 Konferenzeinstiegspunkte, z. B. URLs oder Telefonnummern.
conferenceData.notes string
Zusätzliche Hinweise zur Konferenz, z. B. Anweisungen des Domainadministrators oder rechtliche Hinweise, die dem Nutzer angezeigt werden sollen. 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 Schlüsseln und Werten für Parameterstrings. Diese Schlüssel und Werte werden vom Add-on-Entwickler definiert, um Informationen zur Verwendung durch das Add-on an eine bestimmte Konferenz anzuhängen.

Einstiegspunkt

Einstiegspunktobjekte enthalten Informationen über die vorhandenen 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 Feld addOns.calendar.currentEventAccess manifest auf READ oder READ_WRITE festlegt.

Einstiegspunktobjekt
entryPoint.accessCode string
Der Zugangscode für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Es werden immer nur die Felder angezeigt, die der Konferenzanbieter verwendet.
entryPoint.entryPointFeatures list
Funktionen des Einstiegspunkts. Derzeit gelten diese Features nur für phone-Einstiegspunkte:
  • toll: Der Einstiegspunkt ist ein gebührenpflichtiger Telefonanruf.
  • toll_free: Der Einstiegspunkt ist ein gebührenfreier Telefonanruf.
entryPoint.entryPointType string
Die Art des Einstiegspunkts. Mögliche Werte sind:
  • more: zusätzliche Anweisungen zur Teilnahme an Konferenzen, z. B. alternative Telefonnummern. Eine Konferenz kann nur einen more-Einstiegspunkt haben. Wenn mindestens ein anderer Einstiegspunkttyp vorhanden ist, ist auch dieser Typ erforderlich.
  • phone: Nehmen Sie über eine Telefonnummer an der Konferenz teil. Eine Konferenz kann null oder mehr phone-Einstiegspunkte haben. In Google Kalender werden nach alphabetischer Formatierung und Sortierung nur die ersten beiden Telefoneinstiegspunkte angezeigt.
  • 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 für die Teilnahme an der Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Es werden immer nur die Felder angezeigt, die der Konferenzanbieter verwendet.
entryPoint.passcode string
Der Sicherheitscode für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Es werden immer nur die Felder angezeigt, die der Konferenzanbieter verwendet.
entryPoint.password string
Das Passwort für den Zugang zur Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Es werden immer nur die Felder angezeigt, die der Konferenzanbieter verwendet.
entryPoint.pin string
Die PIN, mit der Sie an der Konferenz teilnehmen. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden in der Regel nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Es werden immer nur die Felder angezeigt, die der Konferenzanbieter verwendet.
entryPoint.regionCode string
Der 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 Regionscodes.
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@meinanbieter.de“.
  • video: Ein http:- oder https:-Schema ist erforderlich.

Drive-Ereignisobjekt

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

Drive-Ereignisobjekt
drive.activeCursorItem Drive item object
Das derzeit aktive Drive-Element.
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.

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 übergeordneten Ereignisobjekts, das Informationen zu den Gmail-Nachrichten eines Nutzers enthält. Er 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 der Methode GmailApp.setCurrentMessageAccessToken(accessToken) verwenden, um Ihrem Add-on vorübergehenden Zugriff auf die derzeit geöffnete Gmail-Nachricht eines Nutzers zu gewähren oder dem Add-on neue Entwürfe zu erstellen.
gmail.bccRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der „Bcc:“-E-Mail-Adressen der Empfänger, die derzeit im Entwurf des Add-ons enthalten sind. Wenn du dieses Feld aktivieren möchtest, musst du das Feld addOns.gmail.composeTrigger.draftAccess in deinem Manifest auf METADATA setzen.
gmail.ccRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der „Cc:“-Empfänger-E-Mail-Adressen, die derzeit im Entwurf des Add-ons enthalten sind. Wenn du dieses Feld aktivieren möchtest, musst du das Feld addOns.gmail.composeTrigger.draftAccess in deinem Manifest auf METADATA setzen.
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 der „An:“-E-Mail-Adressen der Empfänger, die derzeit im Entwurf des Add-ons enthalten sind. Wenn du dieses Feld aktivieren möchtest, musst du das Feld addOns.gmail.composeTrigger.draftAccess in deinem Manifest auf METADATA setzen.

Docs-Ereignisobjekt

Das Docs-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, das Informationen zum Dokument eines Nutzers und seinen Inhalten enthält. Er ist nur in einem Ereignisobjekt vorhanden, wenn Google Docs die Hostanwendung ist.

Docs-Ereignisobjekt
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 Google Docs-UI geöffnet wird.
docs.title string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde.
Der Titel des Dokuments wird in der Google Docs-UI geöffnet.
docs.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Umfang https://www.googleapis.com/auth/drive.file des in der Docs-UI geöffneten Dokuments angefordert und erhalten. Andernfalls lautet es 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 stimmt mit dem im Trigger LinkPreviewTriggers angegebenen Hostmuster überein.

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 des Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips ansehen.

Beispielnutzlast, wenn ein Nutzer eine Vorschau des Links https://www.example.com/12345 anzeigt: 

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

Google Tabellen-Ereignisobjekt

Das Google Tabellen-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, das Informationen zum Dokument eines Nutzers und seinen Inhalten enthält. Er ist nur dann in einem Ereignisobjekt vorhanden, wenn Google Tabellen die Hostanwendung 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 Tabelle, die in der Benutzeroberfläche von Google Tabellen geöffnet wird.
sheets.title string
Nur vorhanden, wenn der Bereich https://www.googleapis.com/auth/drive.file vom Nutzer autorisiert wurde. Der Titel der Tabelle wird in der Benutzeroberfläche von Google Tabellen geöffnet.
sheets.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Umfang https://www.googleapis.com/auth/drive.file für die Tabelle in der Benutzeroberfläche von Google Tabellen angefordert und erhalten. Andernfalls lautet das 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 stimmt mit dem im Trigger LinkPreviewTriggers angegebenen Hostmuster überein.

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 des Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips ansehen.

Beispielnutzlast, wenn ein Nutzer die Vorschau des Links https://www.example.com/12345 anzeigt:

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

Google Präsentationen-Ereignisobjekt

Das Google Präsentationen-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, das Informationen über das Dokument eines Nutzers und seinen Inhalt enthält. Er ist nur in einem Ereignisobjekt vorhanden, wenn Google Präsentationen die Hostanwendung 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 der Benutzeroberfläche von Google Präsentationen geöffneten Präsentation.
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 in der Benutzeroberfläche von Google Präsentationen geöffnet.
slides.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung des Bereichs https://www.googleapis.com/auth/drive.file für die Präsentation in der Benutzeroberfläche von Google Präsentationen angefordert und erhalten. Andernfalls lautet das 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 stimmt mit dem im Trigger LinkPreviewTriggers angegebenen Hostmuster überein.

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

Beispielnutzlast, wenn ein Nutzer die Vorschau des Links https://www.example.com/12345 anzeigt:

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