このページは Cloud Translation API によって翻訳されました。

Class TextInput

テキスト入力を受け付ける入力フィールドウィジェット。

フォーム送信の検証をサポートします。Action.setAllWidgetsAreRequired(allWidgetsAreRequired) が true に設定されている場合、またはこのウィジェットが Action.addRequiredWidget(requiredWidget) で指定されている場合、値が入力されない限り送信アクションはブロックされます。

Google Workspace アドオンと Google Chat アプリで利用できます。

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint');

メソッド

メソッド	戻り値の型	概要
`addEventAction(eventAction)`	`Widget`	ウィジェットで実行できるイベントアクションを追加します。
`setFieldName(fieldName)`	`TextInput`	UI 操作が発生したときに生成されるイベントオブジェクトで、このテキスト入力を識別するキーを設定します。
`setHint(hint)`	`TextInput`	テキスト入力のヒントを設定します。
`setHostAppDataSource(hostAppDataSource)`	`TextInput`	Google Workspace アプリケーションからデータソースを設定します。
`setId(id)`	`Widget`	変更するウィジェットの識別に使用される一意の ID を設定します。
`setInputMode(inputMode)`	`TextInput`	このテキスト入力フィールドが変数の挿入をサポートするかどうかを設定します。
`setMultiline(multiline)`	`TextInput`	入力テキストを 1 行で表示するか複数行で表示するかを設定します。
`setOnChangeAction(action)`	`TextInput`	テキスト入力が変更されるたびに実行されるアクションを設定します。
`setSuggestions(suggestions)`	`TextInput`	テキストフィールドのオートコンプリートの候補を設定します。
`setSuggestionsAction(suggestionsAction)`	`TextInput`	予測入力のユーザー入力に基づいて候補を取得するコールバックアクションを設定します。
`setTitle(title)`	`TextInput`	入力フィールドの上に表示されるタイトルを設定します。
`setValidation(validation)`	`TextInput`	このウィジェットの検証ルールを設定します。
`setValue(value)`	`TextInput`	入力フィールドに設定する事前入力値を設定します。
`setVisibility(visibility)`	`Widget`	ウィジェットの可視性を設定します。

詳細なドキュメント

`addEventAction(eventAction)`

ウィジェットで実行できるイベントアクションを追加します。

パラメータ

名前	型	説明
`eventAction`	`EventAction`	追加する `EventAction`。

戻る

Widget - チェーン用の Object。

`setFieldName(fieldName)`

UI 操作が発生したときに生成されるイベントオブジェクトで、このテキスト入力を識別するキーを設定します。ユーザーには表示されません。必須。一意である必要があります。

パラメータ

名前	型	説明
`fieldName`	`String`	この入力を識別するために使用されるキー。

戻る

TextInput - チェーン用のこのオブジェクト。

`setHint(hint)`

テキスト入力のヒントを設定します。入力内容についてユーザーに追加のガイダンスを提供するために使用されます。たとえば、電話番号フィールドの形式（「xxx-xxx-xxxx」）をヒントで説明できます。

パラメータ

名前	型	説明
`hint`	`String`	入力フィールドの下に表示するテキストヒント。このテキストは常に表示されます。

戻る

TextInput - チェーン用のこのオブジェクト。

`setHostAppDataSource(hostAppDataSource)`

Google Workspace アプリケーションからデータソースを設定します。現在、ユーザーと Chat スペースをサポートしています。

Google Workspace Studio を拡張する Google Workspace アドオンでのみ使用できます。

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);

パラメータ

名前	型	説明
`hostAppDataSource`	`HostAppDataSource`	データソース。

戻る

TextInput - チェーン用のこのオブジェクト。

`setId(id)`

変更するウィジェットの識別に使用される一意の ID を設定します。ウィジェットの変更はアドオンでのみサポートされています。

パラメータ

名前	型	説明
`id`	`String`	ウィジェットの ID。64 文字以内で、`[a-zA-Z0-9-]+` の形式で指定します。

戻る

Widget - チェーン用のこのオブジェクト。

