EventObject

EventObject

Ein Interaktionsereignis für ein Google-Add-on, das Daten zur Interaktion eines Nutzers mit einem Add-on in einer Host-App enthält.

Das Ereignisobjekt wird als JSON an die Callback-Funktion oder den Trigger eines Add-ons (für Apps Script) oder an den https-Endpunkt (für HTTP) übergeben, wenn ein Nutzer in einer Host-App mit einem Add-on interagiert. Das Ereignisobjekt speichert ein von jeder Host-App definiertes Host-App-Ereignisobjekt sowie ein allgemeines Ereignisobjekt, das einige allgemeine Felder im Zusammenhang mit dem Ereignis enthält.

Weitere Informationen finden Sie unter Ereignisobjekte.

JSON-Darstellung
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
Felder
commonEventObject

object (CommonEventObject)

Ein Objekt, das Informationen enthält, die für alle Eventobjekte unabhängig von der gehosteten Anwendung gelten.

authorizationEventObject

object (AuthorizationEventObject)

Wird nur für Anfragen an HTTP-Endpunkte festgelegt

Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
calendar

object (CalendarEventObject)

Nur vorhanden, wenn der aufrufende Host Google Kalender ist. Ein Objekt mit Kalender- und Termininformationen.

drive

object (DriveEventObject)

Wird nur angezeigt, wenn der aufrufende Host Google Drive ist. Ein Objekt mit Drive-Informationen.

gmail

object (GmailEventObject)

Wird nur angezeigt, wenn der aufrufende Host Gmail ist. Ein Objekt mit Gmail-Informationen.

sheets

object (SheetsEventObject)

Nur vorhanden, wenn der aufrufende Host Google Sheets ist. Ein Objekt mit Informationen zu Google Sheets.

slides

object (SlidesEventObject)

Wird nur angezeigt, wenn der aufrufende Host Google Präsentationen ist. Ein Objekt mit Informationen zu Präsentationen.

docs

object (DocsEventObject)

Nur vorhanden, wenn der aufrufende Host Google Docs ist. Ein Objekt mit Informationen zu Google Docs.

chat

object (ChatEventObject)

Nur vorhanden, wenn der aufrufende Host Google Chat ist. Ein Objekt mit Chat-Informationen.

workflow

object (WorkflowEventObject)

Nur vorhanden, wenn der aufrufende Host Google Workspace Studio ist. Ein Objekt mit Workflow-Informationen.

Ende der sich gegenseitig ausschließenden Felder.

CommonEventObject

Das allgemeine 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 die Sprache, die Host-App und die Plattform des Nutzers.

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

Bei Chat-Apps der Name der Funktion, die der Nutzer bei der Interaktion mit einem Widget aufgerufen hat.

JSON-Darstellung
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Felder
userLocale

string

Standardmäßig deaktiviert. Die Kennung für die Sprache und das Land bzw. die Region des Nutzers im Format ISO 639-Sprachcode-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 setzen. Die Bereichsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.

hostApp

enum (HostApp)

Gibt die Host-App an, in der das Add-on aktiv ist, wenn das Ereignisobjekt generiert wird. Mögliche Werte:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

Das Plattform-Enum, das die Plattform angibt, von der das Ereignis stammt (WEB, IOS oder ANDROID). Wird von Chat-Apps nicht unterstützt.

timeZone

object (TimeZone)

Standardmäßig deaktiviert. Die Zeitzonen-ID und der Zeitversatz gegenüber der koordinierten Weltzeit (UTC). Wenn Sie dieses Feld aktivieren möchten, müssen Sie im Manifest Ihres Add-ons addOns.common.useLocaleFromApp auf true setzen. Die Bereichsliste Ihres Add-ons muss auch https://www.googleapis.com/auth/script.locale enthalten. Weitere Informationen finden Sie unter Auf Sprache und Zeitzone des Nutzers zugreifen.

Wird nur für die Ereignistypen CARD_CLICKED und SUBMIT_DIALOG unterstützt.

formInputs

map (key: string, value: object (Inputs))

Eine Zuordnung, die die aktuellen Werte der Widgets auf der angezeigten Karte enthält. Die Kartenschlüssel sind die Stringwerte name, die jedem Eingabe-Widget zugewiesen sind (z. B. TextInput.name, SelectionInput.name, DateTimePicker.name oder DecoratedText.SwitchControl.name).

Die Struktur des Zuordnungswertobjekts hängt vom Widget-Typ ab:

Hinweis: Die folgenden Beispiele sind für die V8-Laufzeitumgebung von Apps Script formatiert. Wenn Sie die Rhino-Laufzeit verwenden, müssen Sie [""] nach dem Wert hinzufügen. Formatieren Sie das Ereignisobjekt beispielsweise als e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0] statt als e.commonEventObject.formInputs.employeeName.stringInputs.value[0]. Weitere Informationen zu Laufzeiten in Apps Script finden Sie in der Übersicht über die V8-Laufzeit.

  • Widgets mit einem einzelnen Wert (z. B. ein TextInput-Widget oder ein SelectionInput-Widget vom Typ DROPDOWN oder RADIO_BUTTON): ein StringInputs-Objekt, das eine Liste mit einem einzelnen Element enthält (oder eine leere Liste, wenn keine Auswahl getroffen wurde).

Beispiel: Für ein Texteingabe-Widget mit employeeName als name greifen Sie mit e.commonEventObject.formInputs.employeeName.stringInputs.value[0] auf den Texteingabewert zu.

  • Widgets mit mehreren Werten (z. B. ein SelectionInput-Widget vom Typ CHECK_BOX, SWITCH oder MULTI_SELECT): ein StringInputs-Objekt, das die Liste der ausgewählten value-Strings enthält.

Beispiel: Bei einem Widget mit mehreren Werten und participants als name können Sie mit e.commonEventObject.formInputs.participants.stringInputs.value auf das Wert-Array zugreifen.

  • Ein DecoratedText.SwitchControl-Widget: ein StringInputs-Objekt. Wenn selected den Wert true hat, enthält stringInputs.value das Feld value des Schalters (oder "", wenn value nicht angegeben wurde; wenn mehrere Schalter denselben name haben, wird das Feld value jedes ausgewählten Schalters in die Liste aufgenommen). Wenn selected false ist, wird die value des Switches in stringInputs.value weggelassen.

  • Datum/Uhrzeit-Auswahl (DateTimePickerType.DATE_AND_TIME): ein DateTimeInput object.

Beispiel: Bei einer Auswahl mit einem name von myDTPicker greifen Sie mit e.commonEventObject.formInputs.myDTPicker.dateTimeInput auf das Objekt DateTimeInput zu.

Beispiel: Bei einer Auswahl mit einem name von myDatePicker greifen Sie mit e.commonEventObject.formInputs.myDatePicker.dateInput auf das Objekt DateInput zu.

