TextInput

대화상자에서만 지원됩니다. 카드 메시지도 곧 지원됩니다.

TextInput 위젯은 사용자가 텍스트를 입력할 수 있는 필드를 제공합니다. 위젯은 사용자가 동일한 데이터를 입력할 수 있는 추천 기능 및 사용자가 텍스트를 추가하거나 삭제하는 등 텍스트 입력란에서 변경사항이 발생할 때 실행되는 Actions 작업 시 이를 지원합니다.

사용자로부터 추상 데이터 또는 알 수 없는 데이터를 수집해야 하는 경우 이 TextInput 위젯을 사용하세요. 사용자로부터 정의된 데이터를 수집하려면 대신 SelectionInput 위젯을 사용하세요.

채팅 앱은 양식 입력 이벤트 중에 입력된 텍스트의 값을 수신하고 처리할 수 있습니다. 양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.

예

다음 이미지는 TextInput 위젯으로 구성된 카드를 보여줍니다.

다양한 위젯이 포함된 대화상자
그림 1: 사용자가 주소록의 새 연락처를 만드는 데 도움이 되는 대화상자. 이름 및 주소 필드는 TextInput 위젯입니다.

카드의 JSON은 다음과 같습니다.

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 JSON 표현 및 필드

JSON 표현 
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  }
}
필드
name

string

양식 입력 이벤트에서 텍스트 입력이 식별되는 이름입니다.

양식 입력 작업에 관한 자세한 내용은 양식 데이터 수신 을 참고하세요.

label

string

사용자 인터페이스의 텍스트 입력란 위에 표시되는 텍스트입니다.

사용자가 앱에 필요한 정보를 입력하는 데 도움이 되는 텍스트를 지정합니다. 예를 들어 이름을 물어보면서 구체적으로 성이 필요한 경우 'name' 대신 'surname'을 입력합니다.

hintText 이 지정되지 않은 경우 필요합니다. 그렇지 않으면 선택사항입니다.

hintText

string

사용자에게 특정 값을 입력하라는 메시지를 표시하여 사용자를 지원하기 위한 텍스트 입력란 아래에 표시되는 텍스트입니다. 이 텍스트는 항상 표시됩니다.

label 이 지정되지 않은 경우 필요합니다. 그렇지 않으면 선택사항입니다.

value

string

사용자가 입력한 값으로, 양식 입력 이벤트의 일부로 반환됩니다.

양식 입력 작업에 관한 자세한 내용은 양식 데이터 수신 을 참고하세요.

type

enum ( Type )

사용자 인터페이스에 텍스트 입력란이 표시되는 방식입니다. 예를 들면 필드가 한 줄인지 여러 줄인지 나타냅니다.

onChangeAction

object ( Action )

텍스트 입력란에서 변경이 발생한 경우 취해야 할 조치

변경 예시로는 사용자가 필드에 추가하거나 텍스트를 삭제하는 경우가 있습니다.

실행할 작업의 예로는 맞춤 함수를 실행하거나 Google Chat에서 대화상자 를 여는 작업이 있습니다.

initialSuggestions

object ( Suggestions )

사용자가 입력할 수 있는 권장 값입니다. 이 값은 사용자가 텍스트 입력란 내부를 클릭할 때 표시됩니다. 사용자가 값을 입력할 때 추천 값은 사용자가 입력한 내용과 일치하도록 동적으로 필터링됩니다.

예를 들어 프로그래밍 언어의 텍스트 입력란에 자바, 자바스크립트, Python 및 C++를 제안할 수 있습니다. 사용자가 'Jav'를 입력하기 시작하면 자바와 자바스크립트만 표시되도록 추천 필터 목록이 표시됩니다.

추천 값은 사용자가 앱에서 이해할 수 있는 값을 입력하는 데 도움이 됩니다. 자바스크립트를 언급할 때 일부 사용자는 'javascript'를 입력하고 다른 사용자는 '자바스크립트'를 입력할 수 있습니다. '자바스크립트'를 사용하면 사용자가 앱과 상호작용하는 방식을 표준화할 수 있습니다.

지정된 경우 TextInput.type 은 MULTIPLE_LINE 로 설정되어 있어도 항상 SINGLE_LINE 입니다.

autoCompleteAction

object ( Action )

선택사항. 텍스트 입력란이 입력란과 상호작용하는 사용자에게 제안을 제공할 때 실행할 작업을 지정합니다.

지정하지 않으면 initialSuggestions 에서 추천을 설정하고 클라이언트에서 처리합니다.

지정하면 앱이 여기에 지정된 작업(예: 맞춤 함수 실행)을 실행합니다.

Google Workspace 부가기능에서는 지원되지만 Chat 앱에서는 지원되지 않습니다. Chat 앱에서도 곧 지원될 예정입니다.

Suggestions JSON 표현 및 필드

JSON 표현 
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
필드
items[]

object ( SuggestionItem )

텍스트 입력란의 자동 완성 추천에 사용되는 제안 목록입니다.

SuggestionItem JSON 표현 및 필드

JSON 표현 
{

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

공용체 필드 content .

content 는 다음 중 하나여야 합니다.

text

string

텍스트 입력란에 대한 추천 입력 값입니다. 사용자가 직접 입력하는 것과 같습니다.