Ein Eingabefeld-Widget, das Texteingaben akzeptiert.
Unterstützt die Validierung von Formulareinsendungen. Wenn Action.setAllWidgetsAreRequired(allWidgetsAreRequired) auf true festgelegt ist oder dieses Widget über Action.addRequiredWidget(requiredWidget) angegeben wird, wird die Aktion zum Senden blockiert, sofern kein Wert eingegeben wird.
Verfügbar für Google Workspace-Add‑ons und Google Chat-Apps.
const textInput = CardService.newTextInput() .setFieldName('text_input_form_input_key') .setTitle('Text input title') .setHint('Text input hint');
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Text | Legt den Schlüssel fest, mit dem diese Texteingabe im Ereignisobjekt identifiziert wird, das bei einer UI-Interaktion generiert wird. |
set | Text | Legt einen Hinweis für die Texteingabe fest. |
set | Text | Legt eine Datenquelle aus Google Workspace-Anwendungen fest. |
set | Text | Legt fest, ob der eingegebene Text in einer oder mehreren Zeilen angezeigt wird. |
set | Text | Legt eine Aktion fest, die ausgeführt werden soll, wenn sich die Texteingabe ändert. |
set | Text | Legt die Vorschläge für die automatische Vervollständigung im Textfeld fest. |
set | Text | Legt die Callback-Aktion fest, mit der Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abgerufen werden. |
set | Text | Legt den Titel fest, der über dem Eingabefeld angezeigt werden soll. |
set | Text | Legt die Validierungsregel für dieses Widget fest. |
set | Text | Legt den vorab ausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll. |
Detaillierte Dokumentation
set
Legt den Schlüssel fest, mit dem diese Texteingabe im Ereignisobjekt identifiziert wird, das bei einer UI-Interaktion generiert wird. Für den Nutzer nicht sichtbar. Erforderlich, muss eindeutig sein.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
field | String | Der Schlüssel, mit dem diese Eingabe identifiziert wird. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
Legt einen Hinweis für die Texteingabe fest. Wird verwendet, um dem Nutzer zusätzliche Hinweise dazu zu geben, was er eingeben soll. Ein Hinweis könnte beispielsweise die Formatierung („xxx-xxx-xxxx“) für ein Telefonnummernfeld beschreiben.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
hint | String | Der Texthinweis, der unter dem Eingabefeld angezeigt werden soll. Dieser Text ist immer sichtbar. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
Legt eine Datenquelle aus Google Workspace-Anwendungen fest. Derzeit werden Nutzer und Chatbereiche unterstützt.
Nur über das Gemini Alpha-Programm für Google Workspace-Add‑ons verfügbar, die Google Workspace Flows erweitern.
const workflowDataSource = CardService.newWorkflowDataSource().setIncludeVariables(true); const hostAppDataSource = CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource); const textInput = CardService.newTextInput() .setFieldName('text_input_form_input_key') .setTitle('Text input title') .setHint('Text input hint') .setHostAppDataSource(hostAppDataSource);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
host | Host | Die Datenquelle. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
Legt fest, ob der eingegebene Text in einer oder mehreren Zeilen angezeigt wird.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
multiline | Boolean | Die Einstellung für mehrere Zeilen. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
set
Legt die Vorschläge für die automatische Vervollständigung im Textfeld fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
suggestions | Suggestions | Die Sammlung der Vorschläge, die verwendet werden sollen. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
Legt die Callback-Aktion fest, mit der Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abgerufen werden. Der Parameter Action muss eine Callback-Funktion angeben, die ein Suggestions-Objekt zurückgibt.
const action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({numSuggestions: 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { const suggestions = CardService.newSuggestions(); const numSuggestions = Number.parseInt(e.parameter.numSuggestions); for (let i = 1; i <= numSuggestions; i++) { suggestions.addSuggestion(`Suggestion ${i}`); } return CardService.newSuggestionsResponseBuilder() .setSuggestions(suggestions) .build(); }
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
suggestions | Action | Die Aktion, mit der Vorschläge für diese Eingabe abgerufen werden. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
Legt den Titel fest, der über dem Eingabefeld angezeigt werden soll. Erforderlich.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
title | String | Das Textlabel für diese Eingabe. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
Legt die Validierungsregel für dieses Widget fest.
const validation = CardService.newValidation().setCharacterLimit('10').setType( CardService.InputType.TEXT); const input = CardService.newTextInput() .setFieldName('text_name_xxx1') .setTitle('Max 10 characters') .setValidation(validation);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
validation | Validation | Die Validierungsregel für dieses Text-Widget. |
Rückflug
Text – Dieses Objekt zur Verkettung.
set
Legt den vorab ausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
value | String | Der Standardwert, der in die Eingabe eingefügt wird. Sie wird immer als String in den Formular-Callback-Parametern dargestellt. |
Rückflug
Text – Dieses Objekt zur Verkettung.