`setInputMode(inputMode)`

このテキスト入力フィールドが変数の挿入をサポートするかどうかを設定します。

Google Workspace Studio を拡張する Google Workspace アドオンでのみ使用できます。

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

パラメータ

名前	型	説明
`inputMode`	`TextInputMode`	このテキスト入力フィールドで許可される入力のタイプ。変数の挿入をサポートするには、RICH_TEXT を使用します。

戻る

TextInput - チェーン用のこのオブジェクト。

`setMultiline(multiline)`

入力テキストを 1 行で表示するか複数行で表示するかを設定します。

パラメータ

名前	型	説明
`multiline`	`Boolean`	複数行の設定。

戻る

TextInput - チェーン用のこのオブジェクト。

`setOnChangeAction(action)`

テキスト入力が変更されるたびに実行されるアクションを設定します。

パラメータ

名前	型	説明
`action`	`Action`	実行する操作。

戻る

TextInput - チェーン用のこのオブジェクト。

`setSuggestions(suggestions)`

テキストフィールドのオートコンプリートの候補を設定します。

パラメータ

名前	型	説明
`suggestions`	`Suggestions`	使用する候補のコレクション。

戻る

TextInput - チェーン用のこのオブジェクト。

`setSuggestionsAction(suggestionsAction)`

ユーザー入力に基づいて予測入力の候補を取得するコールバックアクションを設定します。Action パラメータは、SuggestionsResponse オブジェクトを返すコールバック関数を指定する必要があります。

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();
}

パラメータ

名前	型	説明
`suggestionsAction`	`Action`	この入力の候補を取得するアクション。

戻る

TextInput - チェーン用のこのオブジェクト。

`setTitle(title)`

入力フィールドの上に表示されるタイトルを設定します。必須。

パラメータ

名前	型	説明
`title`	`String`	この入力のテキストラベル。

戻る

TextInput - チェーン用のこのオブジェクト。

`setValidation(validation)`

このウィジェットの検証ルールを設定します。

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

パラメータ

名前	型	説明
`validation`	`Validation`	この `TextInput` ウィジェットの検証ルール。

戻る

TextInput - チェーン用のこのオブジェクト。

`setValue(value)`

入力フィールドに設定する事前入力値を設定します。

パラメータ

名前	型	説明
`value`	`String`	入力に配置されるデフォルト値。フォームコールバックパラメータでは常に文字列として表されます。

戻る

TextInput - チェーン用のこのオブジェクト。

`setVisibility(visibility)`

ウィジェットの可視性を設定します。デフォルト値は `VISIBLE` です。

パラメータ

名前	型	説明
`visibility`	`Visibility`	ウィジェットの `Visibility`。

戻る

Widget - チェーン用の Object。

Class TextInput コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

詳細なドキュメント

addEventAction(eventAction)

パラメータ

戻る

setFieldName(fieldName)

パラメータ

戻る

setHint(hint)

パラメータ

戻る

setHostAppDataSource(hostAppDataSource)

パラメータ

戻る

setId(id)

パラメータ

戻る

setInputMode(inputMode)

パラメータ

戻る

setMultiline(multiline)

パラメータ

戻る

setOnChangeAction(action)

パラメータ

戻る

setSuggestions(suggestions)

パラメータ

戻る

setSuggestionsAction(suggestionsAction)

パラメータ

戻る

setTitle(title)

パラメータ

戻る

setValidation(validation)

パラメータ

戻る

setValue(value)

パラメータ

戻る

setVisibility(visibility)

パラメータ

戻る

Class TextInput

`addEventAction(eventAction)`

`setFieldName(fieldName)`

`setHint(hint)`

`setHostAppDataSource(hostAppDataSource)`

`setId(id)`

`setInputMode(inputMode)`

`setMultiline(multiline)`

`setOnChangeAction(action)`

`setSuggestions(suggestions)`

`setSuggestionsAction(suggestionsAction)`

`setTitle(title)`

`setValidation(validation)`

`setValue(value)`

`setVisibility(visibility)`