Texteingabe

Das TextInput-Widget bietet ein Feld, in das Nutzer Text eingeben können. Das Widget unterstützt Vorschläge, die Nutzern bei der Eingabe einheitlicher Daten helfen, und Aktionen bei Änderung, bei denen es sich um Actions handelt, die ausgeführt werden, wenn eine Änderung im Texteingabefeld vorgenommen wird, z. B. wenn ein Nutzer Text hinzufügt oder löscht.


Mit dem Card Builder kannst du Karten entwerfen und sie dir als Vorschau ansehen.

Den Card Builder öffnen

Wenn Sie abstrakte oder unbekannte Daten von Nutzern erfassen möchten, verwenden Sie dieses TextInput-Widget. Wenn Sie definierte Daten von Nutzern erfassen möchten, verwenden Sie stattdessen das SelectionInput-Widget.

Weitere Informationen zum Verarbeiten des von Nutzern eingegebenen Textes finden Sie unter Formulardaten empfangen.

Die folgende Karte besteht aus einem TextInput-Widget:

JSON-Darstellung und -Felder

JSON-Darstellung
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "placeholderText": string
}
Felder
name

string

Der Name, durch den die Texteingabe in einem Formulareingabeereignis identifiziert wird.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.

label

string

Der Text, der in der Benutzeroberfläche über dem Texteingabefeld angezeigt wird.

Geben Sie Text ein, mit dem der Nutzer die Informationen eingeben kann, die Ihre App benötigt. Wenn Sie beispielsweise nach dem Namen einer Person fragen, aber ausdrücklich den Nachnamen benötigen, schreiben Sie surname anstelle von name.

Erforderlich, wenn hintText nicht angegeben ist. Andernfalls ist dies optional.

hintText

string

Text, der unter dem Texteingabefeld angezeigt wird und Nutzende zur Eingabe eines bestimmten Werts auffordert. Dieser Text ist immer sichtbar.

Erforderlich, wenn label nicht angegeben ist. Andernfalls ist dies optional.

value

string

Der von einem Nutzer eingegebene Wert, der bei einem Formulareingabeereignis zurückgegeben wurde.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.

type

enum (Type)

So wird ein Texteingabefeld in der Benutzeroberfläche angezeigt. Gibt beispielsweise an, ob das Feld ein- oder mehrzeilig ist.

onChangeAction

object (Action)

Was ist zu tun, wenn eine Änderung im Texteingabefeld vorgenommen wird? Zum Beispiel, wenn ein Nutzer etwas in das Feld einfügt oder Text löscht.

Beispiele für mögliche Aktionen sind das Ausführen einer benutzerdefinierten Funktion oder das Öffnen eines Dialogfelds in Google Chat.

initialSuggestions

object (Suggestions)

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Nutzende in das Texteingabefeld klicken. Während der Eingabe werden die vorgeschlagenen Werte dynamisch gefiltert, damit sie der Eingabe entsprechen.

Ein Texteingabefeld für eine Programmiersprache könnte beispielsweise Java, JavaScript, Python und C++ vorschlagen. Wenn Nutzer beginnen, Jav einzugeben, wird in der Liste der Vorschlagsfilter nur Java und JavaScript angezeigt.

Vorgeschlagene Werte helfen Nutzern dabei, Werte einzugeben, die in Ihrer App verständlich sind. Wenn es sich um JavaScript handelt, geben einige Nutzer möglicherweise javascript und andere java script ein. Wenn du JavaScript vorschlägst, kann die Interaktion von Nutzern mit deiner App standardisiert werden.

Wenn angegeben, ist TextInput.type immer SINGLE_LINE, auch wenn es auf MULTIPLE_LINE festgelegt ist.

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

autoCompleteAction

object (Action)

Optional. Geben Sie an, welche Aktion ausgeführt werden soll, wenn das Texteingabefeld Nutzern, die damit interagieren, Vorschläge macht.

Ist kein Wert angegeben, werden die Vorschläge von initialSuggestions festgelegt und vom Client verarbeitet.

Wenn angegeben, führt die App die hier angegebene Aktion aus, z. B. das Ausführen einer benutzerdefinierten Funktion.

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

placeholderText

string

Text, der im Texteingabefeld erscheint, wenn das Feld leer ist. Mit diesem Text werden Nutzer zur Eingabe eines Werts aufgefordert. Beispiel: Enter a number from 0 to 100.

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

Typ

Enums
SINGLE_LINE Das Texteingabefeld hat eine feste Höhe von einer Zeile.
MULTIPLE_LINE Das Texteingabefeld hat eine feste Höhe von mehreren Zeilen.

Aktion

Eine Aktion, die das Verhalten beim Senden des Formulars beschreibt. Sie können beispielsweise ein Apps Script-Skript aufrufen, um das Formular zu verarbeiten. Wird die Aktion ausgelöst, 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)
}
Felder
function

