- EventObject
- CommonEventObject
- HostApp
- Plattform
- TimeZone
- Eingaben
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Organisator
- Gast
- ConferenceData
- ConferenceSolution
- Schlüssel
- EntryPoint
- Parameter
- AddOnParameters
- Funktionen
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Chip
- Symbol
- StyledText
- Design
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
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 ( |
| Felder | |
|---|---|
commonEventObject |
Ein Objekt, das Informationen enthält, die für alle Eventobjekte unabhängig von der gehosteten Anwendung gelten. |
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 |
Nur vorhanden, wenn der aufrufende Host Google Kalender ist. Ein Objekt mit Kalender- und Termininformationen. |
drive |
Wird nur angezeigt, wenn der aufrufende Host Google Drive ist. Ein Objekt mit Drive-Informationen. |
gmail |
Wird nur angezeigt, wenn der aufrufende Host Gmail ist. Ein Objekt mit Gmail-Informationen. |
sheets |
Nur vorhanden, wenn der aufrufende Host Google Sheets ist. Ein Objekt mit Informationen zu Google Sheets. |
slides |
Wird nur angezeigt, wenn der aufrufende Host Google Präsentationen ist. Ein Objekt mit Informationen zu Präsentationen. |
docs |
Nur vorhanden, wenn der aufrufende Host Google Docs ist. Ein Objekt mit Informationen zu Google Docs. |
chat |
Nur vorhanden, wenn der aufrufende Host Google Chat ist. Ein Objekt mit Chat-Informationen. |
workflow |
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 ( |
| Felder | |
|---|---|
userLocale |
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: Wenn Sie dieses Feld aktivieren möchten, müssen Sie im Manifest Ihres Add-ons |
hostApp |
Gibt die Host-App an, in der das Add-on aktiv ist, wenn das Ereignisobjekt generiert wird. Mögliche Werte:
|
platform |
Das Plattform-Enum, das die Plattform angibt, von der das Ereignis stammt ( |
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 Wird nur für die Ereignistypen |
formInputs |
Eine Zuordnung, die die aktuellen Werte der Widgets auf der angezeigten Karte enthält. Die Kartenschlüssel sind die Stringwerte 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
Beispiel: Für ein Texteingabe-Widget mit
Beispiel: Bei einem Widget mit mehreren Werten und
Beispiel: Bei einer Auswahl mit einem
Beispiel: Bei einer Auswahl mit einem
Beispiel: Bei einer Auswahl mit einem Ein Objekt, das eine Liste von |
parameters |
Alle zusätzlichen Parameter, die Sie einer Aktion mit Entwicklervorschau: Bei Add-ons, die Google Chat erweitern, können Sie den Wert des Schlüssels Ein Objekt, das eine Liste von |
invokedFunction |
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 |
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 |
Der Zeitzonencode der IANA-Zeitzonendatenbank, z. B. „America/Toronto“. |
offset |
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 ( |
| 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 |
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 |
dateTimeInput |
Datums- und Uhrzeit-Eingabewerte aus einem |
dateInput |
Datumseingabewerte aus einem |
timeInput |
Zeiteingabewerte aus einem |
| 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[] |
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 |
Zeit seit der Epoche in Millisekunden. |
hasDate |
Gibt an, ob die Eingabe |
hasTime |
Gibt an, ob die |
DateInput
Datumseingabewerte.
| JSON-Darstellung |
|---|
{ "msSinceEpoch": string } |
| Felder | |
|---|---|
msSinceEpoch |
Zeit seit der Epoche in Millisekunden. |
TimeInput
Eingabewerte für die Zeit.
| JSON-Darstellung |
|---|
{ "hours": integer, "minutes": integer } |
| Felder | |
|---|---|
hours |
Die Stunde im 24-Stunden-Format. |
minutes |
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 |
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 |
Ein Endnutzer-ID-Token, wenn entsprechende ID-Bereiche angefordert werden |
systemIdToken |
Ein ID-Token für das G Suite-Add-ons-Dienstkonto für diese Bereitstellung |
authorizedScopes[] |
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 ( |
| Felder | |
|---|---|
id |
Die Ereignis-ID. |
recurringEventId |
Die ID eines wiederkehrenden Termins. |
calendarId |
Die Kalender-ID. |
organizer |
Ein Objekt, das den Organisator der Veranstaltung darstellt. |
attendees[] |
Von Nutzern erstellte Daten. Eine Liste der Teilnehmer des Kalendertermins. |
conferenceData |
Von Nutzern erstellte Daten. Ein Objekt, das alle mit diesem Termin verknüpften Konferenzdaten darstellt, z. B. Details zu Google Meet-Konferenzen. |
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 |
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 |
Die E‑Mail-Adresse des Teilnehmers. |
displayName |
Der Anzeigename des Teilnehmers. |
organizer |
true, wenn der Teilnehmer ein Organisator dieses Termins ist. |
self |
true, wenn dieser Teilnehmer den Kalender darstellt, in dem dieser Termin angezeigt wird; andernfalls false. |
resource |
true, wenn der Teilnehmer eine Ressource wie einen Raum oder ein Gerät darstellt, andernfalls false. |
optional |
true, wenn die Teilnahme für diesen Teilnehmer als optional markiert ist, andernfalls false. |
responseStatus |
Der Antwortstatus des Teilnehmers. Mögliche Werte:
|
comment |
Der Antwortkommentar des Teilnehmers, falls vorhanden. |
additionalGuests |
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 ( |
| Felder | |
|---|---|
conferenceId |
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 |
Ein Objekt, das die Konferenzlösung darstellt, z. B. Hangouts oder Google Meet. |
entryPoints[] |
Die Liste der Konferenzeinstiegspunkte, z. B. URLs oder Telefonnummern. |
notes |
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 |
Ein Objekt, das eine Zuordnung definierter Parameterdaten zur Verwendung durch das Add-on enthält. |
ConferenceSolution
| JSON-Darstellung |
|---|
{
"iconUri": string,
"key": {
object ( |
| Felder | |
|---|---|
iconUri |
Der URI für das für Nutzer sichtbare Symbol, das diese Konferenzlösung darstellt. |
key |
Der Schlüssel, der die Konferenzlösung für diesen Termin eindeutig identifiziert. |
name |
Der für den Nutzer sichtbare Name dieser Konferenzlösung (nicht lokalisiert). |
Schlüssel
| JSON-Darstellung |
|---|
{ "type": string } |
| Felder | |
|---|---|
type |
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 |
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 |
Der Typ des Einstiegspunkts. Folgende Werte sind möglich:
|
label |
Das für den Nutzer sichtbare Label für den Einstiegspunkt-URI (nicht lokalisiert). |
meetingCode |
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 |
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 |
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 |
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 |
Der URI des Einstiegspunkts. Die maximale Länge beträgt 1.300 Zeichen. Die Formatierung hängt vom Typ des Einstiegspunkts ab:
|
regionCode |
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[] |
Features des Einstiegspunkts. Derzeit gelten diese Funktionen nur für Einstiegspunkte für Telefonnummern:
|
Parameter
| JSON-Darstellung |
|---|
{
"addOnParameters": {
object ( |
| Felder | |
|---|---|
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 |
Ein Objekt, das eine Liste von |
Leistungsspektrum
| JSON-Darstellung |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Felder | |
|---|---|
canSeeAttendees |
Nutzergenerierte Daten: true, wenn das Add-on die Teilnehmerliste des Termins lesen kann, andernfalls false. |
canAddAttendees |
User-generated data: true, wenn das Add-on der Teilnehmerliste des Termins neue Teilnehmer hinzufügen kann; andernfalls false. |
canSeeConferenceData |
Nutzergenerierte Daten: true, wenn das Add-on die Konferenzdaten des Termins lesen kann; andernfalls false. |
canSetConferenceData |
User-generated data: true, wenn das Add-on die Konferenzdaten des Termins aktualisieren kann; andernfalls false. |
canAddAttachments |
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 ( |
| Felder | |
|---|---|
selectedItems[] |
Eine Liste der in Drive ausgewählten Elemente (Dateien oder Ordner). |
activeCursorItem |
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 |
Die ID des ausgewählten Elements. |
iconUrl |
Die URL des Symbols, das das ausgewählte Element darstellt. |
mimeType |
Der MIME-Typ des ausgewählten Elements. |
title |
Der Titel des ausgewählten Elements. |
addonHasFileScopePermission |
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 |
Die ID der aktuell geöffneten Gmail-Nachricht. |
threadId |
Die ID des aktuell geöffneten Gmail-Threads. |
accessToken |
Das Gmail-spezifische Zugriffstoken. Sie können dieses Token mit der Methode |
toRecipients[] |
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 |
ccRecipients[] |
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 |
bccRecipients[] |
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 |
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 ( |
| Felder | |
|---|---|
id |
Nur vorhanden, wenn der Nutzer den Bereich |
title |
Nur vorhanden, wenn der Nutzer den Bereich |
addonHasFileScopePermission |
Wenn |
matchedUrl |
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:
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 Beispielnutzlast für die Vorschau des Links |
MatchedUrl
Ereignisobjekt, das mit Anfragen zur Linkvorschau zurückgegeben wird.
| JSON-Darstellung |
|---|
{ "url": string } |
| Felder | |
|---|---|
url |
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 ( |
| Felder | |
|---|---|
id |
Nur vorhanden, wenn der Nutzer den Bereich |
title |
Nur vorhanden, wenn der Nutzer den Bereich |
addonHasFileScopePermission |
Wenn |
matchedUrl |
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:
Die URL des Links, der eine Vorschau in Google Präsentationen generiert. Wenn Sie dieses Feld verwenden möchten, müssen Sie die Beispielnutzlast für die Vorschau des Links |
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 ( |
| Felder | |
|---|---|
id |
Nur vorhanden, wenn der Nutzer den Bereich |
title |
Nur vorhanden, wenn der Nutzer den Bereich |
addonHasFileScopePermission |
Wenn |
matchedUrl |
Nur vorhanden, wenn die folgenden Bedingungen erfüllt sind:
Die URL des Links, der eine Vorschau in Google Docs generiert. Wenn Sie dieses Feld verwenden möchten, müssen Sie die Beispielnutzlast für die Vorschau des Links |
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 ( |
| Felder | |
|---|---|
type |
Der Typ des Ereignisses, der nur für App-Startseitenereignisse in Chat-Apps ausgefüllt wird, die keine Add-ons sind. |
user |
Der Nutzer, der mit der Chat-App interagiert. |
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 |
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: |
| 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 |
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 |
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 |
Ein Nutzer entfernt die Chat-App aus einem Gruppenbereich. |
buttonClickedPayload |
Stellt Nutzlastdaten dar, wenn ein Nutzer mit einem interaktiven Element einer Karte oder eines Dialogfelds interagiert, das einen Wenn ein Nutzer mit einem Dialogfeld interagiert, wird das Feld Die vollständige Nutzlast enthält auch |
widgetUpdatedPayload |
Ein Nutzer aktualisiert ein Widget in einer In-Stream-Karte oder in einem Dialogfeld. Die vollständige Nutzlast enthält auch |
appCommandPayload |
Ein Nutzer ruft einen App-Befehl auf. |
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 ( |
| Felder | |
|---|---|
space |
Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt. |
message |
Die Nachricht, die das Ereignisobjekt auslöst. |
configCompleteRedirectUri |
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 ( |
| Felder | |
|---|---|
space |
Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt. |
interactionAdd |
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 |
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 ( |
| Felder | |
|---|---|
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 ( |
| Felder | |
|---|---|
space |
Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt. |
message |
Die Nachricht, die das Ereignisobjekt auslöst. |
isDialogEvent |
Bei |
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 ( |
| Felder | |
|---|---|
space |
Erforderlich. Der Chatbereich, in dem das Ereignisobjekt auftritt. |
AppCommandPayload
Ein Nutzer ruft einen App-Befehl auf.
| JSON-Darstellung |
|---|
{ "appCommandMetadata": { object ( |
| Felder | |
|---|---|
appCommandMetadata |
Wird für App-Befehle ausgefüllt, einschließlich Slash-Befehlen und Schnellbefehlen. |
space |
Optional. Der Chatbereich, in dem das Ereignisobjekt auftritt. |
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 |
Optional. Die Nachricht, die das Ereignisobjekt auslöst, falls zutreffend. Dieses Feld wird nur für Slash-Befehle ausgefüllt. |
configCompleteRedirectUri |
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 |
Optional. Ob der Nutzer mit einem Dialogfeld interagiert oder im Begriff ist, damit zu interagieren. |
dialogEventType |
Optional. Der Typ des empfangenen Dialogereignisobjekts. Dieses Feld gilt nur, wenn |
AppCommandMetadata
Metadaten zu einem Chat-App-Befehl.
| JSON-Darstellung |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Felder | |
|---|---|
appCommandId |
Die ID für den Befehl, der in der Chat API-Konfiguration angegeben ist. |
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 ( |
| Felder | |
|---|---|
systemCommandMetadata |
Metadaten zum aufgerufenen Systembefehl. |
space |
Optional. Der Chatbereich, in dem das Ereignisobjekt auftritt. |
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 ( |
| 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 |
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 |
Erforderlich. Der Ressourcenname der Streamnachricht, für die der Abbruchbefehl ausgeführt wurde. Format: |
WorkflowEventObject
LINT.IfChange Das Ereignisobjekt, das an Workflow-Add-ons übergeben wird.
| JSON-Darstellung |
|---|
{ "executionMetadata": { object ( |
| Felder | |
|---|---|
executionMetadata |
Metadaten zur Workflowausführung. |
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 |
Aufruf einer Workflowaktion. |
triggerCreation |
Erstellung eines Workflow-Triggers. |
triggerDeletion |
Löschen eines Workflow-Triggers. |
resourceRetrieval |
Abruf einer Ressource (für die Variableninflation verwendet). |
elementConfiguration |
Konfiguration eines Workflow-Elements. |
resourceFieldsDefinitionRetrieval |
Das Abrufen von Felddefinitionen, die von einer Ressource unterstützt werden. |
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 ( |
| Felder | |
|---|---|
inputs |
Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname. Ein Objekt, das eine Liste von |
triggerId |
Trigger-ID, die für asynchrone Aktionsantworten verwendet werden soll. |
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 ( |
| Felder | |
|---|---|
booleanValues[] |
Boolesche Werte. |
integerValues[] |
Ganzzahlwerte. |
floatValues[] |
Gleitkommawerte. |
stringValues[] |
Stringwerte. |
timestampValues[] |
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: |
resourceReferences[] |
Ressourcenreferenzen (IDs). |
emailAddressValues[] |
E-Mail-Adressen. |
googleUserValues[] |
Google-Nutzerwerte im Format |
textFormatValues[] |
Werte für das Textformat von Workflows. |
ResourceReference
ID-Wert der anwendungsspezifischen Ressource.
| JSON-Darstellung |
|---|
{
"resourceType": {
object ( |
| Felder | |
|---|---|
resourceType |
Der Typ der Ressource, auf die diese ID verweist. |
resourceId |
ID der Ressource. |
ResourceType
Name des benutzerdefinierten Ressourcentyps.
| JSON-Darstellung |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Felder | |
|---|---|
workflowBundleId |
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 |
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 ( |
| Felder | |
|---|---|
textFormatElements[] |
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 ( |
| 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 |
Text im Textformat. |
chip |
Anklickbarer Chip im Textformat. |
styledText |
Formatierter Text im Textformat. |
hyperlink |
Hyperlink im Textformat. |
listContainer |
Container im Textformat auflisten. |
| Ende der sich gegenseitig ausschließenden Felder. | |
Chip
Ein anklickbarer Chip im Textformat.
| JSON-Darstellung |
|---|
{
"icon": {
object ( |
| Felder | |
|---|---|
icon |
Das im Chip angezeigte Symbol. |
label |
Der im Chip angezeigte Text. |
url |
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 |
Ein benutzerdefiniertes Symbol anzeigen, das unter einer HTTPS-URL gehostet wird. Beispiel: Zu den unterstützten Dateitypen gehören |
materialIconName |
Der Symbolname, der im Google Material Design-Symbol definiert ist, z. B. |
| Ende der sich gegenseitig ausschließenden Felder. | |
StyledText
Textelement mit Stilen wie fett, kursiv und Farbe.
| JSON-Darstellung |
|---|
{ "text": string, "styles": [ enum ( |
| Felder | |
|---|---|
text |
Der Hauptinhalt des Textes. |
styles[] |
Eine Sammlung von Stilen, die auf den Text angewendet werden. |
fontWeight |
Die Schriftstärke des Texts. |
color |
Die Farbe des Textes. |
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. |
Hyperlink
Hyperlink-Element mit Text und Link.
| JSON-Darstellung |
|---|
{ "link": string, "text": string } |
| Felder | |
|---|---|
link |
Die Ziel-URL des Hyperlinks. |
text |
Der Text des Hyperlinks. |
ListContainer
Container für Listenelemente, wobei jedes Listenelement mehrere TextFormatElements enthalten kann.
| JSON-Darstellung |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Felder | |
|---|---|
listNestLevel |
Die Verschachtelungsebene der Liste. Beginnt bei 0 für die oberste Ebene und erhöht sich für jede verschachtelte Liste um 1. |
listType |
Der Typ der Liste. |
listItems[] |
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 ( |
| Felder | |
|---|---|
textFormatElements[] |
Eine Sammlung von Textformatelementen. |
FlowLevelContext
Kontext auf Ablaufebene mit Ausgaben aus vorherigen Schritten.
| JSON-Darstellung |
|---|
{
"stepContexts": [
{
object ( |
| Felder | |
|---|---|
stepContexts[] |
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 ( |
| Felder | |
|---|---|
stepId |
Optional. Eindeutige ID des Schritts im Workflow-Diagramm. |
outputs |
Optional. Zuordnung der von diesem Schritt erzeugten Ausgabevariablen, sortiert nach Variablenname. Ein Objekt, das eine Liste von |
TriggerCreation
Erstellung eines Workflow-Triggers.
| JSON-Darstellung |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Felder | |
|---|---|
triggerId |
Eindeutige Kennung des Triggers, die bei der Erstellung angegeben wurde. |
triggerType |
Typ des Triggers. |
inputs |
Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname. Ein Objekt, das eine Liste von |
notifyUri |
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 |
Eindeutige Kennung des Triggers, die bei der Erstellung angegeben wurde. |
ResourceRetrieval
Abruf einer Ressource.
| JSON-Darstellung |
|---|
{
"resourceReference": {
object ( |
| Felder | |
|---|---|
resourceReference |
Typ und ID der abzurufenden Ressource. |
ElementConfiguration
Aufruf beim Konfigurieren eines Workflow-Elements.
| JSON-Darstellung |
|---|
{ "inputs": { string: { object ( |
| Felder | |
|---|---|
inputs |
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 |
displayDestination |
Das Ziel der Elementkonfigurationskarte. Elemente können dieses Feld verwenden, um je nach Ziel unterschiedliche Layouts für Konfigurationskarten zurückzugeben. |
nodeId |
Die Knoten-ID der gerenderten primitiven Konfiguration. |
workflowId |
Die Workflow-ID der gerenderten primitiven Konfiguration. |
availableVariables[] |
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 ( |
| Felder | |
|---|---|
parentElementId |
Die primitive ID des Elements, das die Variable erzeugt. Wir können dies bei Bedarf auf WorkflowElement oder ein detaillierteres Metadaten-Proto erweitern. |
nodeId |
Knotenreferenz-ID |
path |
Die Pfadsignatur des Variablenselektors |
dataType |
Der Datentyp der Variable |
iconUrl |
Die Symbol-URL des Primitivs, das diese Variable erzeugt. |
stepNumber |
Die Schrittnummer des Primitivs, das diese Variable erzeugt. |
descriptionText |
Die Beschreibung der Variable. |
displayText |
Der Anzeigetext des Variablen-Chips. |
DataType
Typ der Variable.
| JSON-Darstellung |
|---|
{ "valueMetadata": { object ( |
| Felder | |
|---|---|
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 |
Grundlegender Datentyp. |
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 ( |
| Felder | |
|---|---|
enumValues[] |
Optional. Gibt die zulässigen Werte für einen String an. Dies kann nur festgelegt werden, wenn |
dynamicTypes[] |
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[] |
Optional. Hilft, die semantische Bedeutung einer Variable zu beschreiben. |
dynamicSchema |
Optional. Konfiguration für die dynamische Auflösung des Schemas dieser Variable. |
defaultValue |
Optional. String, der den Standardwert für diese Variable angibt. Bei booleschen Werten kann |
SemanticDescriptor
Metadaten zur semantischen Bedeutung einer Variablen.
| JSON-Darstellung |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Felder | |
|---|---|
resourceAttribute |
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: - Beispiele: - Der Client verwendet diese Informationen, um dem Nutzer Hinweise zu geben, welche Ausgabevariablen mit einer bestimmten Eingabe kompatibel sind. |
disallowedResourceAttributes[] |
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[] |
IDs von gleichgeordneten Eingabevariablen, die angegeben werden müssen, bevor das Schema dieser Variable dynamisch aufgelöst werden kann. |
strictEnum |
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 ( |
| Felder | |
|---|---|
elementId |
Gibt die ID des Elements an, dessen dynamisches Ressourcenschema abgerufen werden soll. |
inputs |
Dazu gehören Feldeingaben des Knotens, der die Variable bereitstellt. Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname. Ein Objekt, das eine Liste von |
ElementUiAutocomplete
Automatisch vervollständigte Vorschläge für die aktuell gerenderte Karte.
| JSON-Darstellung |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Felder | |
|---|---|
query |
Die Anfrage, die automatisch vervollständigt werden soll. |
inputs |
Zuordnung der Eingabevariablen, verschlüsselt nach Eingabevariablenname. Ein Objekt, das eine Liste von |
invokedFunction |
Die aufgerufene Funktion, die mit dem Widget verknüpft ist. |
resourceId |
Die Ressourcen-ID, für die die automatische Vervollständigung erfolgen soll. Dieses Feld ist optional und muss nicht festgelegt werden. |
operationId |
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 |
Die Version des aufgerufenen Workflow-Elements. |
timeZone |
Die Zeitzone des Workflows, der gespeichert wird, z. B. „America/Los_Angeles“. |
stepNumber |
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. |