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 aufzurufen, wenn ein Nutzer mit einem Add-on interagiert. Ereignisobjekte enthalten clientseitige Informationen zur Host-App und den aktuellen Kontext zur serverseitigen Callback-Funktion des Add-ons.

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

  • Trigger auf der Startseite: Jede von Ihnen definierte homepageTrigger-Funktion wird automatisch an ein Ereignisobjekt übergeben, wenn die Trigger-Startseite ausgelöst wird. Sie können dieses Objekt in Ihrer Trigger-Startseite verwenden, um die aktive Host-App, die Plattform des Clients, die Nutzersprache und andere Informationen zu identifizieren.

    Die Ereignisobjekte, die beim Auslösen eines Triggers auf der 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 weggelassen.

  • Kontextbezogene Trigger: Jede Hostanwendung stellt einen anderen Satz von kontextbezogenen Triggern bereit, 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 ein Ereignisobjekt als Parameter. Die Ereignisobjekte, die beim Auslösen von kontextbezogenen Triggern erstellt werden, enthalten alle Felder, die in Triggern auf der Startseite enthalten sind, sowie Felder mit Kontextinformationen.

  • Widget-Aktionen: Ereignisobjekte dienen außerdem dazu, Widget-Interaktionen bereitzustellen. Dabei wird dasselbe Aktionsmodell verwendet wie in Gmail-Add-ons. Google Workspace-Add-ons verwenden dieselben Widget-Handler-Funktionen, Action-Objekte und Aktionsantworten. In Google Workspace-Add-ons enthalten die Aktionsereignisobjekte jedoch noch mehr Informationen, auf die eine Callback-Funktion angewendet werden kann.

    Die Ereignisobjekte, die durch Widget-Aktionen erstellt werden, enthalten alle Felder in kontextbezogenen Triggerereignisobjekten sowie Felder mit Widget-Informationen.

  • Trigger für Vorschaulinks (Entwicklervorschau). In Google Docs können Sie Linkvorschauen für Drittanbieterdienste basierend auf bestimmten URL-Mustern konfigurieren. Wenn Nutzer mit einem Link interagieren, der dem Muster entspricht, wird previewLinkTrigger ausgelöst und ein Ereignisobjekt, das den Link enthält, wird 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 anzeigen. Sie können auch Widget-Aktionen erstellen, damit Nutzer mit der Vorschaukarte und ihren Inhalten interagieren können.

Struktur eines Ereignisobjekts

In der folgenden Tabelle wird die oberste Struktur von Ereignisobjekten von Google Workspace-Add-ons beschrieben. Die Ereignisobjektstruktur enthält das Feld commonEventObject auf oberster Ebene für hostunabhängige Informationen. Jedes Ereignisobjekt kann auch eines der folgenden hostspezifischen Felder der obersten Ebene haben, das von der aktiven Hostanwendung festgelegt wird: gmailEventObject, calendarEventObject oder driveEventObject.

Aus Gründen der Abwärtskompatibilität enthalten Google Workspace-Add-on-Ereignisobjekte auch alle ursprünglichen Felder, die in Gmail-Add-on-Aktionsereignisobjekten verwendet werden. 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, das Informationen enthält, die für alle Ereignisobjekte unabhängig von der Hostanwendung gelten.
eventObject.calendar Calendar event object
Nur vorhanden, wenn der aufrufende Host Google Kalender ist. Ein Objekt mit Kalender- und Termininformationen.
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 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 Folieninformationen.
Ursprüngliche Gmail-Add-on-Felder
eventObject.messageMetadata.accessToken string
Verworfen. Ein Zugriffstoken Hiermit können Sie den Zugriff auf Nutzerdaten mithilfe temporärer Gmail-Add-on-Bereiche aktivieren.

Informationen zu Google Workspace-Add-ons finden Sie im Feld eventObject.gmail.accessToken.

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

Informationen zu Google Workspace-Add-ons finden Sie im Feld eventObject.gmail.messageId.

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

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

