Class SelectionInput

SelectionInput

Ein Eingabefeld, das die Auswahl aus einer Reihe vordefinierter Optionen ermöglicht.

Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.

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

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addItem(text, value, selected)	SelectionInput	Fügt ein neues Element hinzu, das ausgewählt werden kann.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)	SelectionInput	Fügt ein neues Element hinzu, das für Mehrfachauswahl-Menüs ausgewählt werden kann.
setExternalDataSource(action)	SelectionInput	Legt eine externe Datenquelle fest, z. B. eine relationale Datenbank.
setFieldName(fieldName)	SelectionInput	Legt den Schlüssel fest, der diese Auswahleingabe im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird.
setMultiSelectMaxSelectedItems(maxSelectedItems)	SelectionInput	Legt die maximale Anzahl von Elementen fest, die ein Nutzer auswählen kann.
setMultiSelectMinQueryLength(queryLength)	SelectionInput	Legt die Anzahl der Textzeichen fest, die ein Nutzer eingibt, bevor die App die automatische Vervollständigung abfragt, und zeigt vorgeschlagene Elemente auf der Karte an.
setOnChangeAction(action)	SelectionInput	Legt eine Action fest, die immer dann ausgeführt wird, wenn sich die Auswahleingabe ändert.
setPlatformDataSource(platformDataSource)	SelectionInput	Legt eine Datenquelle aus Google Workspace fest.
setTitle(title)	SelectionInput	Legt den Titel fest, der vor dem Eingabefeld angezeigt werden soll.
setType(type)	SelectionInput	Legt den Typ dieser Eingabe fest.

Detaillierte Dokumentation

addItem(text, value, selected)

Fügt ein neues Element hinzu, das ausgewählt werden kann.

Parameter

Name	Typ	Beschreibung
text	Object	Der Text, der für dieses Element angezeigt werden soll. Einfache Argumente, die keine Strings sind, werden automatisch in Strings umgewandelt.
value	Object	Der Eingabewert für das Formular, der über den Callback gesendet wird. Einfache Argumente, die keine Strings sind, werden automatisch in Strings konvertiert.
selected	Boolean	Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn die Auswahleingabe nur einen Wert akzeptiert (z. B. bei Optionsfeldern oder einem Drop-down-Menü), legen Sie dieses Feld nur für ein Element fest.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

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

Fügt ein neues Element hinzu, das für Mehrfachauswahl-Menüs ausgewählt werden kann.

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

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Vorschauprogramms für Entwickler, mit dem Vorabzugriff auf bestimmte Funktionen gewährt wird.

Parameter

Name	Typ	Beschreibung
text	Object	Der Text, der für dieses Element angezeigt werden soll. Einfache Argumente, die keine Strings sind, werden automatisch in Strings umgewandelt.
value	Object	Der Eingabewert für das Formular, der über den Callback gesendet wird. Einfache Argumente, die keine Strings sind, werden automatisch in Strings konvertiert.
selected	Boolean	Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn die Auswahleingabe nur einen Wert akzeptiert (z. B. bei Optionsfeldern oder einem Drop-down-Menü), legen Sie dieses Feld nur für ein Element fest.
startIconUri	Object	Bei Mehrfachauswahl-Menüs die URL für das Symbol, das neben dem Textfeld des Elements angezeigt wird. Unterstützt PNG- und JPEG-Dateien.
bottomText	Object	Bei Mehrfachauswahl-Menüs eine Textbeschreibung oder ein Label, die bzw. das unter dem Textfeld des Elements angezeigt wird.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setExternalDataSource(action)

Legt eine externe Datenquelle fest, z. B. eine relationale Datenbank.

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

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Vorschauprogramms für Entwickler, mit dem Vorabzugriff auf bestimmte Funktionen gewährt wird.

Parameter

Name	Typ	Beschreibung
action	Action	Die externe Datenquelle.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setFieldName(fieldName)

Legt den Schlüssel fest, der diese Auswahleingabe im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird. Für den Nutzer nicht sichtbar. Erforderlich, muss eindeutig sein.

Parameter

Name	Typ	Beschreibung
fieldName	String	Der Name, der dieser Eingabe zugewiesen werden soll.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setMultiSelectMaxSelectedItems(maxSelectedItems)

Legt die maximale Anzahl von Elementen fest, die ein Nutzer auswählen kann.

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

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Vorschauprogramms für Entwickler, mit dem Vorabzugriff auf bestimmte Funktionen gewährt wird.

Parameter

Name	Typ	Beschreibung
maxSelectedItems	Integer	Die maximale Anzahl von Elementen.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setMultiSelectMinQueryLength(queryLength)

Legt die Anzahl der Textzeichen fest, die ein Nutzer eingibt, bevor die App die automatische Vervollständigung abfragt, und zeigt vorgeschlagene Elemente auf der Karte an.

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

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Vorschauprogramms für Entwickler, mit dem Vorabzugriff auf bestimmte Funktionen gewährt wird.

Parameter

Name	Typ	Beschreibung
queryLength	Integer	Die Anzahl der Textzeichen.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setOnChangeAction(action)

Legt eine Action fest, die immer dann ausgeführt wird, wenn sich die Auswahleingabe ändert.

Parameter

Name	Typ	Beschreibung
action	Action	Die erforderliche Aktion.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setPlatformDataSource(platformDataSource)

Legt eine Datenquelle aus Google Workspace fest. Wird zum Füllen von Elementen in einem Mehrfachauswahl-Menü verwendet.

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

Nur für Google Chat-Apps verfügbar. Nicht verfügbar für Google Workspace-Add-ons.

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Vorschauprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

Parameter

Name	Typ	Beschreibung
platformDataSource	PlatformDataSource	Die Datenquelle.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setTitle(title)

Legt den Titel fest, der vor dem Eingabefeld angezeigt werden soll.

Parameter

Name	Typ	Beschreibung
title	String	Der Titel des Eingabefelds.

Return

SelectionInput: Dieses Objekt zur Verkettung.

---

setType(type)

Legt den Typ dieser Eingabe fest. Die Standardeinstellung ist CHECKBOX.

Parameter

Name	Typ	Beschreibung
type	SelectionInputType	Der Auswahltyp.

Return

SelectionInput: Dieses Objekt zur Verkettung.