Beispiel: Bei einer Auswahl mit einem name von myTimePicker greifen Sie mit e.commonEventObject.formInputs.myTimePicker.timeInput auf das Objekt TimeInput zu.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

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 den Wert des Schlüssels "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]) verwenden, um Elemente basierend auf den Eingaben der Nutzer in Menüs mit Mehrfachauswahl vorzuschlagen. 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 erfassen und verarbeiten.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Name der aufzurufenden Funktion.

Dieses Feld wird für Google Workspace-Add‑ons, die Google Chat erweitern, nicht ausgefüllt. Stattdessen sollten Add-ons, die Google Chat erweitern, das Feld parameters verwenden, um Funktionsdaten wie IDs zu erhalten. Weitere Informationen finden Sie unter Interaktive Oberflächen für Chat-Apps erstellen.

HostApp

Die Google Workspace-Anwendung für ein Google Workspace-Add-on oder eine Google Chat-App.

Bei Add-ons die Workspace-Anwendung, über die ein Google Workspace-Add-on gestartet wird. Bei Chat-Apps ist die Host-App immer CHAT.

Enums
UNSPECIFIED_HOST_APP Google kann keine Host-App identifizieren.
GMAIL Das Add-on wird über Gmail gestartet.
CALENDAR Das Add-on wird über Google Kalender gestartet.
DRIVE Das Add-on wird über Google Drive gestartet.
DEMO Nicht verwendet.
DOCS Das Add-on wird über Google Docs gestartet.
MEET Das Add-on wird über Google Meet gestartet.
SHEETS Das Add-on wird über Google Sheets gestartet.
SLIDES Das Add-on wird über Google Präsentationen gestartet.
DRAWINGS Das Add-on wird über Google Zeichnungen gestartet.
CHAT Eine Google Chat-App.

Plattform

Gibt an, von welcher Plattform dieser Aufruf stammt.

Enums
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

Die Zeitzonen-ID und der Zeitversatz gegenüber der koordinierten Weltzeit (UTC). Wird nur für die Ereignistypen CARD_CLICKED und SUBMIT_DIALOG unterstützt.

JSON-Darstellung
{
  "id": string,
  "offset": integer
}
Felder
id

string

Der Zeitzonencode der IANA-Zeitzonendatenbank, z. B. „America/Toronto“.

offset

integer

Die Abweichung der Zeitzone des Nutzers von der koordinierten Weltzeit (UTC) in Millisekunden.

Eingaben

Datentypen, die Nutzer auf Karten oder in Dialogfeldern eingeben können. Der Eingabetyp hängt von der Art der Werte ab, die das Widget akzeptiert.

JSON-Darstellung
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
Felder
Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
stringInputs

object (StringInputs)

Eine Liste von Strings, die die Werte darstellen, die der Nutzer in ein Widget eingibt.

Wenn das Widget nur einen Wert akzeptiert, z. B. ein TextInput-Widget, enthält die Liste ein Stringobjekt. Wenn das Widget mehrere Werte akzeptiert, z. B. ein SelectionInput-Widget mit Kästchen, enthält die Liste ein Stringobjekt für jeden Wert, den der Nutzer eingibt oder auswählt.

dateTimeInput

object (DateTimeInput)

Datums- und Uhrzeit-Eingabewerte aus einem DateTimePicker-Widget, das sowohl ein Datum als auch eine Uhrzeit akzeptiert.

dateInput

object (DateInput)

Datumseingabewerte aus einem DateTimePicker-Widget, das nur Datumswerte akzeptiert.

timeInput

object (TimeInput)

Zeiteingabewerte aus einem DateTimePicker-Widget, das nur Zeitwerte akzeptiert.

Ende der sich gegenseitig ausschließenden Felder.

StringInputs

Eingabeparameter für reguläre Widgets. Bei Widgets mit einem einzelnen Wert ist es eine Liste mit einem einzelnen Wert. Bei Widgets mit mehreren Werten, z. B. Kästchen, werden alle Werte angezeigt.

JSON-Darstellung
{
  "value": [
    string
  ]
}
Felder
value[]

string

Eine Liste von Strings, die vom Nutzer eingegeben wurden.

DateTimeInput

Eingabewerte für Datum und Uhrzeit.

JSON-Darstellung
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Felder
msSinceEpoch

string (int64 format)

Zeit seit der Epoche in Millisekunden.

hasDate

boolean

Gibt an, ob die Eingabe datetime ein Kalenderdatum enthält.

hasTime

boolean

Gibt an, ob die datetime-Eingabe einen Zeitstempel enthält.

DateInput

Datumseingabewerte.

JSON-Darstellung
{
  "msSinceEpoch": string
}
Felder
msSinceEpoch

string (int64 format)

Zeit seit der Epoche in Millisekunden.

TimeInput

Eingabewerte für die Zeit.

JSON-Darstellung
{
  "hours": integer,
  "minutes": integer
}
Felder
hours

integer

Die Stunde im 24-Stunden-Format.

minutes

integer

Die Anzahl der Minuten nach der vollen Stunde. Gültige Werte sind 0 bis 59.

AuthorizationEventObject

Kapselt Autorisierungsinformationen für die Add-on-Anfrage

JSON-Darstellung
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
Felder
userOAuthToken

string

Das OAuth-Zugriffstoken des Endnutzers, das mit den angeforderten Bereichen autorisiert wurde. (Nach der Entbündelung der OAuth-Einwilligung wird dies mit den vom Endnutzer autorisierten Bereichen autorisiert.)

userIdToken

string

Ein Endnutzer-ID-Token, wenn entsprechende ID-Bereiche angefordert werden

systemIdToken

string

Ein ID-Token für das G Suite-Add-ons-Dienstkonto für diese Bereitstellung

authorizedScopes[]

string

Liste der vom Nutzer autorisierten OAuth-Bereiche.

CalendarEventObject

Das Kalenderterminobjekt ist der Teil des gesamten Terminobjekts, 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 im Feld calendar eines Ereignisobjekts aufgeführt. Felder, die als Von Nutzern generierte Daten gekennzeichnet sind, sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalendertermin vorhanden sind und das Add-on das Feld addOns.calendar.currentEventAccess im Manifest auf READ oder READ_WRITE setzt.

JSON-Darstellung
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Felder
id

string

Die Ereignis-ID.

recurringEventId

string

Die ID eines wiederkehrenden Termins.

calendarId

string

Die Kalender-ID.

organizer

object (Organizer)

Ein Objekt, das den Organisator der Veranstaltung darstellt.

attendees[]

object (Attendee)

Von Nutzern erstellte Daten. Eine Liste der Teilnehmer des Kalendertermins.

conferenceData

object (ConferenceData)

Von Nutzern erstellte Daten. Ein Objekt, das alle mit diesem Termin verknüpften Konferenzdaten darstellt, z. B. Details zu Google Meet-Konferenzen.

capabilities

object (Capabilities)

Von Nutzern erstellte Daten. Ein Objekt, das die Funktionen des Add-ons zum Aufrufen oder Aktualisieren von Termininformationen beschreibt.

Veranstalter

JSON-Darstellung
{
  "email": string
}
Felder
email

string

Die E‑Mail-Adresse des Organisators des Termins.

Teilnehmer

