Class SelectSingle
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
選取單選題
包含所選設定的單一資訊。其屬性會決定所選單一項目在 Data Studio 中的顯示方式。
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);
內容詳盡的說明文件
setAllowOverride(allowOverride)
啟用此設定項目的覆寫功能。如果設為 true
,資料來源建立者可以選擇為報表編輯者啟用這項功能。
參數
名稱 | 類型 | 說明 |
allowOverride | Boolean | 報表中是否可覆寫此設定項目。 |
回攻員
SelectSingle
:這個建構工具可用於鏈結。
setHelpText(helpText)
設定此設定項目的說明文字。
參數
名稱 | 類型 | 說明 |
helpText | String | 要設定的 helpText。 |
回攻員
SelectSingle
:這個建構工具可用於鏈結。
setIsDynamic(isDynamic)
設定這項設定項目的動態狀態。
如果動態設定項目遭到修改,後續的設定項目就會清除。
參數
名稱 | 類型 | 說明 |
isDynamic | Boolean | 要設定的動態狀態。 |
回攻員
SelectSingle
:這個建構工具可用於鏈結。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-26 (世界標準時間)。
[null,null,["上次更新時間:2025-07-26 (世界標準時間)。"],[[["\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."]]