TextInput

Compatível apenas com caixas de diálogo. O suporte para mensagens de cartão estará disponível em breve.

O widget TextInput fornece um campo em que os usuários podem inserir texto. O widget é compatível com sugestões, que ajudam os usuários a inserir dados uniformes, e ações em mudanças, que são Actions executadas quando uma mudança ocorre no campo de entrada de texto, como um usuário que adiciona ou exclui texto.

Quando precisar coletar dados abstratos ou desconhecidos de usuários, use este widget TextInput. Para coletar dados definidos dos usuários, use o widget SelectionInput.

Os apps de chat recebem e podem processar o valor do texto inserido durante os eventos de entrada do formulário. Veja mais detalhes sobre como trabalhar com entradas de formulário em Receber dados do formulário.

Exemplo

A imagem a seguir mostra um card que consiste em um widget TextInput.

Figura 1: uma caixa de diálogo ajuda o usuário a criar um novo contato para o catálogo de endereços. Os campos de nome e endereço são widgets TextInput.

Este é o JSON do cartão:

JSON

{
  "cardsV2": [
    {
      "cardId": "exampleCard",
      "card": {
        "sections": [
          {
            "header": "Add new contact",
            "widgets": [
              {
                "textInput": {
                  "label": "Name",
                  "type": "SINGLE_LINE",
                  "name": "contactName"
                }
              },
              {
                "textInput": {
                  "label": "Address",
                  "type": "MULTIPLE_LINE",
                  "name": "address"
                }
              },
              {
                "decoratedText": {
                  "text": "Add to favorites",
                  "switchControl": {
                    "controlType": "SWITCH",
                    "name": "saveFavorite"
                  }
                }
              },
              {
                "decoratedText": {
                  "text": "Merge with existing contacts",
                  "switchControl": {
                    "controlType": "SWITCH",
                    "name": "mergeContact",
                    "selected": true
                  }
                }
              },
              {
                "buttonList": {
                  "buttons": [
                    {
                      "text": "Next",
                      "onClick": {
                        "action": {
                          "function": "openSequentialDialog"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

TextInput representação e campos JSON

Representação JSON
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum (Type), "onChangeAction": { object (Action) }, "initialSuggestions": { object (Suggestions) }, "autoCompleteAction": { object (Action) } }

Campos
name	string O nome pelo qual a entrada de texto é identificada em um evento de entrada do formulário. Para ver detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário .
label	string O texto que aparece acima do campo de entrada da interface do usuário. Especifique o texto que ajuda o usuário a inserir as informações necessárias do app. Por exemplo, se você está perguntando o nome de alguém, mas precisa especificamente do sobrenome da pessoa, escreva "sobrenome" em vez de "nome". Obrigatório se hintText não for especificado. Caso contrário, é opcional.
hintText	string O texto que aparece abaixo do campo de entrada de texto serve para ajudar os usuários solicitando que insiram um determinado valor. Este texto está sempre visível. Obrigatório se label não for especificado. Caso contrário, é opcional.
value	string O valor inserido por um usuário, retornado como parte de um evento de entrada do formulário. Para ver detalhes sobre como trabalhar com entradas de formulário, consulte Receber dados de formulário .
type	enum ( Type ) Como um campo de entrada de texto aparece na interface do usuário. Por exemplo, se o campo tem uma ou várias linhas.
onChangeAction	object ( Action ) O que fazer quando ocorrer uma mudança no campo de entrada de texto. Exemplos de alterações incluem a adição de um usuário ao campo ou a exclusão de texto. Alguns exemplos de ações são executar uma função personalizada ou abrir uma caixa de diálogo no Google Chat.
initialSuggestions	object ( Suggestions ) Valores sugeridos que os usuários podem inserir. Esses valores aparecem quando os usuários clicam no campo de entrada de texto. Conforme os usuários digitam, os valores sugeridos filtram dinamicamente o que foi digitado. Por exemplo, um campo de entrada de texto para a linguagem de programação pode sugerir Java, JavaScript, Python e C++. Quando os usuários começam a digitar "Jav", a lista de filtros de sugestões para mostrar apenas Java e JavaScript. Os valores sugeridos ajudam a orientar os usuários a inserir valores que podem ser compreendidos pelo app. Ao se referir ao JavaScript, alguns usuários podem inserir "javascript" e outros "script script". Sugerir "JavaScript" pode padronizar a interação dos usuários com seu app. Quando especificado, TextInput.type é sempre SINGLE_LINE , mesmo que esteja definido como MULTIPLE_LINE .
autoCompleteAction	object ( Action ) Opcional. Especifique o que fazer quando o campo de entrada de texto sugerir algo aos usuários. Se não for especificada, as sugestões serão definidas por initialSuggestions e processadas pelo cliente. Se especificado, o app realiza a ação especificada aqui, como executar uma função personalizada. Com os complementos do Google Workspace, mas não os apps do Chat. O suporte dos apps de chat estará disponível em breve.

Suggestions representação e campos JSON

Representação JSON
{ "items": [ { object (SuggestionItem) } ] }

Campos
items[]	object ( SuggestionItem ) Uma lista de sugestões usadas para recomendações de preenchimento automático nos campos de entrada de texto.

SuggestionItem representação e campos JSON

Representação 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ão content . content pode ser apenas de um dos tipos a seguir:
text	string O valor de uma entrada sugerida para um campo de entrada de texto. Isso equivale ao que os usuários inseririam por conta própria.