Attendee-Objekte enthalten Informationen zu einzelnen Teilnehmern von Google Kalender-Terminen. Diese Informationen sind nur dann im Ereignisobjekt vorhanden, wenn die Daten im Kalendertermin vorhanden sind und das Add-on das Manifestfeld addOns.calendar.currentEventAccess auf READ oder READ_WRITE setzt.

JSON-Darstellung
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
Felder
email

string

Die E‑Mail-Adresse des Teilnehmers.

displayName

string

Der Anzeigename des Teilnehmers.

organizer

boolean

true, wenn der Teilnehmer ein Organisator dieses Termins ist.

self

boolean

true, wenn dieser Teilnehmer den Kalender darstellt, in dem dieser Termin angezeigt wird; andernfalls false.

resource

boolean

true, wenn der Teilnehmer eine Ressource wie einen Raum oder ein Gerät darstellt, andernfalls false.

optional

boolean

true, wenn die Teilnahme für diesen Teilnehmer als optional markiert ist, andernfalls false.

responseStatus

string

Der Antwortstatus des Teilnehmers. Mögliche Werte:

  • accepted: Der Teilnehmer hat die Einladung zum Termin angenommen.
  • declined: Der Teilnehmer hat die Einladung zum Termin abgelehnt.
  • needsAction: Der Teilnehmer hat nicht auf die Termineinladung geantwortet.
  • tentative: Der Teilnehmer hat die Termineinladung vorläufig angenommen.
comment

string

Der Antwortkommentar des Teilnehmers, falls vorhanden.

additionalGuests

integer

Die Anzahl der zusätzlichen Gäste, die der Teilnehmer mitbringt. Der Standardwert ist null.

ConferenceData

Konferenzdatenobjekte enthalten Informationen zu Konferenzen, die an Google Kalender-Termine angehängt 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 Kalendertermin vorhanden sind und das Add-on das Manifestfeld addOns.calendar.currentEventAccess auf READ oder READ_WRITE setzt.

JSON-Darstellung
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Felder
conferenceId

string

Die ID der Konferenz. Diese ID soll es Anwendungen ermöglichen, Konferenzen im Blick zu behalten. Sie sollten diese ID nicht für Nutzer anzeigen.

conferenceSolution

object (ConferenceSolution)

Ein Objekt, das die Konferenzlösung darstellt, z. B. Hangouts oder Google Meet.

entryPoints[]

object (EntryPoint)

Die Liste der Konferenzeinstiegspunkte, z. B. URLs oder Telefonnummern.

notes

string

Zusätzliche Hinweise zur Konferenz, die dem Nutzer angezeigt werden sollen, z. B. Anweisungen des Domainadministrators oder rechtliche Hinweise. Kann HTML enthalten. Die maximale Länge beträgt 2.048 Zeichen.

parameters

object (Parameters)

Ein Objekt, das eine Zuordnung definierter Parameterdaten zur Verwendung durch das Add-on enthält.

ConferenceSolution

JSON-Darstellung
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
Felder
iconUri

string

Der URI für das für Nutzer sichtbare Symbol, das diese Konferenzlösung darstellt.

key

object (Key)

Der Schlüssel, der die Konferenzlösung für diesen Termin eindeutig identifiziert.

name

string

Der für den Nutzer sichtbare Name dieser Konferenzlösung (nicht lokalisiert).

Schlüssel

JSON-Darstellung
{
  "type": string
}
Felder
type

string

Der Typ der Konferenzlösung. Mögliche Werte:

EntryPoint

Einstiegspunktobjekte enthalten Informationen zu den eingerichteten Zugriffsmöglichkeiten für 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 Manifestfeld addOns.calendar.currentEventAccess auf READ oder READ_WRITE setzt.

JSON-Darstellung
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
Felder
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. Es werden nur die Felder angezeigt, die der Konferenzanbieter verwendet.

entryPointType

string

Der Typ des Einstiegspunkts. Folgende Werte sind möglich:

  • more: Zusätzliche Anweisungen für die Teilnahme an der Konferenz, z. B. alternative Telefonnummern. Eine Videokonferenz kann nur einen more-Einstiegspunkt haben. Wenn ein solcher vorhanden ist, ist mindestens ein weiterer Einstiegspunkt erforderlich.
  • phone: Nehmen Sie über eine Telefonnummer an der Konferenz teil. Eine Konferenz kann null oder mehr Telefon-Einstiegspunkte haben. In Google Kalender werden nur die ersten beiden Telefonnummern angezeigt, nachdem sie formatiert und alphabetisch sortiert wurden.
  • sip: Über SIP an der Konferenz teilnehmen. Eine Konferenz kann höchstens einen sip-Einstiegspunkt haben.
  • video: Nehmen Sie über HTTP an der Konferenz teil. Eine Konferenz kann höchstens einen Videoeinstiegspunkt haben.
label

string

Das für den Nutzer sichtbare Label für den Einstiegspunkt-URI (nicht lokalisiert).

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. Es werden nur die Felder angezeigt, die der Konferenzanbieter verwendet.

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. Es werden nur die Felder angezeigt, die der Konferenzanbieter verwendet.

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. Es werden nur die Felder angezeigt, die der Konferenzanbieter verwendet.

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. Es werden nur die Felder angezeigt, die der Konferenzanbieter verwendet.

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@myprovider.com“.
  • video: Ein http:- oder https:-Schema ist erforderlich.
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 Regionalcodes.

entryPointFeatures[]

string

Features des Einstiegspunkts. Derzeit gelten diese Funktionen nur für Einstiegspunkte für Telefonnummern:

  • toll: Der Einstiegspunkt ist ein gebührenpflichtiger Telefonanruf.
  • toll_free: Der Einstiegspunkt ist ein gebührenfreier Anruf.

Parameter

JSON-Darstellung
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Felder
addOnParameters

object (AddOnParameters)

Eine Zuordnung von Parameter-Stringschlüsseln und -werten. Diese Schlüssel und Werte werden vom Entwickler des Add-ons definiert, um Informationen an eine bestimmte Konferenz anzuhängen, die vom Add-on verwendet werden sollen.

AddOnParameters

JSON-Darstellung
{
  "parameters": {
    string: string,
    ...
  }
}
Felder
parameters

map (key: string, value: string)

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Leistungsspektrum

JSON-Darstellung
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Felder
canSeeAttendees

boolean

Nutzergenerierte Daten: true, wenn das Add-on die Teilnehmerliste des Termins lesen kann, andernfalls false.

canAddAttendees

boolean

User-generated data: true, wenn das Add-on der Teilnehmerliste des Termins neue Teilnehmer hinzufügen kann; andernfalls false.

canSeeConferenceData

boolean

Nutzergenerierte Daten: true, wenn das Add-on die Konferenzdaten des Termins lesen kann; andernfalls false.

canSetConferenceData

boolean

User-generated data: true, wenn das Add-on die Konferenzdaten des Termins aktualisieren kann; andernfalls false.

canAddAttachments

boolean

User-generated data: true, wenn das Add-on dem Termin neue Anhänge hinzufügen kann; andernfalls false.

