Class SelectionInput

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

Methods

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

詳細なドキュメント

addItem(text, value, selected)

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

パラメータ

Name説明
textObjectこのアイテムに表示されるテキストです。文字列以外のプリミティブ引数は自動的に文字列に変換されます。
valueObjectコールバックを介して送信されるフォーム入力値。文字列以外のプリミティブ引数は自動的に文字列に変換されます。
selectedBooleanデフォルトでアイテムが選択されるかどうか。選択入力で 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");

パラメータ

Name説明
textObjectこのアイテムに表示されるテキストです。文字列以外のプリミティブ引数は自動的に文字列に変換されます。
valueObjectコールバックを介して送信されるフォーム入力値。文字列以外のプリミティブ引数は自動的に文字列に変換されます。
selectedBooleanデフォルトでアイテムが選択されるかどうか。選択入力で 1 つの値しか受け入れられない場合(ラジオボタンやプルダウン メニューなど)、このフィールドは 1 つのアイテムにのみ設定します。
startIconUriObject複数選択メニューの場合、アイテムのテキスト フィールドの横に表示されるアイコンの URL。PNG ファイルと JPEG ファイルを使用できます。
bottomTextObject複数選択メニューの場合、アイテムのテキスト フィールドの下に表示されるテキストの説明またはラベル。

リターン

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

パラメータ

Name説明
actionAction外部データソース。

リターン

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


setFieldName(fieldName)

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

パラメータ

Name説明
fieldNameStringこの入力に割り当てる名前。

リターン

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

パラメータ

Name説明
maxSelectedItemsIntegerアイテムの最大数。

リターン

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


setMultiSelectMinQueryLength(queryLength)

Chat アプリがオートコンプリートを照会して候補項目をカードに表示するまでに、ユーザーが入力するテキスト文字数を設定します。

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

パラメータ

Name説明
queryLengthIntegerテキストの文字数。

リターン

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


setOnChangeAction(action)

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

パラメータ

Name説明
actionAction実行する操作。

リターン

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 アドオンでは利用できません。

パラメータ

Name説明
platformDataSourcePlatformDataSourceデータソース。

リターン

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


setTitle(title)

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

パラメータ

Name説明
titleString入力フィールドのタイトル。

リターン

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


setType(type)

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

パラメータ

Name説明
typeSelectionInputType選択タイプ。

リターン

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