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 an Trigger- oder Callback-Funktionen übergeben werden, wenn ein Nutzer mit einem Add-on interagiert. 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:

  • Startseitentrigger 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:

    Wenn ein kontextbezogener Trigger ausgelöst wird, ruft die Hostanwendung die entsprechende runFunction auf, die im Add-on-Manifest aufgeführt ist, 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. Für Google Workspace-Add-ons werden dieselben Widget-Handlerfunktionen, Action-Objekte und Aktionsantworten verwendet. In Google Workspace-Add-ons enthalten die Ereignisobjekte für Aktionen jedoch noch mehr Informationen, auf die eine Rückruffunktion 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 können Sie Linkvorschaubilder für Drittanbieterdienste basierend auf bestimmten URL-Mustern konfigurieren. 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 Widget-Aktionen erstellen, damit Nutzer mit der Vorschaukarte und ihren Inhalten interagieren können.

  • Trigger für die Google Chat App (Entwicklervorabversion) In Google Chat wird Ihr Add-on Nutzern als Chat-App angezeigt. Sie können damit interagieren, indem sie es Gruppenbereichen hinzufügen, Nachrichten senden und Slash-Befehle verwenden. Um interaktive Funktionen zu erstellen, richten Sie verschiedene Trigger für Chat-Apps ein und verwenden diese. Jeder Trigger sendet eine andere Nutzlast des Ereignisobjekts, mit der Sie jede Art von Interaktion verarbeiten oder darauf reagieren können.

Struktur von Ereignisobjekten

In der folgenden Tabelle wird die Struktur der Ereignisobjekte von Google Workspace-Add-ons auf oberster Ebene beschrieben. Die Ereignisobjektstruktur enthält ein übergeordnetes Feld vom Typ commonEventObject 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 Tabelle unten 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
Nur vorhanden, wenn der anrufende Host Google Kalender ist. Ein Objekt mit Kalender- und Termininformationen.
eventObject.chat Chat event object
Nur vorhanden, wenn der anrufende Host Google Chat ist. Ein Objekt mit Chatinformationen.
eventObject.drive Drive event object
Nur vorhanden, wenn der anrufende Host Google Drive ist. Ein Objekt mit Drive-Informationen.
eventObject.gmail Gmail event object
Wird nur angezeigt, wenn der anrufende Host Gmail ist. Ein Objekt mit Gmail-Informationen.
eventObject.docs Docs event object
Nur vorhanden, wenn der aufrufende Host Google Docs ist. Ein Objekt mit Google Docs-Informationen.
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 Host Google Präsentationen ist. Ein Objekt mit Informationen zu Google Präsentationen.
Originalfelder des Gmail-Add-ons
eventObject.messageMetadata.accessToken string
Eingestellt. Ein Zugriffstoken So können Sie den Zugriff auf Nutzerdaten mithilfe temporärer Gmail-Add-on-Bereiche aktivieren.

Bei 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 ist.

Bei 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).

Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.commonEventObject.platform.

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 String-IDs, die mit den Widgets verknüpft sind, und die Werte sind Strings. Das Ereignisobjekt bietet formInput als praktische Lösung, wenn Sie Daten aus mehreren Widgets mit erwarteten einzelnen Werten lesen möchten, z. B. Textfelder und Schalter. Bei mehrwertigen Widgets wie Kästchen können Sie stattdessen jeden Wert aus formInputs lesen.

Bei 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 Zuordnung der aktuellen Werte der Widgets auf der Karte, dargestellt als Listen von Strings. 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.

Bei Google Workspace-Add-ons finden Sie diese Informationen im Feld eventObject.commonEventObject.formInputs.

eventObject.parameters object
Eingestellt. Eine Zuordnung aller zusätzlichen Parameter, die du mit Action.setParameters() an Action übergibst. Die Schlüssel und Werte der Zuordnung sind Strings.

Bei 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, der das Land oder die Region des Nutzers angibt. Es kann sich auch um einen numerischen UN M49-Ländercode handeln.