DriveEventObject

Das Drive-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Google Drive eines Nutzers und dessen Inhalten enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn die Hostanwendung Google Drive ist.

JSON-Darstellung
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Felder
selectedItems[]

object (DriveItemMetadata)

Eine Liste der in Drive ausgewählten Elemente (Dateien oder Ordner).

activeCursorItem

object (DriveItemMetadata)

Das Drive-Element, das derzeit aktiv ist.

DriveItemMetadata

Drive-Elementobjekte enthalten Informationen zu bestimmten Drive-Elementen, z. B. Dateien oder Ordnern.

JSON-Darstellung
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
Felder
id

string

Die ID des ausgewählten Elements.

iconUrl

string

Die URL des Symbols, das das ausgewählte Element darstellt.

mimeType

string

Der MIME-Typ des ausgewählten Elements.

title

string

Der Titel des ausgewählten Elements.

addonHasFileScopePermission

boolean

Wenn true, hat das Add-on die Bereichsautorisierung https://www.googleapis.com/auth/drive.file für dieses Element angefordert und erhalten. Andernfalls ist dieses Feld false.

Wenn das Add-on einen weniger restriktiven Bereich wie https://www.googleapis.com/auth/drive oder https://www.googleapis.com/auth/drive.readonly verwendet, ist dieses Feld nicht relevant. Verwenden Sie beim Entwerfen von Add-ons immer die am wenigsten restriktiven Bereiche, um Nutzerdaten zu schützen.

GmailEventObject

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.

JSON-Darstellung
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
Felder
messageId

string

Die ID der aktuell geöffneten Gmail-Nachricht.

threadId

string

Die ID des aktuell geöffneten Gmail-Threads.

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 aktuell geöffnete Gmail-Nachricht eines Nutzers zu gewähren oder um neue Entwürfe zu erstellen.

toRecipients[]

string

Standardmäßig deaktiviert. Die Liste der E‑Mail-Adressen der Empfänger im Feld „An:“, die derzeit in einem Entwurf enthalten sind, der vom Add‑on erstellt wird. Wenn Sie dieses Feld aktivieren möchten, müssen Sie das Feld addOns.gmail.composeTrigger.draftAccess in Ihrem Manifest auf METADATA setzen.

ccRecipients[]

string

Standardmäßig deaktiviert. Die Liste der „CC:“-Empfänger-E-Mail-Adressen, die derzeit in einem Entwurf enthalten sind, 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 setzen.

bccRecipients[]

string

Standardmäßig deaktiviert. Die Liste der „Bcc:“-Empfänger-E‑Mail-Adressen, die derzeit in einem Entwurf enthalten sind, 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 setzen.

SheetsEventObject

Das Google Sheets-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und dessen Inhalt enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Sheets erweitert.

JSON-Darstellung
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Felder
id

string

Nur vorhanden, wenn der Nutzer den Bereich https://www.googleapis.com/auth/drive.file autorisiert hat. Die ID der Tabelle, die in der Google Sheets-Benutzeroberfläche geöffnet ist.

title

string

Nur vorhanden, wenn der Nutzer den Bereich https://www.googleapis.com/auth/drive.file autorisiert hat. Der Titel der Tabelle, die in der Google Sheets-Benutzeroberfläche geöffnet ist.

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 Google Sheets-Benutzeroberfläche geöffnete Tabelle angefordert und erhalten. Andernfalls ist dieses Feld false.

matchedUrl

object (MatchedUrl)

Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:

  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL entspricht dem im Trigger LinkPreviewTriggers angegebenen Hostmuster.

Die URL des Links, für den in Google Sheets eine Vorschau 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 des Links https://www.example.com/12345 durch einen Nutzer:

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

MatchedUrl

Ereignisobjekt, das mit Anfragen zur Linkvorschau zurückgegeben wird.

JSON-Darstellung
{
  "url": string
}
Felder
url

string

Die URL, die übereinstimmt.

SlidesEventObject

Das Präsentationen-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und dessen Inhalt enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Präsentationen erweitert.

JSON-Darstellung
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Felder
id

string

Nur vorhanden, wenn der Nutzer den Bereich 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.

title

string

Nur vorhanden, wenn der Nutzer den Bereich 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.

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 Google Präsentationen-Benutzeroberfläche geöffnete Präsentation angefordert und erhalten. Andernfalls ist dieses Feld false.

matchedUrl

object (MatchedUrl)

Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:

  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL entspricht dem im Trigger LinkPreviewTriggers angegebenen Hostmuster.

Die URL des Links, der eine Vorschau in Google Präsentationen generiert. 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 des Links https://www.example.com/12345 durch einen Nutzer:

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

DocsEventObject

Das Docs-Ereignisobjekt ist der Teil des gesamten Ereignisobjekts, der Informationen zum Dokument eines Nutzers und dessen Inhalt enthält. Es ist nur in einem Ereignisobjekt vorhanden, wenn das Add-on Google Docs erweitert.

JSON-Darstellung
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Felder
id

string

Nur vorhanden, wenn der Nutzer den Bereich https://www.googleapis.com/auth/drive.file autorisiert hat. Die ID des Dokuments, das in der Docs-Benutzeroberfläche geöffnet ist.

title

string

Nur vorhanden, wenn der Nutzer den Bereich https://www.googleapis.com/auth/drive.file autorisiert hat. Der Titel des Dokuments, das in der Docs-Benutzeroberfläche geöffnet ist.

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 dieses Feld false.

matchedUrl

object (MatchedUrl)

Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:

  • https://www.googleapis.com/auth/workspace.linkpreview wurde vom Nutzer autorisiert.
  • Die URL entspricht dem im Trigger LinkPreviewTriggers angegebenen Hostmuster.

Die URL des Links, der eine Vorschau in Google Docs generiert. 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 des Links https://www.example.com/12345 durch einen Nutzer:

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

ChatEventObject

Die Nutzlast eines Google Chat-App-Ereignisobjekts, die vom Google-Server an Add-ons gesendet wird. Nutzlasten können verwendet werden, um den Ereignistyp zu identifizieren.

JSON-Darstellung
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
Felder
type

enum (EventType)

Der Typ des Ereignisses, der nur für App-Startseitenereignisse in Chat-Apps ausgefüllt wird, die keine Add-ons sind.

user

object (User)

Der Nutzer, der mit der Chat-App interagiert.

space

object (Space)

Der Gruppenbereich, in dem das Ereignis aufgetreten ist. Wird nur für App-Startseitenereignisse in Chat-Apps ausgefüllt, die keine Add-ons sind.

eventTime

string (Timestamp format)

Der Zeitstempel, der angibt, wann das Ereignisobjekt auftritt.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Die Nutzlast des Ereignisobjekts. Nutzlasten hängen vom Typ des Ereignisobjekts ab. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
messagePayload

object (MessagePayload)

Ein Nutzer sendet der Chat-App eine Nachricht oder erwähnt die Chat-App in einem Gruppenbereich mit @. Aufrufe von App-Befehlen (z. B. Slash-Befehle und Schnellbefehle) werden stattdessen in appCommandPayload übermittelt.