string

Eine benutzerdefinierte Funktion, die ausgelöst wird, wenn auf das Containerelement geklickt oder es anderweitig aktiviert wird.

Informationen zur Verwendung finden Sie unter Interaktive Karten erstellen.

parameters[]

object (ActionParameter)

Liste der Aktionsparameter.

loadIndicator

enum (LoadIndicator)

Gibt die Ladeanzeige an, die die Aktion anzeigt, während der Call-to-die-Aktion ausgeführt wird.

persistValues

boolean

Gibt an, ob Formularwerte nach der Aktion erhalten bleiben. Der Standardwert ist false.

Beim Wert true bleiben Formularwerte erhalten, nachdem die Aktion ausgelöst wurde. Damit der Nutzer Änderungen vornehmen kann, während die Aktion verarbeitet wird, setze LoadIndicator auf NONE. Bei Kartennachrichten in Chat-Apps musst du auch den ResponseType der Aktion auf UPDATE_MESSAGE setzen und denselben cardId von der Karte verwenden, die die Aktion enthielt.

Bei false werden die Formularwerte gelöscht, wenn die Aktion ausgelöst wird. Um zu verhindern, dass der Nutzer Änderungen vornimmt, während die Aktion verarbeitet wird, setzen Sie LoadIndicator auf SPINNER.

interaction

enum (Interaction)

Optional. Erforderlich beim Öffnen eines Dialogfelds.

Was Sie als Reaktion auf eine Interaktion mit einem Nutzer tun sollten, z. B. wenn ein Nutzer auf eine Schaltfläche in einer Kartennachricht klickt.

Wenn keine Angabe erfolgt, führt die Anwendung wie gewohnt ein action aus, z. B. das Öffnen eines Links oder das Ausführen einer Funktion.

Durch Angabe eines interaction kann die App auf spezielle interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG setzen, kann über die Anwendung ein Dialogfeld geöffnet werden. Wenn angegeben, wird keine Ladeanzeige angezeigt. Wenn dieses Attribut für ein Add-on angegeben wird, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

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

ActionParameter

Liste der Zeichenfolgenparameter, die beim Aufrufen der Aktionsmethode angegeben werden sollen. Stellen Sie sich zum Beispiel drei Schlummerschaltflächen vor: „Jetzt pausieren“, „An einem 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 anzeigt, während der Call-to-die-Aktion ausgeführt wird.

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

Enums
SPINNER Ein rotierendes Ladesymbol zeigt an, dass Inhalte geladen werden.
NONE Es wird nichts angezeigt.

Interaktion

Optional. Erforderlich beim Öffnen eines Dialogfelds.

Was Sie als Reaktion auf eine Interaktion mit einem Nutzer tun sollten, z. B. wenn ein Nutzer auf eine Schaltfläche in einer Kartennachricht klickt.

Wenn keine Angabe erfolgt, führt die Anwendung wie gewohnt ein action aus, z. B. das Öffnen eines Links oder das Ausführen einer Funktion.

Durch Angabe eines interaction kann die App auf spezielle interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG setzen, kann über die Anwendung ein Dialogfeld geöffnet werden.

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

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

Enums
INTERACTION_UNSPECIFIED Standardwert. action wird wie gewohnt ausgeführt.
OPEN_DIALOG

Öffnet ein Dialogfeld, eine kartenbasierte Oberfläche mit Fenstern, über die Chat-Apps mit Nutzern interagieren.

Wird nur von Chat-Apps als Reaktion auf Klicks auf Schaltflächen auf Nachrichten unterstützt. Wenn dieses Attribut für ein Add-on angegeben wird, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

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

Vorschläge

JSON-Darstellung
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
Felder
items[]

object (SuggestionItem)

Eine Liste von Vorschlägen, die für automatisch vervollständigte Empfehlungen in Texteingabefeldern verwendet werden.

SuggestionItem

JSON-Darstellung
{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Felder

Union-Feld content.

Für content ist nur einer der folgenden Werte zulässig:

text

string

Der Wert einer vorgeschlagenen Eingabe für ein Texteingabefeld. Dies entspricht dem, was die Nutzer selbst eingeben.

Fehlerbehebung

Wenn eine Google Chat-App oder Google Chat-Karte einen Fehler zurückgibt, wird in der Chat-Oberfläche die Meldung „Ein Fehler ist aufgetreten“ oder „Ihre Anfrage kann nicht verarbeitet werden“ angezeigt. Manchmal wird in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte führt zu einem unerwarteten Ergebnis, z. B. dass keine Kartennachricht angezeigt wird.

Obwohl eine Fehlermeldung möglicherweise nicht in der Chat-Benutzeroberfläche angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, mit denen Sie Fehler beheben können, wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Informationen zum Aufrufen, Debuggen und Beheben von Fehlern finden Sie im Hilfeartikel Google Chat-Fehler beheben.