Wprowadzanie tekstu

Widżet TextInput zawiera pole, w którym użytkownicy mogą wpisać tekst. Widżet obsługuje sugestie, które ułatwiają użytkownikom wpisywanie ujednoliconych danych, a także działania powodujące zmianę, czyli działania Actions uruchamiane po wprowadzeniu zmiany w polu wprowadzania tekstu, np. dodanie lub usunięcie tekstu.

Jeśli chcesz zbierać abstrakcyjne lub nieznane dane użytkowników, używaj tego widżetu TextInput. Aby zbierać określone dane od użytkowników, użyj widżetu SelectionInput.

Aplikacje do obsługi czatu otrzymują i przetwarzają wartość wprowadzanego tekstu podczas zdarzeń w formularzu. Więcej informacji o korzystaniu z danych wejściowych formularza znajdziesz w artykule Odbieranie danych formularza.

Przykład

Poniższa ilustracja przedstawia kartę zawierającą widżet TextInput.

Okno z różnymi widżetami.
Ilustracja 1. Okno pomagające użytkownikowi utworzyć nowy kontakt w przypadku książki adresowej Pola nazwy i adresów to TextInput widżety.

Oto kod JSON karty:

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"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Reprezentacja i pola JSON

Zapis JSON
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  }
}
Pola
name

string

Nazwa określająca dane wejściowe w zdarzeniu wprowadzania danych z formularza.

Więcej informacji na temat pracy z danymi z formularzy znajdziesz w artykule Odbieranie danych formularza.

label

string

Tekst wyświetlany nad polem wprowadzania tekstu w interfejsie.

Podaj tekst, który pomoże użytkownikowi wpisać informacje, których potrzebuje Twoja aplikacja. Jeśli na przykład prosisz kogoś o imię, ale potrzebujesz imienia, wpisz surname zamiast name.

Wymagany, jeśli właściwość hintText nie jest określona. W przeciwnym razie (opcjonalnie).

hintText

string

Tekst wyświetlany pod polem wprowadzania tekstu, który ma zachęcić użytkowników do wpisania określonej wartości. Ten tekst jest zawsze widoczny.

Wymagany, jeśli właściwość label nie jest określona. W przeciwnym razie (opcjonalnie).

value

string

Wartość wpisana przez użytkownika, zwracana w ramach zdarzenia wejściowego formularza.

Więcej informacji na temat pracy z danymi z formularzy znajdziesz w artykule Odbieranie danych formularza.

type

enum (Type)

Sposób, w jaki w interfejsie wyświetlane jest pole do wprowadzania tekstu. np. czy pole jest jednowierszowe czy wielowierszowe.

onChangeAction

object (Action)

Co zrobić, gdy w polu tekstowym pojawi się zmiana. Na przykład użytkownik dodający do pola lub usuwając tekst.

Przykładowe działania to uruchomienie własnej funkcji lub otwarcie okna w Google Chat.

initialSuggestions

object (Suggestions)

Sugerowane wartości, które użytkownicy mogą wpisać. Te wartości pojawiają się, gdy użytkownicy klikają pole do wprowadzania tekstu. Gdy użytkownicy piszą, sugerowane wartości są dynamicznie filtrowane zgodnie z wpisanym tekstem.

Na przykład pole do wprowadzania tekstu w języku programowania może proponować język Java, JavaScript, Python i C++. Gdy użytkownicy zaczną wpisywać Jav, na liście sugestii pojawią się filtry Java i JavaScript.

Sugerowane wartości pomagają użytkownikom wpisywać wartości, które mogą być przydatne w aplikacji. Gdy odwołujemy się do JavaScriptu, niektórzy użytkownicy mogą wpisać javascript, a inne java script. Sugerowanie właściwości JavaScript może ujednolicić sposób interakcji użytkowników z aplikacją.

Jeśli zasada jest określona, właściwość TextInput.type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawiona na MULTIPLE_LINE.

autoCompleteAction

object (Action)

Opcjonalnie. Określ, jakie działania mają być wykonywane, gdy pole do wprowadzania tekstu zawiera sugestie dla użytkowników, którzy z niego korzystają.

Jeśli nie określono inaczej, sugestie są ustawiane przez zasadę initialSuggestions i są przetwarzane przez klienta.

Jeśli zasada jest skonfigurowana, aplikacja wykonuje opisane tu działanie, takie jak uruchamianie funkcji niestandardowej.

Obsługiwana przez dodatki do Google Workspace, ale nie przez aplikacje Google Chat.

Typ

Wartości w polu enum
SINGLE_LINE Pole do wprowadzania tekstu ma stałą wysokość 1 wiersza.
MULTIPLE_LINE Pole do wprowadzania tekstu ma stałą wysokość wielu wierszy.

Czynność

Działanie opisujące zachowanie podczas przesyłania formularza. Możesz na przykład wywołać skrypt Apps Script, aby obsłużyć formularz. Jeśli działanie zostanie aktywowane, wartości formularza zostaną przesłane na serwer.

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