addedToSpacePayload

object (AddedToSpacePayload)

Ein Nutzer fügt die Chat-App einem Chatbereich hinzu oder ein Google Workspace-Administrator installiert die Chat-App in Bereichen für Direktnachrichten für Nutzer in seiner Organisation.

removedFromSpacePayload

object (RemovedFromSpacePayload)

Ein Nutzer entfernt die Chat-App aus einem Gruppenbereich.

buttonClickedPayload

object (ButtonClickedPayload)

Stellt Nutzlastdaten dar, wenn ein Nutzer mit einem interaktiven Element einer Karte oder eines Dialogfelds interagiert, das einen Action-Callback auslöst. Trotz des Namens wird diese Nutzlast für alle Action-Callbacks von Karten und Dialogfeldern ausgefüllt – nicht nur für Klicks auf Schaltflächen, sondern auch für onChangeAction-Trigger, onClick-Aktionen, CardAction-Klicks und das Senden oder Abbrechen von Dialogfeldern (SUBMIT_DIALOG und CANCEL_DIALOG).

Wenn ein Nutzer mit einem Dialogfeld interagiert, wird das Feld isDialogEvent von ButtonClickedPayload auf true gesetzt und enthält ein DialogEventType.

Die vollständige Nutzlast enthält auch commonEventObject.formInputs und commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

Ein Nutzer aktualisiert ein Widget in einer In-Stream-Karte oder in einem Dialogfeld.

Die vollständige Nutzlast enthält auch CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Ein Nutzer ruft einen App-Befehl auf.

systemCommandPayload

object (SystemCommandPayload)

Ein Nutzer ruft einen Systembefehl auf.

Ende der sich gegenseitig ausschließenden Felder.

EventType

Der Typ des Ereignisses, der nur für App-Startseitenereignisse in Chat-Apps ausgefüllt wird, die keine Add-ons sind.

Enums
EVENT_TYPE_UNSPECIFIED Standardwert für das Enum. NICHT VERWENDEN.
APP_HOME Ein Nutzer öffnet eine Direktnachricht von einer Chat-App, die die App-Startseite verwendet. Für Ereignisse dieses Typs sind nur die Felder type, user und space enthalten. Weitere Informationen finden Sie unter Startseite für eine Google Chat-App erstellen.
SUBMIT_FORM Ein Nutzer sendet Informationen über eine App-Startkarte. Für Ereignisse dieses Typs sind nur die Felder type, user und space enthalten. Weitere Informationen finden Sie unter https://developers.google.com/workspace/chat/send-app-home-card-message).

MessagePayload

Ein Nutzer sendet der Chat-App eine Nachricht oder erwähnt die Chat-App in einem Gruppenbereich mit @. Für App-Befehlsaufrufe (z. B. Slash-Befehle und Schnellbefehle) wird stattdessen AppCommandPayload verwendet.

JSON-Darstellung
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Felder
space

object (Space)

Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt.

message

object (Message)

Die Nachricht, die das Ereignisobjekt auslöst.

configCompleteRedirectUri

string

Optional. Die URL, zu der die Chat-App den Nutzer weiterleiten soll, nachdem er einen Autorisierungs- oder Konfigurationsvorgang außerhalb von Google Chat abgeschlossen hat. Weitere Informationen finden Sie unter Chat-App mit anderen Diensten und Tools verbinden.

AddedToSpacePayload

Ein Nutzer fügt die Chat-App einem Gruppenbereich hinzu oder es wird eine Direktnachricht zwischen der App und einem Nutzer erstellt.

JSON-Darstellung
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Felder
space

object (Space)

Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt.

interactionAdd

boolean

Gibt an, ob die App durch eine Nutzerinteraktion zum Gruppenbereich hinzugefügt wurde, z.B. durch eine @ Erwähnung der Chat-App oder durch Aufrufen mit einem Slash-Befehl. Wenn dieser Wert auf „true“ gesetzt ist, wird ein separates Ereignisobjekt, das mit der Interaktion selbst verknüpft ist, an die Chat-App gesendet.

configCompleteRedirectUri

string

Optional. Die URL, zu der die Chat-App den Nutzer weiterleiten soll, nachdem er einen Autorisierungs- oder Konfigurationsvorgang außerhalb von Google Chat abgeschlossen hat. Weitere Informationen finden Sie unter Chat-App mit anderen Diensten und Tools verbinden.

RemovedFromSpacePayload

Ein Nutzer entfernt die Chat-App aus einem Gruppenbereich.

JSON-Darstellung
{
  "space": {
    object (Space)
  }
}
Felder
space

object (Space)

Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt.

ButtonClickedPayload

Ein Nutzer interagiert mit einem interaktiven Element einer Karte oder eines Dialogfelds aus einem Chat-Add-on, das einen Action-Callback auslöst. Trotz des Namens wird diese Nutzlast für alle Action-Callbacks für Karten und Dialogfelder ausgefüllt, einschließlich Klicks auf Schaltflächen, onChangeAction-Triggern, onClick-Aktionen, CardAction-Klicks und dem Senden oder Abbrechen von Dialogfeldern (SUBMIT_DIALOG und CANCEL_DIALOG).

Wenn ein Nutzer mit einem Dialogfeld interagiert, wird das Feld isDialogEvent von ButtonClickedPayload auf true gesetzt und enthält ein DialogEventType. Diese Nutzlast wird den Ereignistypen SUBMIT_FORM und CARD_CLICKED für Chat-Apps zugeordnet, die keine Add-ons sind.

Die vollständige Nutzlast enthält auch CommonEventObject.form_inputs und CommonEventObject.parameters.

JSON-Darstellung
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Felder
space

object (Space)

Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt.

message

object (Message)

Die Nachricht, die das Ereignisobjekt auslöst.

isDialogEvent

boolean

Bei ButtonClicked- und Message-Ereignisobjekten, ob der Nutzer mit einem Dialogfeld interagiert oder im Begriff ist, damit zu interagieren.

dialogEventType

enum (DialogEventType)

Der Typ des empfangenen Dialogereignisobjekts.

DialogEventType

Für Ereignisobjekte, die ButtonClicked- oder AppCommand-Ereignisnutzlasten enthalten, die Arten von Interaktionen mit Dialogfeldern.

Weitere Informationen zu Ereignisobjekten für Google Chat-Apps finden Sie unter Interaktionen mit Ihrer Google Chat-App empfangen und darauf reagieren.

Enums
DIALOG_EVENT_TYPE_UNSPECIFIED Standardwert. Nicht angegeben
REQUEST_DIALOG Ein Nutzer öffnet ein Dialogfeld.
SUBMIT_DIALOG Ein Nutzer klickt auf ein interaktives Element eines Dialogfelds. Beispiel: Ein Nutzer gibt Informationen in ein Dialogfeld ein und klickt auf eine Schaltfläche, um die Informationen zu senden.
CANCEL_DIALOG Ein Nutzer schließt ein Dialogfeld, ohne Informationen zu senden, oder das Dialogfeld wird abgebrochen.