eventObject.formInput object
Verworfen. Eine Karte mit den aktuellen Werten 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. Die Werte sind Strings. Das Ereignisobjekt bietet formInput als praktische Möglichkeit, Daten aus mehreren Widgets mit erwarteten einzelnen Werten wie Texteingaben und Schaltern zu lesen. 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
Verworfen. Eine Karte mit den aktuellen Werten der Widgets auf der Karte, dargestellt als Listen von Strings. Die Schlüssel sind die mit dem Widget verknüpften String-IDs. Bei Widgets mit einem Wert wird der Wert in einem Array mit einem einzigen Element präsentiert. Bei mehrwertigen Widgets wie Kästchengruppen werden alle Werte in einer Liste angezeigt.

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

eventObject.parameters object
Verworfen. Eine Zuordnung aller zusätzlichen Parameter, die Sie Action mithilfe von Action.setParameters() zur Verfügung stellen. Die Schlüssel und Werte der Zuordnung sind Strings.

Informationen zu Google Workspace-Add-ons finden Sie im Feld eventObject.commonEventObject.parameters.

eventObject.userCountry string
Standardmäßig eingestellt und 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.

Informationen zu Google Workspace-Add-ons finden Sie im Feld eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Standardmäßig eingestellt und deaktiviert. Der aus zwei Buchstaben bestehende ISO 639-Code, der die Sprache des Nutzers angibt. Weitere Informationen finden Sie unter Nutzersprache und Zeitzone.

Informationen zu Google Workspace-Add-ons finden Sie im Feld eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Standardmäßig eingestellt und deaktiviert. Die Zeitzonenkennung der Zeitzone des Nutzers. Beispiele: America/New_York, Europe/Vienna und Asia/Seoul. Weitere Informationen finden Sie unter Nutzersprache und Zeitzone abrufen.

Informationen zu Google Workspace-Add-ons finden Sie im Feld eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Standardmäßig eingestellt und deaktiviert. Die Zeitabweichung von der koordinierten Weltzeit (UTC) der Zeitzone des Nutzers, gemessen in Millisekunden. Weitere Informationen finden Sie unter Nutzersprache und Zeitzone abrufen.

Informationen zu Google Workspace-Add-ons finden Sie im Feld eventObject.commonEventObject.timeZone.offset.

Gemeinsames Ereignisobjekt

Das allgemeine Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der allgemeine, hostunabhängige Informationen zum Add-on vom Nutzer-Client enthält. Dazu gehören z. B. die Sprache des Nutzers, die Host-App und die Plattform.

Neben Startseiten- und kontextbezogenen Triggern werden Add-ons erstellt und übergeben Ereignisobjekte an Aktions-Callback-Funktionen, wenn der Nutzer mit Widgets interagiert. Mit der Callback-Funktion des Add-ons kann das allgemeine Ereignisobjekt abgefragt werden, um den Inhalt der geöffneten Widgets im Client des Nutzers zu ermitteln. Mit diesem Add-on kann beispielsweise der Text, den ein Nutzer in ein TextInput-Widget im eventObject.commentEventObject.formInputs-Objekt eingegeben hat, gesucht werden.

Häufig verwendete Felder für Ereignisobjekte
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 Kartenschlüssel sind die String-IDs, die jedem Widget zugewiesen sind.

Die Struktur des Map-Wertobjekts hängt vom Widgettyp ab:

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

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

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

    Beispiel: Öffnen Sie bei einem mehrwertigen Widget mit participants als ID auf das Wert-Array mit: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

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

  • A date-only picker: DateInput object.

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

  • A time-only picker: TimeInput object.

    Beispiel: Bei einer Auswahl mit der ID myTimePicker greifen Sie über e.commonEventObject.formInputs.myTimePicker.timeInput auf das Objekt TimeInput zu.
commonEventObject.hostApp string
Gibt an, dass die Host-App aktiv ist, wenn das Ereignisobjekt generiert wird. Mögliche Werte:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Zusätzliche Parameter, die Sie mit Action.setParameters() an Action übergeben.
commonEventObject.userLocale string
Standardmäßig deaktiviert. Die Sprach- und Länder-/Regions-ID des Nutzers im Format des ISO 639- oder des ISO 3166-Länder-/Regionscodes. Beispiel: en-US.

Wenn Sie dieses Feld aktivieren möchten, müssen Sie addOns.common.useLocaleFromApp im Manifest Ihres Add-ons auf true setzen. Die Liste des Umfangs Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Nutzersprache und Zeitzone abrufen.

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

Eingaben für die Datums-/Uhrzeitauswahl

