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

Class SelectionInput

事前定義のオプションセットから選択するための入力フィールド。

Google Workspace アドオンと Google Chat アプリでご利用いただけます。

var checkboxGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.CHECK_BOX)
    .setTitle("A group of checkboxes. Multiple selections are allowed.")
    .setFieldName("checkbox_field")
    .addItem("checkbox one title", "checkbox_one_value", false)
    .addItem("checkbox two title", "checkbox_two_value", true)
    .addItem("checkbox three title", "checkbox_three_value", true)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleCheckboxChange"));

var radioGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.RADIO_BUTTON)
    .setTitle("A group of radio buttons. Only a single selection is allowed.")
    .setFieldName("checkbox_field")
    .addItem("radio button one title", "radio_one_value", true)
    .addItem("radio button two title", "radio_two_value", false)
    .addItem("radio button three title", "radio_three_value", false);

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description")
    .setMultiSelectMaxSelectedItems(3)
    .setMultiSelectMinQueryLength(1);

メソッド

メソッド	戻り値の型	概要
`addItem(text, value, selected)`	`SelectionInput`	選択可能な新しい項目を追加します。
`addMultiSelectItem(text, value, selected, startIconUri, bottomText)`	`SelectionInput`	複数選択メニューで選択できる新しい項目を追加します。
`setExternalDataSource(action)`	`SelectionInput`	リレーショナルデータベースなどの外部データソースを設定します。
`setFieldName(fieldName)`	`SelectionInput`	生成されたイベントオブジェクト内でこの選択入力を識別するキーを設定します。 UI 操作があります
`setMultiSelectMaxSelectedItems(maxSelectedItems)`	`SelectionInput`	ユーザーが選択できるアイテムの最大数を設定します。
`setMultiSelectMinQueryLength(queryLength)`	`SelectionInput`	アプリのクエリの予測入力と予測入力の前にユーザーが入力するテキスト文字数を設定します。カードにおすすめのアイテムが表示されます。
`setOnChangeAction(action)`	`SelectionInput`	選択入力が変更されたときに実行されるように `Action` を設定します。
`setPlatformDataSource(platformDataSource)`	`SelectionInput`	Google Workspace からデータソースを設定します。
`setTitle(title)`	`SelectionInput`	入力フィールドの前に表示されるタイトルを設定します。
`setType(type)`	`SelectionInput`	この入力の型を設定します。

詳細なドキュメント

`addItem(text, value, selected)`

選択可能な新しい項目を追加します。

パラメータ

名前	型	説明
`text`	`Object`	このアイテムに表示されるテキスト。文字列以外のプリミティブ引数は、自動的に作成されます。
`value`	`Object`	コールバック経由で送信されるフォームの入力値。文字列以外のプリミティブ引数自動的に文字列に変換されます。
`selected`	`Boolean`	アイテムがデフォルトで選択されるかどうか。選択入力が 1 つの値（ラジオボタンやプルダウンメニューなど）を指定する場合、このフィールドは 1 つのアイテムに対してのみ設定します。

戻る

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

`addMultiSelectItem(text, value, selected, startIconUri, bottomText)`

複数選択メニューで選択できる新しい項目を追加します。

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

パラメータ

名前	型	説明
`text`	`Object`	このアイテムに表示されるテキスト。文字列以外のプリミティブ引数は、自動的に作成されます。
`value`	`Object`	コールバック経由で送信されるフォームの入力値。文字列以外のプリミティブ引数自動的に文字列に変換されます。
`selected`	`Boolean`	アイテムがデフォルトで選択されるかどうか。選択入力が 1 つの値（ラジオボタンやプルダウンメニューなど）を指定する場合、このフィールドは 1 つのアイテムに対してのみ設定します。
`startIconUri`	`Object`	複数選択メニューの場合、アイテムの隣に表示されるアイコンの URL 入力します。PNG ファイルと JPEG ファイルをサポートします。
`bottomText`	`Object`	複数選択メニューの場合は、指定します。

戻る

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

`setExternalDataSource(action)`

リレーショナルデータベースなどの外部データソースを設定します。

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .setMultiSelectMaxSelectedItems(5)
    .setMultiSelectMinQueryLength(2)
    .setExternalDataSource(CardService.newAction().setFunctionName("getContacts"));

パラメータ

名前	型	説明
`action`	`Action`	外部データソース。

戻る

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

`setFieldName(fieldName)`

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

パラメータ

名前	型	説明
`fieldName`	`String`	この入力に割り当てる名前。

戻る

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

`setMultiSelectMaxSelectedItems(maxSelectedItems)`

ユーザーが選択できるアイテムの最大数を設定します。

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMaxSelectedItems(3)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

パラメータ

名前	型	説明
`maxSelectedItems`	`Integer`	アイテムの最大数。

戻る

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

`setMultiSelectMinQueryLength(queryLength)`

アプリのクエリの予測入力と予測入力の前にユーザーが入力するテキスト文字数を設定します。カードにおすすめのアイテムが表示されます。

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMinQueryLength(1)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

パラメータ

名前	型	説明
`queryLength`	`Integer`	テキストの文字数。

戻る

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

`setOnChangeAction(action)`

選択入力が変更されたときに実行されるように Action を設定します。

パラメータ

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

戻る

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

`setPlatformDataSource(platformDataSource)`

Google Workspace からデータソースを設定します。複数選択メニューのアイテムを入力するために使用されます。

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .setPlatformDataSource(
       CardService.newPlatformDataSource()
         .setCommonDataSource(CardService.CommonDataSource.USER));

Google Chat アプリでのみ使用できます。Google Workspace アドオンではご利用いただけません。

パラメータ

名前	型	説明
`platformDataSource`	`PlatformDataSource`	データソース。

戻る

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

`setTitle(title)`

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

パラメータ

名前	型	説明
`title`	`String`	入力フィールドのタイトル。

戻る

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

`setType(type)`

この入力の型を設定します。デフォルトは CHECKBOX です。

パラメータ

名前	型	説明
`type`	`SelectionInputType`	選択タイプ。

戻る

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