WidgetUpdatedPayload

Ein Nutzer aktualisiert ein Widget in einer In-Stream-Karte oder einem In-Stream-Dialogfeld.

Die vollständige Nutzlast enthält auch CommonEventObject.parameters['autocomplete_widget_query'].

JSON-Darstellung
{
  "space": {
    object (Space)
  }
}
Felder
space

object (Space)

Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt.

AppCommandPayload

Ein Nutzer ruft einen App-Befehl auf.

JSON-Darstellung
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Felder
appCommandMetadata

object (AppCommandMetadata)

Wird für App-Befehle ausgefüllt, einschließlich Slash-Befehlen und Schnellbefehlen.

space

object (Space)

Optional. Der Chatbereich, in dem das Ereignisobjekt auftritt.

thread

object (Thread)

Optional. Der Thread, in dem das Ereignisobjekt auftritt, falls zutreffend. Dieses Feld wird ausgefüllt, wenn das Ereignisobjekt mit einer bestimmten Nachricht oder einem bestimmten Thread verknüpft ist.

message

object (Message)

Optional. Die Nachricht, die das Ereignisobjekt auslöst, falls zutreffend. Dieses Feld wird nur für Slash-Befehle ausgefüllt.

configCompleteRedirectUri

string

Optional. Die URL, zu der der Nutzer weitergeleitet werden soll, nachdem er einen Autorisierungs- oder Konfigurationsvorgang außerhalb von Google Chat abgeschlossen hat. Weitere Informationen finden Sie unter Chat-App mit anderen Diensten und Tools verbinden.

isDialogEvent

boolean

Optional. Ob der Nutzer mit einem Dialogfeld interagiert oder im Begriff ist, damit zu interagieren.

dialogEventType

enum (DialogEventType)

Optional. Der Typ des empfangenen Dialogereignisobjekts. Dieses Feld gilt nur, wenn isDialogEvent den Wert true hat.

AppCommandMetadata

Metadaten zu einem Chat-App-Befehl.

JSON-Darstellung
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Felder
appCommandId

integer

Die ID für den Befehl, der in der Chat API-Konfiguration angegeben ist.

appCommandType

enum (AppCommandType)

Der Typ des Chat-App-Befehls.

AppCommandType

Der Typ des Chat-App-Befehls. Weitere Informationen finden Sie unter Arten von Chat-App-Befehlen.

Enums
APP_COMMAND_TYPE_UNSPECIFIED Standardwert. Nicht angegeben
SLASH_COMMAND Ein Slash-Befehl. Der Nutzer sendet den Befehl in einer Chatnachricht.
QUICK_COMMAND Ein Schnellbefehl. Der Nutzer wählt den Befehl im Chat-Menü im Antwortbereich der Nachricht aus.
MESSAGE_ACTION Eine Nachrichtenaktion. Der Nutzer wählt den Befehl im Kontextmenü der Nachricht in Google Chat aus.

SystemCommandPayload

Ein Nutzer ruft einen Systembefehl auf.

JSON-Darstellung
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Felder
systemCommandMetadata

object (SystemCommandMetadata)

Metadaten zum aufgerufenen Systembefehl.

space

string

Optional. Der Chatbereich, in dem das Ereignisobjekt auftritt.

thread

object (Thread)

Optional. Der Thread, in dem das Ereignisobjekt auftritt, falls zutreffend. Dieses Feld wird ausgefüllt, wenn das Ereignisobjekt mit einer bestimmten Nachricht oder einem bestimmten Thread verknüpft ist.

SystemCommandMetadata

Metadaten zu einem Systembefehl, der vom Nutzer ausgelöst wird.

JSON-Darstellung
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
Felder
Der Systembefehl wurde aufgerufen. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
cancelStream

object (CancelStream)

Befehl zum Abbrechen einer aktiven Streamnachricht.

Ende der sich gegenseitig ausschließenden Felder.

CancelStream

Befehl zum Abbrechen einer aktiven Streamnachricht.

JSON-Darstellung
{
  "streamMessage": string
}
Felder
streamMessage

string

Erforderlich. Der Ressourcenname der Streamnachricht, für die der Abbruchbefehl ausgeführt wurde.

Format: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange Das Ereignisobjekt, das an Workflow-Add-ons übergeben wird.

JSON-Darstellung
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
Felder
executionMetadata

object (ExecutionMetadata)

Metadaten zur Workflowausführung.

triggerEventSource

enum (TriggerEventSource)

Quelle der auslösenden Ereignisse.

Der Typ der Nutzlast des Workflow-Ereignisses. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
actionInvocation

object (ActionInvocation)

Aufruf einer Workflowaktion.

triggerCreation

object (TriggerCreation)

Erstellung eines Workflow-Triggers.

triggerDeletion

object (TriggerDeletion)

Löschen eines Workflow-Triggers.

resourceRetrieval

object (ResourceRetrieval)

Abruf einer Ressource (für die Variableninflation verwendet).

elementConfiguration

object (ElementConfiguration)

Konfiguration eines Workflow-Elements.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

Das Abrufen von Felddefinitionen, die von einer Ressource unterstützt werden.

elementUiAutocomplete

object (ElementUiAutocomplete)

Automatisch vervollständigte Vorschläge für die aktuell gerenderte Karte.

Ende der sich gegenseitig ausschließenden Felder.

ActionInvocation

Aufruf einer Workflowaktion.

JSON-Darstellung
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Felder
inputs

map (key: string, value: object (VariableData))

Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

Trigger-ID, die für asynchrone Aktionsantworten verwendet werden soll.

flowLevelContext

object (FlowLevelContext)

Optional. Kontext auf Ablaufebene aus vorherigen Schritten.

VariableData

Stellt variable Daten dar, die mehrere Werte unterschiedlicher Typen enthalten können.

JSON-Darstellung
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Felder
booleanValues[]

boolean

Boolesche Werte.

integerValues[]

string (int64 format)

Ganzzahlwerte.

floatValues[]

number

Gleitkommawerte.

stringValues[]

string

Stringwerte.

timestampValues[]

string (Timestamp format)

Zeitstempelwerte.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

Ressourcenreferenzen (IDs).

emailAddressValues[]

string

E-Mail-Adressen.

googleUserValues[]

string

Google-Nutzerwerte im Format users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Werte für das Textformat von Workflows.

ResourceReference

ID-Wert der anwendungsspezifischen Ressource.

JSON-Darstellung
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Felder
resourceType

object (ResourceType)

Der Typ der Ressource, auf die diese ID verweist.

resourceId

string

ID der Ressource.

ResourceType

Name des benutzerdefinierten Ressourcentyps.

JSON-Darstellung
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Felder
workflowBundleId

string

ID des Workflow-Bundles, zu dem dieser Ressourcentyp gehört. Dies ist optional. Wenn das Feld leer ist, wird davon ausgegangen, dass es sich um dasselbe Bundle handelt, in dem es verwendet wird.

workflowResourceDefinitionId

string