Aktions-Callback-Funktionen können aktuelle Widget-Werte im Feld commonEventObject.formInputs erhalten. Dazu gehören auch die vom Nutzer ausgewählten Datums- oder Uhrzeitwerte in den Datums- oder Zeitauswahl-Widgets. Die Struktur der Informationen hängt jedoch davon ab, ob das Widget als Datums-/Uhrzeitauswahl oder Nur-Uhrzeit-Auswahl konfiguriert wurde. Die strukturellen Unterschiede sind in der folgenden Tabelle beschrieben:

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

Kalenderterminobjekt

Das Kalenderereignisobjekt ist der Teil des Gesamtterminobjekts, in dem Informationen zu den Kalender- und Kalenderterminen eines Nutzers enthalten sind. Sie ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Kalender verwendet.

In der folgenden Tabelle sind die Felder im Feld calendarEventObject eines Ereignisobjekts aufgeführt. Felder, die als Nutzergenerierte Daten gekennzeichnet sind, sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalenderereignis vorhanden sind, und das Feld addOns.calendar.currentEventAccess Manifest des Add-ons auf READ oder READ_WRITE festgelegt wird.

Kalenderterminobjekt
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, mit dem die Funktionen des Add-ons beschrieben werden, um Ereignisinformationen anzusehen oder zu aktualisieren.
calendar.capabilities.canAddAttendees boolean
Von Nutzern erstellte Daten: true, wenn das Add-on der Teilnehmerliste neue Teilnehmer 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 Konferenzkonferenzdaten lesen kann. Andernfalls false.
calendar.capabilities.canSetConferenceData boolean
Von Nutzern erstellte Daten: true, wenn das Add-on die Konferenzkonferenzdaten 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 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 des Ereignisses darstellt.
calendar.organizer.email string
E-Mail-Adresse des Organisators
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 sein addOns.calendar.currentEventAccess Manifest auf READ oder READ_WRITE setzt.

Teilnehmerobjekt
attendee.additionalGuests number
Die Anzahl der zusätzlichen Gäste, die der Gast angegeben hat. Der Standardwert ist null.
attendee.comment string
gegebenenfalls der Antwortkommentar der Teilnehmer.
attendee.displayName string
Der angezeigte Name des Teilnehmers.
attendee.email string
E-Mail-Adresse des Teilnehmers
attendee.optional boolean
true, wenn die Teilnahme an diesem Teilnehmer als optional gekennzeichnet ist, andernfalls false.
attendee.organizer boolean
true, wenn der Teilnehmer ein Organisator für diese Veranstaltung ist.
attendee.resource boolean
true, wenn der Teilnehmer eine Ressource darstellt, z. B. einen Raum oder ein Gerät, andernfalls false.
attendee.responseStatus string
Antwortstatus des Teilnehmers Mögliche Werte:
  • accepted: Der Teilnehmer hat die Einladung zur Veranstaltung angenommen.
  • declined: Der Teilnehmer hat die Einladung abgelehnt.
  • needsAction: Der Teilnehmer hat nicht auf die Veranstaltungseinladung geantwortet.
  • tentative: Der Teilnehmer hat vorläufig die Einladung zur Veranstaltung angenommen.
attendee.self boolean
true, wenn dieser Teilnehmer den Kalender repräsentiert, in dem dieser Termin angezeigt wird; andernfalls false.

Konferenzdaten

Konferenzdatenobjekte enthalten Informationen zu Konferenzen, die mit Google Kalender-Terminen verknüpft sind. Das 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 Kalenderereignis vorhanden sind und das Add-on addOns.calendar.currentEventAccess das Manifest auf READ oder READ_WRITE setzt.

