Entrada de texto

El widget de TextInput proporciona un campo en el que los usuarios pueden ingresar texto. El widget admite sugerencias, que ayudan a los usuarios a ingresar datos uniformes, y acciones ante cambios, que son Actions y se ejecutan cuando se produce un cambio en el campo de entrada de texto, como cuando un usuario agrega o borra texto.

Cuando necesites recopilar datos abstractos o desconocidos de los usuarios, usa este widget de TextInput. Para recopilar datos definidos de los usuarios, usa el widget SelectionInput en su lugar.

Para procesar el texto que los usuarios ingresan, consulta Recibe datos del formulario.

La siguiente es una tarjeta que consta de un widget TextInput:

Representación de JSON y campos

Representación JSON
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum (Type), "onChangeAction": { object (Action) }, "initialSuggestions": { object (Suggestions) }, "autoCompleteAction": { object (Action) }, "placeholderText": string }

Campos
name	string El nombre con el que se identifica la entrada de texto en un evento de entrada de formulario. Para obtener información detallada sobre cómo trabajar con entradas de formularios, consulta Recibe datos de formularios.
label	string El texto que aparece sobre el campo de entrada de texto en la interfaz de usuario. Especifica un texto que ayude al usuario a ingresar la información que necesita tu app. Por ejemplo, si solicitas el nombre de una persona, pero necesitas específicamente su apellido, escribe surname en lugar de name. Es obligatorio si no se especifica hintText. De lo contrario, es opcional.
hintText	string Texto que aparece debajo del campo de entrada de texto para ayudar a los usuarios indicándoles que ingresen un valor determinado Este texto siempre es visible. Es obligatorio si no se especifica label. De lo contrario, es opcional.
value	string Es el valor ingresado por un usuario que se muestra como parte de un evento de entrada de formulario. Para obtener información detallada sobre cómo trabajar con entradas de formularios, consulta Recibe datos de formularios.
type	enum (Type) Cómo aparece un campo de entrada de texto en la interfaz de usuario Por ejemplo, si el campo es de una o varias líneas.
onChangeAction	object (Action) Qué hacer cuando se produce un cambio en el campo de entrada de texto Por ejemplo, un usuario que agrega elementos al campo o borra texto. Algunos ejemplos de acciones que se pueden realizar incluyen ejecutar una función personalizada o abrir un diálogo en Google Chat.
initialSuggestions	object (Suggestions) Valores sugeridos que los usuarios pueden ingresar. Estos valores aparecen cuando los usuarios hacen clic dentro del campo de entrada de texto. A medida que los usuarios escriben, los valores sugeridos se filtran de forma dinámica para coincidir con lo que escribieron los usuarios. Por ejemplo, un campo de entrada de texto para lenguaje de programación podría sugerir Java, JavaScript, Python y C++. Cuando los usuarios comienzan a escribir Jav, la lista de sugerencias filtra para mostrar solo Java y JavaScript. Los valores sugeridos ayudan a guiar a los usuarios para que ingresen valores que la app pueda comprender. Cuando se hace referencia a JavaScript, algunos usuarios pueden ingresar javascript y otros java script. Sugerir JavaScript puede estandarizar la forma en que los usuarios interactúan con tu app. Cuando se especifica, TextInput.type siempre es SINGLE_LINE, incluso si se establece en MULTIPLE_LINE.
autoCompleteAction	object (Action) Opcional. Especifica qué acción realizar cuando el campo de entrada de texto proporcione sugerencias a los usuarios que interactúan con él. Si no se especifican, initialSuggestions establece las sugerencias y el cliente las procesa. Si se especifica, la app realiza la acción que se especifica aquí, como ejecutar una función personalizada. Son compatibles con los complementos de Google Workspace, pero no con las apps de Google Chat.
placeholderText	string Texto que aparece en el campo de entrada de texto cuando el campo está vacío. Usa este texto para solicitar a los usuarios que ingresen un valor. Por ejemplo, Enter a number from 0 to 100. Son compatibles con las apps de Google Chat, pero no los complementos de Google Workspace.

Tipo

Enumeradores
SINGLE_LINE	El campo de entrada de texto tiene una altura fija de una línea.
MULTIPLE_LINE	El campo de entrada de texto tiene una altura fija de varias líneas.

Acción

Una acción que describe el comportamiento cuando se envía el formulario. Por ejemplo, puedes invocar una secuencia de comandos de Apps Script para controlar el formulario. Si se activa la acción, los valores del formulario se envían al servidor.

Representación JSON
{ "function": string, "parameters": [ { object (ActionParameter) } ], "loadIndicator": enum (LoadIndicator), "persistValues": boolean, "interaction": enum (Interaction) }