Eindeutige Kennung der Ressource. Sie muss nur innerhalb desselben Bundles eindeutig sein.

WorkflowTextFormat

Ein Textblock mit umfangreichen Formatierungsoptionen, einschließlich Stilen, Hyperlinks und interaktiven Elementen.

JSON-Darstellung
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Felder
textFormatElements[]

object (TextFormatElement)

Eine Sammlung von Textformatelementen.

TextFormatElement

Ein einzelnes Element in einer WorkflowTextFormat-Nachricht, das ein Chip, formatierter Text, ein Hyperlink oder ein Listencontainer sein kann.

JSON-Darstellung
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
Felder
Element, das eines von mehreren möglichen Textformatelementen darstellt. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
text

string

Text im Textformat.

chip

object (Chip)

Anklickbarer Chip im Textformat.

styledText

object (StyledText)

Formatierter Text im Textformat.

listContainer

object (ListContainer)

Container im Textformat auflisten.

Ende der sich gegenseitig ausschließenden Felder.

Chip

Ein anklickbarer Chip im Textformat.

JSON-Darstellung
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
Felder
icon

object (Icon)

Das im Chip angezeigte Symbol.

label

string

Der im Chip angezeigte Text.

url

string

Die URL, die aufgerufen werden soll, wenn auf den Chip geklickt wird.

Symbol

Ein Symbol im Chip.

JSON-Darstellung
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
Felder
Das im Chip angezeigte Symbol. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
iconUrl

string

Ein benutzerdefiniertes Symbol anzeigen, das unter einer HTTPS-URL gehostet wird.

Beispiel:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Zu den unterstützten Dateitypen gehören .png und .jpg.

materialIconName

string

Der Symbolname, der im Google Material Design-Symbol definiert ist, z. B. check_box. Ungültige Namen werden verworfen und durch einen leeren String ersetzt. Das Symbol wird dann nicht gerendert.

Ende der sich gegenseitig ausschließenden Felder.

StyledText

Textelement mit Stilen wie fett, kursiv und Farbe.

JSON-Darstellung
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Felder
text

string

Der Hauptinhalt des Textes.

styles[]

enum (Style)

Eine Sammlung von Stilen, die auf den Text angewendet werden.

fontWeight

enum (FontWeight)

Die Schriftstärke des Texts.

color

object (Color)

Die Farbe des Textes.

wrapStyle

enum (WrapStyle)

Der Umbruchstil des Texts.

Stil

Enum für verschiedene Textstile wie kursiv, unterstrichen usw.

Enums
STYLE_UNSPECIFIED Kein Stil angewendet. NICHT VERWENDEN.
ITALIC Kursiver Stil.
UNDERLINE Stil „Unterstreichen“
STRIKETHROUGH Durchgestrichener Stil.
LINE_BREAK Zeilenumbruch.
UPPERCASE Großbuchstabenstil.
CODE Programmieren.
CODE_BLOCK Code block.

FontWeight

Enum für verschiedene Schriftstärken.

Enums
FONT_WEIGHT_UNSPECIFIED Standardgewicht mit normaler Dicke. NICHT VERWENDEN.
LIGHT Leichter und dünner.
MEDIUM Mittlere Stärke zwischen „Light“ und „Bold“.
BOLD Höheres Gewicht und größere Dicke.

WrapStyle

Enum für verschiedene Zeilenumbruchstile.

Enums
WRAP_STYLE_UNSPECIFIED Kein Zeilenumbruchstil angegeben.
NO_WRAP Kein Zeilenumbruchstil.

ListContainer

Container für Listenelemente, wobei jedes Listenelement mehrere TextFormatElements enthalten kann.

JSON-Darstellung
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Felder
listNestLevel

string (int64 format)

Die Verschachtelungsebene der Liste. Beginnt bei 0 für die oberste Ebene und erhöht sich für jede verschachtelte Liste um 1.

listType

enum (ListType)

Der Typ der Liste.

listItems[]

object (ListItem)

Eine Sammlung von Listenelementen.

ListType

Enum für verschiedene Listentypen.

Enums
LIST_TYPE_UNSPECIFIED Kein Listentyp angegeben. NICHT VERWENDEN.
ORDERED Sortierte Liste.
UNORDERED Unsortierte Liste.
BLOCKQUOTE Stellt eine Blockzitatliste dar.

ListItem

Ein Listenelement.

JSON-Darstellung
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Felder
textFormatElements[]

object (TextFormatElement)

Eine Sammlung von Textformatelementen.

FlowLevelContext

Kontext auf Ablaufebene mit Ausgaben aus vorherigen Schritten.

JSON-Darstellung
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
Felder
stepContexts[]

object (StepContext)

Optional. Liste der vorherigen Schritte. Die Reihenfolge ist wichtig. Achten Sie also darauf, dass die Ausführungsreihenfolge in dieser Liste beibehalten wird.

StepContext

Schrittkontext-Metadaten und -Ausgaben für den Kontext auf Ablaufebene.

JSON-Darstellung
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Felder
stepId

string

Optional. Eindeutige ID des Schritts im Workflow-Diagramm.

outputs

map (key: string, value: object (VariableData))

Optional. Zuordnung der von diesem Schritt erzeugten Ausgabevariablen, sortiert nach Variablenname.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

Erstellung eines Workflow-Triggers.

JSON-Darstellung
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Felder
triggerId

string

Eindeutige Kennung des Triggers, die bei der Erstellung angegeben wurde.

triggerType

enum (TriggerType)

Typ des Triggers.

inputs

map (key: string, value: object (VariableData))

Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

Der Endpunkt, der aufgerufen wird, wenn der Trigger ausgelöst wird.

TriggerType

Typ des Triggers.

Enums
TRIGGER_TYPE_UNDEFINED Standardwert. NICHT VERWENDEN.
REPEATING Der Auslöser wird jedes Mal ausgelöst, wenn die Eingabebedingungen erfüllt sind.

TriggerDeletion

Löschen eines Workflow-Triggers.

JSON-Darstellung
{
  "triggerId": string
}
Felder
triggerId

string

Eindeutige Kennung des Triggers, die bei der Erstellung angegeben wurde.

ResourceRetrieval

Abruf einer Ressource.

JSON-Darstellung
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Felder
resourceReference

object (ResourceReference)

Typ und ID der abzurufenden Ressource.

ElementConfiguration

Aufruf beim Konfigurieren eines Workflow-Elements.

JSON-Darstellung
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Felder
inputs

map (key: string, value: object (VariableData))

Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname. Diese Karte ist möglicherweise leer. Wird verwendet, wenn ein einzelnes Workflow-Element (Auslöser oder Aktion) im Workflow-Zuhause konfiguriert wird.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

Das Ziel der Elementkonfigurationskarte. Elemente können dieses Feld verwenden, um je nach Ziel unterschiedliche Layouts für Konfigurationskarten zurückzugeben.

nodeId

string

Die Knoten-ID der gerenderten primitiven Konfiguration.

workflowId

string

Die Workflow-ID der gerenderten primitiven Konfiguration.

availableVariables[]

object (VariableReference)