string

Funkcja niestandardowa, która ma być wywoływana po kliknięciu lub aktywowaniu elementu zawierającego.

Więcej informacji znajdziesz w artykule Tworzenie interaktywnych kart.

parameters[]

object (ActionParameter)

Lista parametrów działania.

loadIndicator

enum (LoadIndicator)

Określa wskaźnik wczytywania wyświetlany podczas wykonywania działania.

persistValues

boolean

Wskazuje, czy po formularzu działanie formularza pozostaje aktywne. Wartością domyślną jest false.

Jeśli pole true zawiera wartości, po wypełnieniu pola działanie pozostaje aktywne. Aby pozwolić użytkownikowi na wprowadzanie zmian podczas przetwarzania działania, ustaw LoadIndicator na NONE. W przypadku kart kart w aplikacjach Google Chat musisz też ustawić wartość ResponseType dla działania na UPDATE_MESSAGE i użyć tej samej wartości cardId z karty, która zawiera działanie.

Jeśli false, wartości formularza zostaną wyczyszczone po wywołaniu działania. Aby uniemożliwić użytkownikowi wprowadzanie zmian podczas przetwarzania działania, ustaw wartość LoadIndicator na SPINNER.

interaction

enum (Interaction)

Opcjonalnie. Wymagane przy otwieraniu okna.

Co zrobić w odpowiedzi na interakcję użytkownika, np. kliknięcie przycisku w wiadomości na karcie.

Jeśli nie określono inaczej, aplikacja reaguje w zwykły sposób, uruchamiając action, np. otwierając link lub uruchamiając funkcję.

Jeśli określisz interaction, aplikacja może reagować w specjalny sposób. Jeśli na przykład ustawisz interaction na wartość OPEN_DIALOG, aplikacja będzie mogła otwierać okno. Jeśli podasz wartość, wskaźnik ładowania się nie wyświetli.

Obsługiwane przez aplikacje do obsługi czatu, ale nie w ramach dodatków do Google Workspace. Jeśli dodatek jest określony jako dodatek, cała karta jest usuwana i nic nie jest wyświetlane w kliencie.

Parametr działania

Lista parametrów ciągu znaków, które mają zostać podane po wywołaniu metody działania. Możesz np. wybrać 3 przyciski drzemki: drzemka teraz, drzemka na dzień lub drzemkę w przyszłym tygodniu. Można użyć właściwości action method = snooze(), przekazując typ drzemki i czas drzemki na liście parametrów ciągu znaków.

Więcej informacji: CommonEventObject.

Zapis JSON
{
  "key": string,
  "value": string
}
Pola
key

string

Nazwa parametru skryptu działania.

value

string

Wartość parametru.

Wskaźnik obciążenia

Określa wskaźnik wczytywania wyświetlany podczas wykonywania działania.

Wartości w polu enum
SPINNER Wyświetla wskaźnik postępu wczytywania treści.
NONE Nic nie jest wyświetlane.

Interakcja

Opcjonalnie. Wymagane przy otwieraniu okna.

Co zrobić w odpowiedzi na interakcję użytkownika, np. kliknięcie przycisku w wiadomości na karcie.

Jeśli nie określono inaczej, aplikacja reaguje w zwykły sposób, uruchamiając action, np. otwierając link lub uruchamiając funkcję.

Jeśli określisz interaction, aplikacja może reagować w specjalny sposób. Jeśli na przykład ustawisz interaction na wartość OPEN_DIALOG, aplikacja będzie mogła otwierać okno.

Jeśli podasz wartość, wskaźnik ładowania się nie wyświetli.

Obsługiwane przez aplikacje do obsługi czatu, ale nie w ramach dodatków do Google Workspace. Jeśli dodatek jest określony jako dodatek, cała karta jest usuwana i nic nie jest wyświetlane w kliencie.

Wartości w polu enum
INTERACTION_UNSPECIFIED Wartość domyślna. action działa normalnie.
OPEN_DIALOG

Otwiera okno – interfejs użytkownika w postaci okna, który umożliwia aplikacjom Google Chat interakcję z użytkownikami.

Obsługiwane tylko przez aplikacje do obsługi czatu w odpowiedzi na kliknięcie przycisku na karcie.

Nieobsługiwane przez dodatki do Google Workspace. Jeśli dodatek jest określony jako dodatek, cała karta jest usuwana i nic nie jest wyświetlane w kliencie.

Sugestie

Zapis JSON
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
Pola
items[]

object (SuggestionItem)

Lista sugestii używanych do autouzupełniania rekomendacji w polach wprowadzania tekstu.

Sugestia elementu

Zapis JSON
{

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

Pole sumy: content.

content może być tylko jedną z tych wartości:

text

string

Wartość sugerowanego pola wprowadzania tekstu. Jest to odpowiednik tekstu wpisanego przez użytkownika.