Action

Eine Aktion, die das Verhalten beim Senden des Formulars beschreibt. Sie können beispielsweise ein Apps Script-Skript aufrufen, um das Formular zu verarbeiten. Wenn die Aktion ausgelöst wird, werden die Formularwerte an den Server gesendet.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Felder
function

string

Eine benutzerdefinierte Funktion, die aufgerufen wird, wenn auf das übergeordnete Element geklickt oder es anderweitig aktiviert wird.

Ein Beispiel für die Verwendung finden Sie unter Formulardaten lesen.

parameters[]

object (ActionParameter)

Liste der Aktionsparameter.

loadIndicator

enum (LoadIndicator)

Gibt die Ladeanzeige an, die die Aktion beim Aufrufen der Aktion anzeigt.

persistValues

boolean

Gibt an, ob Formularwerte nach der Aktion beibehalten werden. Der Standardwert ist false.

Wenn true, bleiben die Formularwerte nach dem Auslösen der Aktion erhalten. Wenn Sie dem Nutzer erlauben möchten, Änderungen vorzunehmen, während die Aktion verarbeitet wird, setzen Sie LoadIndicator auf NONE. Bei Kartennachrichten in Chat-Apps müssen Sie außerdem die ResponseType der Aktion auf UPDATE_MESSAGE festlegen und dieselbe cardId der Karte verwenden, die die Aktion enthielt.

Wenn false, werden die Formularwerte gelöscht, wenn die Aktion ausgelöst wird. Wenn Sie verhindern möchten, dass der Nutzer während der Verarbeitung der Aktion Änderungen vornimmt, setzen Sie LoadIndicator auf SPINNER.

interaction

enum (Interaction)

Optional. Erforderlich, wenn ein Dialogfeld geöffnet wird.

Was bei einer Interaktion mit einem Nutzer zu tun ist, z. B. wenn ein Nutzer auf eine Schaltfläche in einer Kartennachricht klickt.

Wenn nichts angegeben ist, reagiert die App wie gewohnt, indem sie eine action ausführt, z. B. einen Link öffnet oder eine Funktion ausführt.

Wenn Sie eine interaction angeben, kann die App auf spezielle interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG festlegen, kann die App ein Dialogfeld öffnen. Wenn angegeben, wird keine Ladeanzeige eingeblendet. Wenn dies für ein Add-on angegeben ist, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

requiredWidgets[]

string

Optional. Füllen Sie diese Liste mit den Namen der Widgets, die diese Aktion für eine gültige Einreichung benötigt.

Wenn die hier aufgeführten Widgets beim Aufrufen dieser Aktion keinen Wert haben, wird das Senden des Formulars abgebrochen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

allWidgetsAreRequired

boolean

Optional. Wenn dies der Fall ist, werden alle Widgets von dieser Aktion als erforderlich angesehen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

ActionParameter

Liste der Stringparameter, die beim Aufruf der Aktionsmethode angegeben werden müssen. Beispiel: „Jetzt zurückstellen“, „Einen Tag zurückstellen“ oder „Nächste Woche zurückstellen“. Sie können action method = snooze() verwenden und den Schlummertyp und die Schlummerzeit in der Liste der Stringparameter übergeben.

Weitere Informationen finden Sie unter CommonEventObject.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

Der Name des Parameters für das Aktionsskript.

value

string

Wert des Parameters.

LoadIndicator

Gibt die Ladeanzeige an, die die Aktion beim Aufrufen der Aktion anzeigt.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
SPINNER Zeigt einen Spinner an, um zu signalisieren, dass Inhalte geladen werden.
NONE Es wird nichts angezeigt.

Interaktion

Optional. Erforderlich, wenn ein Dialogfeld geöffnet wird.

Was bei einer Interaktion mit einem Nutzer zu tun ist, z. B. wenn ein Nutzer auf eine Schaltfläche in einer Kartennachricht klickt.

Wenn nichts angegeben ist, reagiert die App wie gewohnt, indem sie eine action ausführt, z. B. einen Link öffnet oder eine Funktion ausführt.

Wenn Sie eine interaction angeben, kann die App auf spezielle interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG festlegen, kann die App ein Dialogfeld öffnen.

Wenn angegeben, wird keine Ladeanzeige eingeblendet. Wenn dies für ein Add-on angegeben ist, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

Enums
INTERACTION_UNSPECIFIED Standardwert. Die action wird normal ausgeführt.
OPEN_DIALOG

Öffnet ein Dialogfeld, eine kartenbasierte Oberfläche in einem Fenster, die Chat-Apps für die Interaktion mit Nutzern verwenden.

Wird nur von Chat-Apps als Antwort auf Schaltflächenklicks in Kartennachrichten unterstützt. Wenn dies für ein Add-on angegeben ist, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.