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

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

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

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

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

const 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'),
        );

const 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 - チェーン用のこのオブジェクト。

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

メソッド

詳細なドキュメント

addItem(text, value, selected)

パラメータ

戻る

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

パラメータ

戻る

setExternalDataSource(action)

パラメータ

戻る

setFieldName(fieldName)

パラメータ

戻る

setMultiSelectMaxSelectedItems(maxSelectedItems)

パラメータ

戻る

setMultiSelectMinQueryLength(queryLength)

パラメータ

戻る

setOnChangeAction(action)

パラメータ

戻る

setPlatformDataSource(platformDataSource)

パラメータ

戻る

setTitle(title)

パラメータ

戻る

setType(type)

パラメータ

戻る

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

`addItem(text, value, selected)`

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

`setExternalDataSource(action)`

`setFieldName(fieldName)`

`setMultiSelectMaxSelectedItems(maxSelectedItems)`

`setMultiSelectMinQueryLength(queryLength)`

`setOnChangeAction(action)`

`setPlatformDataSource(platformDataSource)`

`setTitle(title)`

`setType(type)`