Bei 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 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.commonEventObject.userLocale.

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.commonEventObject.timeZone.id.

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

Zusätzlich zu 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 das gemeinsame 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.

Gängige Felder für Ereignisobjekte
commonEventObject.platform string
Gibt an, woher das Ereignis stammt („WEB“, „IOS“ oder „ANDROID“).
commonEventObject.formInputs object
Eine Zuordnung, die die aktuellen Werte der Widgets auf der angezeigten Karte enthält. Die Kartenschlüssel sind die String-IDs, die den einzelnen Widgets zugewiesen sind.

Die Struktur des Zuordnungswertobjekts hängt vom Widgettyp ab:

  • Widgets mit einem einzelnen Wert (z. B. ein Textfeld): eine Liste von Strings (nur ein Element)

    Beispiel: Wenn Sie auf den Wert eines Texteingabe-Widgets mit der ID employeeName zugreifen möchten, verwenden Sie e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

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

    Beispiel: Für ein Mehrfachwert-Widget mit der ID participants greifen Sie auf das Wertearray mit e.commonEventObject.formInputs.participants.stringInputs.value zu.

  • A date-time picker: eine DateTimeInput object.

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

  • A date-only picker: eine DateInput object.

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

  • A time-only picker: eine TimeInput object.

    Beispiel: Für eine Auswahl mit der ID myTimePicker greifen Sie über 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 einer Aktion mit actionParameters oder Action.setParameters() übergeben.

Entwicklervorschau : Bei Add-ons, die Google Chat erweitern, können Sie mit dem Wert des Schlüssels "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]) Elemente vorschlagen, die auf dem eingegebenen Text basieren. Mit diesem Wert können Sie eine Datenbank abfragen und Nutzern während der Eingabe auswählbare Elemente vorschlagen. Weitere Informationen finden Sie unter Informationen von Google Chat-Nutzern erheben und verarbeiten.
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 addOns.common.useLocaleFromApp auf true festlegen. Die Liste mit dem Geltungsbereich 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 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 Gültigkeitsliste 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 Zeitzonen-ID 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 Ihres Add-ons addOns.common.useLocaleFromApp auf true festlegen. Die Gültigkeitsliste 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 die Sprache und Zeitzone des Nutzers zugreifen.

Eingaben für die Datums-/Zeitauswahl

Aktion-Callback-Funktionen können aktuelle Widget-Werte im Feld commonEventObject.formInputs empfangen. Dazu gehören auch die vom Nutzer ausgewählten Datums- oder Uhrzeitwerte in Widgets für Datumsauswahl oder Uhrzeitauswahl. Die Struktur der Informationen unterscheidet sich jedoch je nachdem, ob das Widget als Datumsauswahl, Datumsauswahl oder Uhrzeitauswahl konfiguriert wurde. Die strukturellen Unterschiede werden in der folgenden Tabelle beschrieben:

DateTimeInput-Objekt
dateTimeInput.hasDate boolean
true, wenn das Datum und die Uhrzeit in der Eingabe ein Datum enthalten; bei false ist nur eine Uhrzeit enthalten.
dateTimeInput.hasTime boolean
true, wenn die Eingabe eine Uhrzeit enthält; bei false ist nur ein Datum enthalten.
dateTimeInput.msSinceEpoch string
Die vom Nutzer ausgewählte Uhrzeit in Millisekunden seit der Epoche (00:00:00 Uhr UTC am 1. Januar 1970).
DateInput-Objekt
dateInput.msSinceEpoch string
Die vom Nutzer ausgewählte Uhrzeit in Millisekunden seit der Epoche (00:00:00 Uhr UTC am 1. Januar 1970).
TimeInput-Objekt
timeInput.hours number
Die vom Nutzer ausgewählte Stunde.
timeInput.minutes number
Die vom Nutzer ausgewählte Minutenzahl.

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 aufgeführt, die im Feld calendarEventObject eines Ereignisobjekts enthalten sind. 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 am Kalendertermin.
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 wenn das Add-on der Teilnehmerliste der Veranstaltung neue Teilnehmer hinzufügen kann; false andernfalls.
calendar.capabilities.canSeeAttendees boolean
Von Nutzern erstellte Daten true wenn das Add-on die Teilnehmerliste der Veranstaltung lesen kann; false andernfalls.
calendar.capabilities.canSeeConferenceData boolean
Von Nutzern erstellte Daten true wenn das Add-on die Konferenzdaten des Ereignisses lesen kann; false andernfalls.
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
Die E-Mail-Adresse des Organisators der Veranstaltung.
calendar.recurringEventId string
Die ID eines wiederkehrenden Termins.