Campos
function	string Es una función personalizada que se invoca cuando se hace clic en el elemento contenedor o se activa de otro modo. Para ver ejemplos de uso, consulta Cómo crear tarjetas interactivas.
parameters[]	object (ActionParameter) Lista de parámetros de acción.
loadIndicator	enum (LoadIndicator) Especifica el indicador de carga que muestra la acción mientras se realiza la llamada a la acción.
persistValues	boolean Indica si los valores del formulario persisten después de la acción. El valor predeterminado es false. Si es true, los valores del formulario permanecen después de que se activa la acción. Para permitir que el usuario realice cambios mientras se procesa la acción, configura LoadIndicator como NONE. Para los mensajes de tarjetas en las apps de Chat, también debes configurar el ResponseType de la acción en UPDATE_MESSAGE y usar el mismo cardId de la tarjeta que contenía la acción. Si es false, los valores del formulario se borran cuando se activa la acción. Para evitar que el usuario haga cambios mientras se procesa la acción, establece LoadIndicator en SPINNER.
interaction	enum (Interaction) Opcional. Es obligatorio al abrir un diálogo. Qué hacer en respuesta a una interacción con un usuario, como cuando un usuario hace clic en un botón en un mensaje de tarjeta. Si no se especifica, la app responde con la ejecución normal de un elemento action, como abrir un vínculo o ejecutar una función. Cuando se especifica un interaction, la app puede responder de maneras interactivas especiales. Por ejemplo, si estableces interaction en OPEN_DIALOG, la app podrá abrir un diálogo. Cuando se especifica, no se muestra un indicador de carga. Son compatibles con las apps de Chat, pero no los complementos de Google Workspace. Si se especifica para un complemento, se quitará toda la tarjeta y no se mostrará nada en el cliente.

ActionParameter

Lista de parámetros de cadena que se deben proporcionar cuando se invoca el método de acción. Por ejemplo, considera tres botones para posponer: Posponer ahora, Posponer un día o Posponer la próxima semana. Puedes usar action method = snooze() y pasar el tipo y el tiempo de posposición en la lista de parámetros de cadena.

Para obtener más información, consulta CommonEventObject.

Representación JSON
{ "key": string, "value": string }

Campos
key	string El nombre del parámetro de la secuencia de comandos de acción.
value	string El valor del parámetro.

LoadIndicator

Especifica el indicador de carga que muestra la acción mientras se realiza la llamada a la acción.

Enumeradores
SPINNER	Muestra un ícono giratorio para indicar que se está cargando el contenido.
NONE	No se muestra nada.

Interacción

Opcional. Es obligatorio al abrir un diálogo.

Qué hacer en respuesta a una interacción con un usuario, como cuando un usuario hace clic en un botón en un mensaje de tarjeta.

Si no se especifica, la app responde con la ejecución normal de un elemento action, como abrir un vínculo o ejecutar una función.

Cuando se especifica un interaction, la app puede responder de maneras interactivas especiales. Por ejemplo, si estableces interaction en OPEN_DIALOG, la app podrá abrir un diálogo.

Cuando se especifica, no se muestra un indicador de carga.

Son compatibles con las apps de Chat, pero no los complementos de Google Workspace. Si se especifica para un complemento, se quitará toda la tarjeta y no se mostrará nada en el cliente.

Enumeradores
INTERACTION_UNSPECIFIED	Valor predeterminado action se ejecuta con normalidad.
OPEN_DIALOG	Abre un diálogo, una interfaz con ventanas y basadas en tarjetas que usan las apps de Chat para interactuar con los usuarios. Solo es compatible con apps de Chat en respuesta a clics en botones en mensajes de tarjetas. No es compatible con los complementos de Google Workspace. Si se especifica para un complemento, se quitará toda la tarjeta y no se mostrará nada en el cliente.

Sugerencias

Representación JSON
{ "items": [ { object (SuggestionItem) } ] }

Campos
items[]	object (SuggestionItem) Una lista de sugerencias usadas para las recomendaciones de autocompletar en los campos de entrada de texto.

SuggestionItem

Representación JSON
{ // Union field content can be only one of the following: "text": string // End of list of possible types for union field content. }

Campos
Campo de unión content. content solo puede ser una de las siguientes opciones:
text	string El valor de una entrada sugerida para un campo de entrada de texto. Esto equivale a lo que los usuarios ingresan.

Solución de problemas

Cuando una app o tarjeta de Google Chat devuelve un error, la interfaz de Chat muestra un mensaje que dice “Se produjo un error” o “No se pudo procesar tu solicitud”. A veces, la IU de Chat no muestra ningún mensaje de error, pero la app o la tarjeta de Chat producen un resultado inesperado; por ejemplo, es posible que no aparezca un mensaje de tarjeta.

Aunque es posible que no se muestre un mensaje de error en la IU de Chat, hay mensajes de error descriptivos y datos de registro disponibles para ayudarte a corregir errores cuando se activa el registro de errores de las apps de chat. Si necesitas ayuda para ver, depurar y corregir errores, consulta Cómo solucionar y corregir errores de Google Chat.