Konferenzdatenobjekt
conferenceData.conferenceId string
ID der Konferenz Diese ID soll es Anwendungen ermöglichen, Konferenzen im Auge zu behalten. Sie sollten Nutzern diese ID nicht anzeigen.
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 dieser Konferenzlösung.
conferenceData.conferenceSolution.key object
Schlüssel, der die Konferenzlösung für dieses Ereignis eindeutig identifiziert.
conferenceData.conferenceSolution.key.type string
Der Konferenzlösungstyp. Mögliche Werte:
  • eventHangout für Hangouts für Privatnutzer (http://hangouts.google.com).
  • eventNamedHangout für Nutzer des klassischen Hangouts für Google Workspace (http://hangouts.google.com).
  • hangoutsMeet für Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Der für Nutzer sichtbare Name dieser Konferenzlösung (nicht lokalisiert).
conferenceData.entryPoints[] list of entry point objects
Die Liste der Einstiegspunkte der Konferenz, z. B. URLs oder Telefonnummern.
conferenceData.notes string
Zusätzliche Hinweise (z. B. die Anleitung 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 definierter Parameter, die vom Add-on verwendet werden können.
conferenceData.parameters.addOnParameters object
Eine Zuordnung von Parameterstring-Schlüsseln und -Werten. Diese Schlüssel und Werte werden vom Add-on-Entwickler definiert, um Informationen an eine bestimmte Konferenz anzuhängen, damit das Add-on verwendet werden kann.

Einstiegspunkt

Einstiegsobjekte enthalten Informationen zu den festgelegten 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 Kalenderereignis vorhanden sind und das Add-on das Feld addOns.calendar.currentEventAccess manifest auf READ oder READ_WRITE setzt.

Einstiegspunktobjekt
entryPoint.accessCode string
Der Zugriffscode, der für den Zugriff auf die Konferenz verwendet wird. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden normalerweise nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Zuordnung der Felder, die der Konferenzanbieter verwendet, und nur angezeigt werden.
entryPoint.entryPointFeatures list
Eigenschaften des Einstiegspunkts. Derzeit gelten diese Features nur für phone-Einstiegspunkte:
  • toll: Der Einstiegspunkt ist eine Mautgebühr.
  • toll_free: Der Einstiegspunkt ist ein gebührenfreies Telefonat.
entryPoint.entryPointType string
Die Art des Einstiegspunkts. Mögliche Werte sind:
  • more: Weitere Anweisungen zur Teilnahme an einer Konferenz, z. B. eine alternative Telefonnummer Eine Konferenz kann nur einen more-Einstiegspunkt haben. Wenn vorhanden, ist auch mindestens ein anderer Typ von Einstiegspunkt erforderlich.
  • phone: Nehmen Sie über eine Telefonnummer an der Konferenz teil. Eine Konferenz kann null oder mehr phone-Einstiegspunkte haben. In Google Kalender werden nur die ersten zwei Telefoneinstiegspunkte angezeigt, nachdem sie alphabetisch formatiert und sortiert wurden.
  • sip: Nehmen Sie über SIP an der Konferenz teil. Eine Konferenz darf höchstens einen sip-Einstiegspunkt haben.
  • video: Nehmen Sie über HTTP an der Konferenz teil. Eine Konferenz darf 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 den Zugriff auf die Konferenz. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden normalerweise nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Zuordnung der Felder, die der Konferenzanbieter verwendet, und nur angezeigt werden.
entryPoint.passcode string
Der Sicherheitscode, der für den Zugriff auf die Konferenz verwendet wurde. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden normalerweise nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Zuordnung der Felder, die der Konferenzanbieter verwendet, und nur angezeigt werden.
entryPoint.password string
Das Passwort, mit dem Sie auf die Konferenz zugreifen. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden normalerweise nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Zuordnung der Felder, die der Konferenzanbieter verwendet, und nur angezeigt werden.
entryPoint.pin string
Die PIN, mit der Sie auf die Konferenz zugreifen. Die maximale Länge beträgt 128 Zeichen. Konferenzanbieter verwenden normalerweise nur einen Teil von {accessCode, meetingCode, passcode, password, pin}, um Zugriff auf Konferenzen zu gewähren. Zuordnung der Felder, die der Konferenzanbieter verwendet, und nur angezeigt werden.
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 Einstiegspunkttyp 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@myprovider.com“.
  • video: Ein http:- oder https:-Schema ist erforderlich.

Drive-Ereignisobjekt

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

Drive-Ereignisobjekt
drive.activeCursorItem Drive item object
Das derzeit verwendete Drive-Element.
drive.selectedItems[] list of Drive item objects
Eine Liste der Elemente (Dateien oder Ordner), die in Google Drive ausgewählt wurden.

Drive-Element

Drive-Elementobjekte enthalten Informationen zu bestimmten Drive-Elementen wie Dateien oder Ordnern.

Drive-Elementobjekt
item.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Bereich https://www.googleapis.com/auth/drive.file dieses Elements angefordert und erhalten. Andernfalls ist das Feld false.
item.id string
Die ID des ausgewählten Elements.
item.iconUrl string
Die URL des Symbols, das für das ausgewählte Element steht.
item.mimeType string
Der MIME-Typ des ausgewählten Elements.
item.title string
Titel des ausgewählten Elements

Gmail-Ereignisobjekt

Das Gmail-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, das Informationen zu den Gmail-Nachrichten eines Nutzers enthält. Sie 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übergehend Zugriff auf die derzeit geöffnete Gmail-Nachricht eines Nutzers zu gewähren oder es dem Tool zu ermöglichen, neue Entwürfe zu erstellen.
gmail.bccRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der E-Mail-Adressen der „BCC:“-Empfänger, die derzeit in einem Entwurf erstellt wird, den das Add-on 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 erstellt wird, den das Add-on erstellt. 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 aktuell geöffnete Gmail-Thread-ID.
gmail.toRecipients[] list of strings
Standardmäßig deaktiviert. Die Liste der E-Mail-Adressen der Empfänger in der ersten Version des Entwurfs. 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 Google Docs-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, das Informationen über das Dokument und den Inhalt eines Nutzers enthält. Sie ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Docs ist.

Google Docs-Ereignisobjekt
docs.id string
Nur vorhanden, wenn der https://www.googleapis.com/auth/drive.file-Bereich vom Nutzer autorisiert wurde.
Die ID des Dokuments, das in der Benutzeroberfläche von Google Docs geöffnet wird.
docs.title string
Nur vorhanden, wenn der https://www.googleapis.com/auth/drive.file-Bereich vom Nutzer autorisiert wurde.
Der Titel des Dokuments wird in der Benutzeroberfläche von Google Docs geöffnet.
docs.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Bereich https://www.googleapis.com/auth/drive.file für das in der Docs-Benutzeroberfläche geöffnete Dokument angefordert und erhalten. Andernfalls ist das 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 entspricht dem Hostmuster, das im LinkPreviewTriggers-Trigger angegeben ist.

Die URL des Links, der eine Vorschau in Google Docs generiert. Wenn Sie dieses Feld verwenden möchten, müssen Sie LinkPreviewTriggers im Manifest Ihres Add-ons konfigurieren. Weitere Informationen

Beispiel für eine Nutzlast, wenn ein Nutzer eine Vorschau des Links https://www.example.com/12345 sieht: 

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

Google Tabellen-Ereignisobjekt

Das Tabellenereignisobjekt ist der Teil des gesamten Ereignisobjekts, das Informationen über das Dokument und den Inhalt eines Nutzers 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 https://www.googleapis.com/auth/drive.file-Bereich vom Nutzer autorisiert wurde. Die ID der in der Google Tabellen-Benutzeroberfläche geöffneten Tabelle
sheets.title string
Nur vorhanden, wenn der https://www.googleapis.com/auth/drive.file-Bereich vom Nutzer autorisiert wurde. Der Titel der Tabelle, die in der Google Tabellen-Benutzeroberfläche geöffnet wird.
sheets.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung für den Bereich https://www.googleapis.com/auth/drive.file für die in der Tabellen-Benutzeroberfläche geöffnete Tabelle angefordert und erhalten. Ansonsten ist das Feld false.

Google Präsentationen-Ereignisobjekt

Das Google Präsentationen-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, das Informationen über das Dokument und den Inhalt eines Nutzers enthält. Sie ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Präsentationen ist.

Google Präsentationen-Ereignisobjekt
slides.id string
Nur vorhanden, wenn der https://www.googleapis.com/auth/drive.file-Bereich vom Nutzer autorisiert wurde. Die ID der Präsentation, die in der Google Präsentationen-Benutzeroberfläche geöffnet wird
slides.title string
Nur vorhanden, wenn der https://www.googleapis.com/auth/drive.file-Bereich vom Nutzer autorisiert wurde. Der Titel der Präsentation wird in der Google Präsentationen-Benutzeroberfläche geöffnet.
slides.addonHasFileScopePermission boolean
Wenn true, hat das Add-on die Autorisierung im Bereich https://www.googleapis.com/auth/drive.file für die in der Präsentationen-Benutzeroberfläche geöffnete Präsentation angefordert und erhalten. Andernfalls ist das Feld false.