Teilnehmer

Teilnehmerobjekte enthalten Informationen zu einzelnen Teilnehmern an Google Kalender-Terminen. 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.

Teilnehmerobjekt
attendee.additionalGuests number
Die Anzahl der zusätzlichen Gäste, die der Teilnehmer angegeben hat. Der Standardwert ist null.
attendee.comment string
Der Antwortkommentar 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 Anwesenheit dieses Teilnehmers als optional markiert ist, andernfalls false.
attendee.organizer boolean
true, wenn der Teilnehmer der Organisator dieser Veranstaltung ist.
attendee.resource boolean
true, wenn der Teilnehmer eine Ressource darstellt, z. B. einen Raum oder ein Gerät; false, andernfalls.
attendee.responseStatus string
Der Antwortstatus des Teilnehmers. Zulässige Werte:
  • accepted: Der Teilnehmer hat die Einladung zur Veranstaltung angenommen.
  • declined: Der Teilnehmer hat die Einladung zur Veranstaltung abgelehnt.
  • needsAction: Der Teilnehmer hat nicht auf die Einladung zur Veranstaltung geantwortet.
  • tentative: Der Teilnehmer hat die Einladung zur Veranstaltung vorläufig angenommen.
attendee.self boolean
true, wenn dieser Teilnehmer den Kalender darstellt, in dem dieses Ereignis angezeigt wird, andernfalls false.

Konferenzdaten

Konferenzdatenobjekte enthalten Informationen zu Konferenzen, die an Google Kalender-Termine angehängt sind. 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 Konferenzlösung darstellt, z. B. 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, mit dem die Konferenzlösung für dieses Ereignis eindeutig identifiziert wird.
conferenceData.conferenceSolution.key.type string
Der Konferenzlösungstyp. 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 Konferenz-Einstiegspunkte, 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 einer bestimmten Konferenz Informationen für die Verwendung des Add-ons hinzuzufügen.

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. Derzeit gelten diese Funktionen nur für phone-Einstiegspunkte:
  • toll: Der Einstiegspunkt ist ein kostenpflichtiger Anruf.
  • toll_free: Der Einstiegspunkt ist ein Anruf auf eine gebührenfreie Telefonnummer.
entryPoint.entryPointType string
Die Art des Einstiegspunkts. Folgende Werte sind möglich:
  • more: Zusätzliche Anleitungen für die Teilnahme an der Konferenz, z. B. alternative Telefonnummern. Eine Konferenz kann nur einen more-Einstiegspunkt haben. Ist dieser vorhanden, ist mindestens ein weiterer Einstiegspunkt erforderlich.
  • phone: An der Konferenz über eine Telefonnummer teilnehmen. Eine Konferenz kann null oder mehr phone-Einstiegspunkte haben. In Google Kalender werden nur die ersten beiden Einträge für Telefonnummern angezeigt, nachdem sie formatiert und alphabetisch sortiert wurden.
  • sip: An der Konferenz über SIP teilnehmen. Eine Konferenz kann höchstens einen sip-Einstiegspunkt haben.
  • video: An der Konferenz über HTTP teilnehmen. Eine Konferenz kann höchstens einen video-Einstiegspunkt haben.