Verfügbare Variablen, sortiert nach Knotenposition.

DisplayDestination

Gibt an, wo die Konfigurationskarte für das zurückkehrende Element angezeigt wird.

Enums
DISPLAY_DESTINATION_UNSPECIFIED Standardwert. NICHT VERWENDEN.
DISPLAY_DESTINATION_SIDE_PANEL Die Konfigurationskarte wird in der Seitenleiste angezeigt.
DISPLAY_DESTINATION_FULL_SCREEN Die Konfigurationskarte wird in der Vollbild-App angezeigt.

VariableReference

Ein Variablenverweis auf eine Variable im Workflow.

JSON-Darstellung
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Felder
parentElementId

string

Die primitive ID des Elements, das die Variable erzeugt. Wir können dies bei Bedarf auf WorkflowElement oder ein detaillierteres Metadaten-Proto erweitern.

nodeId

string

Knotenreferenz-ID

path

string

Die Pfadsignatur des Variablenselektors

dataType

object (DataType)

Der Datentyp der Variable

iconUrl

string

Die Symbol-URL des Primitivs, das diese Variable erzeugt.

stepNumber

integer

Die Schrittnummer des Primitivs, das diese Variable erzeugt.

descriptionText

string

Die Beschreibung der Variable.

displayText

string

Der Anzeigetext des Variablen-Chips.

DataType

Typ der Variable.

JSON-Darstellung
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
Felder
valueMetadata

object (ValueMetadata)

Metadaten zu den potenziellen Werten einer Variablen.

Der Datentyp. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
basicType

enum (BasicType)

Grundlegender Datentyp.

resourceType

object (ResourceType)

Typ der Anwendungsressourcen-ID.

Ende der sich gegenseitig ausschließenden Felder.

BasicType

Grundlegende allgemeine Datentypen.

Enums
BASIC_TYPE_UNSPECIFIED Standardwert. NICHT VERWENDEN.
STRING Eine Zeichenfolge.
INTEGER Eine Ganzzahl.
FLOAT Eine Gleitkommazahl
TIMESTAMP Zeitstempel im ISO 8601-Format.
BOOLEAN Ein Wert, der „true“ oder „false“ sein kann.
EMAIL_ADDRESS Eine E‑Mail-Adresse, die ein String im Format einer E‑Mail-Adresse ist.
GOOGLE_USER Nutzer von Google-Diensten im Format users/{user}.
FILE Dateiverweis.
FORMATTED_TEXT Text mit Rich-Text-Formatierung.

ValueMetadata

Informationen zu den potenziellen Werten einer Variablen.

JSON-Darstellung
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Felder
enumValues[]

string

Optional. Gibt die zulässigen Werte für einen String an. Dies kann nur festgelegt werden, wenn DataType STRING ist.

dynamicTypes[]

enum (BasicType)

Optional. Gibt die zulässigen Typen an, die für eine Variable dynamisch umgewandelt werden können. Dies kann nur festgelegt werden, wenn der DataType ein String und die Variable eine Ausgabe ist.

semanticDescriptors[]

object (SemanticDescriptor)

Optional. Hilft, die semantische Bedeutung einer Variable zu beschreiben.

dynamicSchema

object (DynamicSchema)

Optional. Konfiguration für die dynamische Auflösung des Schemas dieser Variable.

defaultValue

string

Optional. String, der den Standardwert für diese Variable angibt. Bei booleschen Werten kann defaultValue beispielsweise auf true oder false festgelegt werden.

SemanticDescriptor

Metadaten zur semantischen Bedeutung einer Variablen.

JSON-Darstellung
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Felder
resourceAttribute

string

Gibt an, dass die Variable einem bestimmten Attribut einer Ressource entspricht. Das ist besonders nützlich für Variablen, die eine Kennung für eine Ressource darstellen (ID, URL, Schlüssel usw.).

Das empfohlene Format ist: - "{brand}/{appName}/{resource}:{attribute}" {brand} ist optional und sollte weggelassen werden, wenn es mit {appName} identisch ist.

Beispiele: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" usw.

Der Client verwendet diese Informationen, um dem Nutzer Hinweise zu geben, welche Ausgabevariablen mit einer bestimmten Eingabe kompatibel sind.

disallowedResourceAttributes[]

string

Optional. Gilt nur für Eingaben und wird für Ausgaben ignoriert. Unzulässige Attribute, die diesem semantischen Deskriptor entsprechen. Der Client verhindert explizit die Variablenauswahl für Ausgaben, die diesen unzulässigen Ressourcenattributen entsprechen.

DynamicSchema

Konfiguration zum dynamischen Auflösen des Schemas dieser Variable zur Laufzeit.

JSON-Darstellung
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
Felder
requiredInputIds[]

string

IDs von gleichgeordneten Eingabevariablen, die angegeben werden müssen, bevor das Schema dieser Variable dynamisch aufgelöst werden kann.

strictEnum

boolean

Wenn „true“, muss der Wert der Variablen mit einem der dynamisch aufgelösten Enum-Werte übereinstimmen. Wenn „false“, werden dynamisch aufgelöste Werte als nicht strikte Vorschläge behandelt.

ResourceFieldsDefinitionRetrieval

Ruft die Definition der von einer Ressource unterstützten Felder ab.

JSON-Darstellung
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Felder
elementId

string

Gibt die ID des Elements an, dessen dynamisches Ressourcenschema abgerufen werden soll.

inputs

map (key: string, value: object (VariableData))

Dazu gehören Feldeingaben des Knotens, der die Variable bereitstellt. Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

Automatisch vervollständigte Vorschläge für die aktuell gerenderte Karte.

JSON-Darstellung
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Felder
query

string

Die Anfrage, die automatisch vervollständigt werden soll.

inputs

map (key: string, value: object (VariableData))

Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Die aufgerufene Funktion, die mit dem Widget verknüpft ist.

resourceId

string

Die Ressourcen-ID, für die die automatische Vervollständigung erfolgen soll. Dieses Feld ist optional und muss nicht festgelegt werden.

operationId

string

Die ID des Vorgangs, der die Ressource für die automatische Vervollständigung bereitgestellt hat. Dieses Feld ist optional und muss nicht festgelegt werden.

ExecutionMetadata

Metadaten zur Workflowausführung.

JSON-Darstellung
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
Felder
versionId

integer

Die Version des aufgerufenen Workflow-Elements.

timeZone

string

Die Zeitzone des Workflows, der gespeichert wird, z. B. „America/Los_Angeles“.

stepNumber

integer

Stellt die Schrittnummer des aufgerufenen Primitivs dar.

TriggerEventSource

Quelle des Triggerereignisses, das diese Ausführung ausgelöst hat.

Enums
TRIGGER_EVENT_SOURCE_UNSPECIFIED Standardwert. NICHT VERWENDEN.
TRIGGER_EVENT_SOURCE_AUTOMATED Die Ausführung wird automatisch durch Ereignisse ausgelöst.
TRIGGER_EVENT_SOURCE_TEST_RUN Die Ausführung wird über einen Testlauf ausgelöst.