Class SelectSingle
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Wählen SieEinzel aus.
Enthält ausgewählte einzelne Informationen für die Konfiguration. Mit den Eigenschaften wird festgelegt, wie die ausgewählte einzelne Zeile in Data Studio dargestellt wird.
const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();
const option1 =
config.newOptionBuilder().setLabel('option label').setValue('option_value');
const option2 = config.newOptionBuilder()
.setLabel('second option label')
.setValue('option_value_2');
const info1 = config.newSelectSingle()
.setId('api_endpoint')
.setName('Data Type')
.setHelpText('Select the data type you\'re interested in.')
.setAllowOverride(true)
.addOption(option1)
.addOption(option2);
Detaillierte Dokumentation
addOption(optionBuilder)
Es wird eine neue Auswahloption hinzugefügt.
Parameter
| Name | Typ | Beschreibung |
optionBuilder | OptionBuilder | Ein Builder für eine Option. |
Rückflug
SelectSingle – Dieser Builder zur Verkettung.
setAllowOverride(allowOverride)
Aktiviert das Überschreiben für diesen Konfigurationseintrag. Wenn true festgelegt ist, können die Ersteller von Datenquellen diese Option für Mitbearbeiter von Berichten aktivieren.
Parameter
| Name | Typ | Beschreibung |
allowOverride | Boolean | Gibt an, ob dieser Konfigurationseintrag in Berichten überschrieben werden kann. |
Rückflug
SelectSingle – Dieser Builder zur Verkettung.
setHelpText(helpText)
Hiermit wird der Hilfetext für diesen Konfigurationseintrag festgelegt.
Parameter
| Name | Typ | Beschreibung |
helpText | String | Der zu setzende Hilfetext. |
Rückflug
SelectSingle – Dieser Builder zur Verkettung.
setId(id)
Hier wird die eindeutige ID für diesen Konfigurationseintrag festgelegt.
Parameter
| Name | Typ | Beschreibung |
id | String | Die ID, die festgelegt werden soll. |
Rückflug
SelectSingle – Dieser Builder zur Verkettung.
setIsDynamic(isDynamic)
Hier wird der dynamische Status für diesen Konfigurationseintrag festgelegt.
Wenn ein dynamischer Konfigurationseintrag geändert wird, werden nachfolgende Konfigurationseinträge gelöscht.
Parameter
| Name | Typ | Beschreibung |
isDynamic | Boolean | Der festzulegende dynamische Status. |
Rückflug
SelectSingle – Dieser Builder zur Verkettung.
setName(name)
Legt den Anzeigenamen für diesen Konfigurationseintrag fest.
Parameter
| Name | Typ | Beschreibung |
name | String | Der Name, der festgelegt werden soll. |
Rückflug
SelectSingle – Dieser Builder zur Verkettung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eSelectSingle\u003c/code\u003e defines how a single-select dropdown menu appears and functions within a Data Studio configuration.\u003c/p\u003e\n"],["\u003cp\u003eIt allows developers to specify options, help text, and behavior such as allowing users to override the selection.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003eaddOption\u003c/code\u003e, \u003ccode\u003esetAllowOverride\u003c/code\u003e, \u003ccode\u003esetHelpText\u003c/code\u003e, \u003ccode\u003esetId\u003c/code\u003e, \u003ccode\u003esetIsDynamic\u003c/code\u003e, and \u003ccode\u003esetName\u003c/code\u003e are used to configure the dropdown's attributes and functionality.\u003c/p\u003e\n"],["\u003cp\u003eEach method returns the \u003ccode\u003eSelectSingle\u003c/code\u003e object itself, enabling chained method calls for streamlined configuration.\u003c/p\u003e\n"]]],["`SelectSingle` configures how a single selection is displayed in Data Studio. Key actions include adding options via `addOption`, enabling overrides with `setAllowOverride`, setting help text via `setHelpText`, defining a unique `id` with `setId`, specifying dynamic status using `setIsDynamic`, and setting the display `name` with `setName`. Each method returns the `SelectSingle` builder, enabling method chaining. This config determines the available choices and how users interact with the select field in Data Studio.\n"],null,["# Class SelectSingle\n\nSelectSingle\n\nContains select single information for the config. Its properties determine how the select single\nis displayed in Data Studio.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst config = cc.getConfig();\nconst option1 =\n config.newOptionBuilder().setLabel('option label').setValue('option_value');\n\nconst option2 = config.newOptionBuilder()\n .setLabel('second option label')\n .setValue('option_value_2');\n\nconst info1 = config.newSelectSingle()\n .setId('api_endpoint')\n .setName('Data Type')\n .setHelpText('Select the data type you\\'re interested in.')\n .setAllowOverride(true)\n .addOption(option1)\n .addOption(option2);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------|-------------------|-------------------------------------------------------|\n| [addOption(optionBuilder)](#addOption(OptionBuilder)) | [SelectSingle](#) | Adds a new select option. |\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [SelectSingle](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [SelectSingle](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [SelectSingle](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [SelectSingle](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [SelectSingle](#) | Sets the display name for this configuration entry. |\n\nDetailed documentation\n----------------------\n\n### `add``Option(optionBuilder)`\n\nAdds a new select option.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------|--------------------------------------------------------------------|--------------------------|\n| `option``Builder` | [OptionBuilder](/apps-script/reference/data-studio/option-builder) | A builder for an option. |\n\n#### Return\n\n\n[SelectSingle](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Allow``Override(allowOverride)`\n\nEnables overriding for this config entry. If set to `true`, data source creators have the\noption to enable this for report editors.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------|-----------|----------------------------------------------------------------|\n| `allow``Override` | `Boolean` | Whether or not this config entry can be overridden in reports. |\n\n#### Return\n\n\n[SelectSingle](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Help``Text(helpText)`\n\nSets the help text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|----------------------|\n| `help``Text` | `String` | The helpText to set. |\n\n#### Return\n\n\n[SelectSingle](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Id(id)`\n\nSets the unique ID for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|----------|----------------|\n| `id` | `String` | The ID to set. |\n\n#### Return\n\n\n[SelectSingle](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Is``Dynamic(isDynamic)`\n\nSets the dynamic status for this configuration entry.\n\nIf a dynamic configuration entry is modified, subsequent configuration entries are cleared.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|-----------|----------------------------|\n| `is``Dynamic` | `Boolean` | The dynamic status to set. |\n\n#### Return\n\n\n[SelectSingle](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Name(name)`\n\nSets the display name for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|------------------|\n| `name` | `String` | The name to set. |\n\n#### Return\n\n\n[SelectSingle](#) --- This builder, for chaining."]]
