Class SelectionInput

PilihanInput

Kolom input yang memungkinkan pemilihan di antara serangkaian opsi standar.

Mendukung validasi pengiriman formulir untuk menu SelectionInputType.DROP_DOWN dan SelectionInputType.MULTI_SELECT saja. Jika Action.setAllWidgetsAreRequired(allWidgetsAreRequired) disetel ke true atau widget ini ditentukan melalui Action.addRequiredWidget(requiredWidget), tindakan pengiriman akan diblokir kecuali jika nilai dipilih.

Tersedia untuk add-on Google Workspace dan aplikasi 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);

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addDataSourceConfig(dataSourceConfig)SelectionInputMenetapkan konfigurasi sumber data untuk kontrol pilihan.
addEventAction(eventAction)WidgetMenambahkan tindakan peristiwa yang dapat dilakukan pada widget.
addItem(text, value, selected)SelectionInputMenambahkan item baru yang dapat dipilih.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputMenambahkan item baru yang dapat dipilih, untuk menu pilihan ganda.
setExternalDataSource(action)SelectionInputMenetapkan sumber data eksternal, seperti database relasional.
setFieldName(fieldName)SelectionInputMenetapkan kunci yang mengidentifikasi input pilihan ini dalam objek peristiwa yang dibuat saat ada interaksi UI.
setId(id)WidgetMenetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputMenetapkan jumlah maksimum item yang dapat dipilih pengguna.
setMultiSelectMinQueryLength(queryLength)SelectionInputMenetapkan jumlah karakter teks yang dimasukkan pengguna sebelum aplikasi membuat kueri pelengkapan otomatis dan menampilkan item yang disarankan di kartu.
setOnChangeAction(action)SelectionInputMenetapkan Action yang akan dilakukan setiap kali input pilihan berubah.
setPlatformDataSource(platformDataSource)SelectionInputMenetapkan sumber data dari Google Workspace.
setTitle(title)SelectionInputMenetapkan judul yang akan ditampilkan di depan kolom input.
setType(type)SelectionInputMenetapkan jenis input ini.
setVisibility(visibility)WidgetMenetapkan visibilitas widget.

Dokumentasi mendetail

addDataSourceConfig(dataSourceConfig)

Menetapkan konfigurasi sumber data untuk kontrol pilihan. Kolom ini memberikan kontrol yang lebih terperinci atas sumber data. Kolom ini bersifat opsional. 

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

Parameter

NamaJenisDeskripsi
dataSourceConfigDataSourceConfigKonfigurasi sumber data yang akan diterapkan ke input pilihan.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

addEventAction(eventAction)

Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.

Parameter

NamaJenisDeskripsi
eventActionEventActionEventAction yang akan ditambahkan.

Pulang pergi

Widget — Objek, untuk pengaitan.

addItem(text, value, selected)

Menambahkan item baru yang dapat dipilih.

Parameter

NamaJenisDeskripsi
textObjectTeks yang akan ditampilkan untuk item ini. Argumen primitif non-string otomatis dikonversi menjadi string.
valueObjectNilai input formulir yang dikirim melalui callback. Argumen primitif non-string dikonversi menjadi string secara otomatis.
selectedBooleanApakah item dipilih secara default. Jika input pilihan hanya menerima satu nilai (seperti untuk tombol pilihan atau menu dropdown), tetapkan kolom ini hanya untuk satu item.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

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

Menambahkan item baru yang dapat dipilih, untuk menu pilihan ganda. 

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

Parameter

NamaJenisDeskripsi
textObjectTeks yang akan ditampilkan untuk item ini. Argumen primitif non-string otomatis dikonversi menjadi string.
valueObjectNilai input formulir yang dikirim melalui callback. Argumen primitif non-string dikonversi menjadi string secara otomatis.
selectedBooleanApakah item dipilih secara default. Jika input pilihan hanya menerima satu nilai (seperti untuk tombol pilihan atau menu dropdown), tetapkan kolom ini hanya untuk satu item.
startIconUriObjectUntuk menu pilihan ganda, URL untuk ikon yang ditampilkan di samping kolom teks item. Mendukung file PNG dan JPEG.
bottomTextObjectUntuk menu pilihan ganda, deskripsi atau label teks yang ditampilkan di bawah kolom teks item.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setExternalDataSource(action)

Menetapkan sumber data eksternal, seperti database relasional. 

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

Parameter

NamaJenisDeskripsi
actionActionSumber data eksternal.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setFieldName(fieldName)

Menetapkan kunci yang mengidentifikasi input pilihan ini dalam objek peristiwa yang dibuat saat ada interaksi UI. Tidak terlihat oleh pengguna. Wajib diisi, harus unik.

Parameter

NamaJenisDeskripsi
fieldNameStringNama yang akan ditetapkan ke input ini.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setId(id)

Menetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah. Mutasi widget hanya didukung di Add-On.

Parameter

NamaJenisDeskripsi
idStringID widget, dengan batas 64 karakter dan dalam format `[a-zA-Z0-9-]+`.

Pulang pergi

Widget — Objek ini, untuk pengaitan.

setMultiSelectMaxSelectedItems(maxSelectedItems)

Menetapkan jumlah maksimum item yang dapat dipilih pengguna. 

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

Parameter

NamaJenisDeskripsi
maxSelectedItemsIntegerJumlah maksimum item.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setMultiSelectMinQueryLength(queryLength)

Menetapkan jumlah karakter teks yang dimasukkan pengguna sebelum aplikasi membuat kueri pelengkapan otomatis dan menampilkan item yang disarankan di kartu. 

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

Parameter

NamaJenisDeskripsi
queryLengthIntegerJumlah karakter teks.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setOnChangeAction(action)

Menetapkan Action yang akan dilakukan setiap kali input pilihan berubah.

Parameter

NamaJenisDeskripsi
actionActionTindakan yang harus dilakukan.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setPlatformDataSource(platformDataSource)

Menetapkan sumber data dari Google Workspace. Digunakan untuk mengisi item di menu pilihan ganda. 

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setPlatformDataSource(
            CardService.newPlatformDataSource().setCommonDataSource(
                CardService.CommonDataSource.USER,
                ),
        );
 Hanya tersedia untuk aplikasi Google Chat. Tidak tersedia untuk add-on Google Workspace.

Parameter

NamaJenisDeskripsi
platformDataSourcePlatformDataSourceSumber data.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setTitle(title)

Menetapkan judul yang akan ditampilkan di depan kolom input.

Parameter

NamaJenisDeskripsi
titleStringJudul kolom input.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setType(type)

Menetapkan jenis input ini. Default-nya adalah CHECKBOX.

Parameter

NamaJenisDeskripsi
typeSelectionInputTypeJenis pilihan.

Pulang pergi

SelectionInput — Objek ini, untuk pengaitan.

setVisibility(visibility)

Menetapkan visibilitas widget. Nilai defaultnya adalah `VISIBLE`.

Parameter

NamaJenisDeskripsi
visibilityVisibilityVisibility widget.

Pulang pergi

Widget — Objek, untuk pengaitan.