entryPoint.label string
Das für Nutzer sichtbare Label für den URI des Einstiegspunkts (nicht lokalisiert).
entryPoint.meetingCode string
Der Besprechungscode, der 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.passcode string
Der Sicherheitscode für den Zugriff auf 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.password string
Das Passwort für den Zugriff auf 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.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. 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 muss die gesamte Wählsequenz enthalten (z. B. „tel:+12345678900,,,12345678;1234“).
  • sip: Ein sip:- oder sips:-Schema ist erforderlich. Beispiel: „sip:12345678@myprovider.com“.
  • video: Ein http:- oder https:-Schema ist erforderlich.

Drive-Ereignisobjekt

Das Drive-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zu Google Drive und den Inhalten eines Nutzers enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Drive 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 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 Ihr Add-on neue Entwürfe schreiben zu 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 erstellt. Wenn Sie dieses Feld aktivieren möchten, müssen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA festlegen.
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, den das Add-on gerade verfasst. Wenn Sie dieses Feld aktivieren möchten, müssen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA festlegen.
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. Wenn Sie dieses Feld aktivieren möchten, müssen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA festlegen.

Google Docs-Ereignisobjekt

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

Docs-Ereignisobjekt
docs.id string
Nur vorhanden, wenn der Nutzer den Umfang https://www.googleapis.com/auth/drive.file autorisiert hat.
Die ID des Dokuments, das in der Docs-Benutzeroberfläche geöffnet ist.
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 die https://www.googleapis.com/auth/drive.file-Berechtigung für das in der Docs-Benutzeroberfläche geöffnete Dokument angefordert und erhalten. Andernfalls ist dieses Feld false.
docs.matchedUrl.url string
Nur vorhanden, wenn folgende Bedingungen erfüllt sind:
  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL stimmt mit dem im LinkPreviewTriggers-Trigger 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 Ihres Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips erstellen.

Beispielnutzlast für die Vorschau eines Links https://www.example.com/12345: 

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

Google Tabellen-Ereignisobjekt

Das Google Tabellen-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und seinem Inhalt enthält. 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 Nutzer den Umfang https://www.googleapis.com/auth/drive.file autorisiert hat. Der Titel der Tabelle, die in der Google Tabellen-Benutzeroberfläche geöffnet ist.
sheets.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die https://www.googleapis.com/auth/drive.file-Berechtigung für den Gültigkeitsbereich für die Tabelle angefordert und erhalten, die in der Google Tabellen-Benutzeroberfläche geöffnet ist. Andernfalls ist dieses Feld false.
sheets.matchedUrl.url string
Nur vorhanden, wenn folgende Bedingungen erfüllt sind:
  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL stimmt mit dem im LinkPreviewTriggers-Trigger 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 Ihres Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips erstellen.

Beispielnutzlast für die Vorschau eines Links https://www.example.com/12345:

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

Ereignisobjekt für Google Präsentationen

Das Ereignisobjekt „Präsentationen“ ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und seinem Inhalt enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Präsentationen ist.

Ereignisobjekt für Google Präsentationen
slides.id string
Nur vorhanden, wenn der Nutzer den Umfang https://www.googleapis.com/auth/drive.file autorisiert hat. Die ID der Präsentation, die in der Google Präsentationen-Benutzeroberfläche geöffnet ist.
slides.title string
Nur vorhanden, wenn der Nutzer den Umfang https://www.googleapis.com/auth/drive.file autorisiert hat. Der Titel der Präsentation, die in der Google Präsentationen-Benutzeroberfläche geöffnet ist.
slides.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die https://www.googleapis.com/auth/drive.file-Bereichsautorisierung für die Präsentation angefordert und erhalten, die in der Benutzeroberfläche von Google Präsentationen geöffnet ist. Andernfalls ist dieses Feld false.
slides.matchedUrl.url string
Nur vorhanden, wenn folgende Bedingungen erfüllt sind:
  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL stimmt mit dem im LinkPreviewTriggers-Trigger 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 die LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

Beispielnutzlast für die Vorschau eines Links https://www.example.com/12345:

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