Class OptionBuilder
Stay organized with collections
Save and categorize content based on your preferences.
OptionBuilder
A builder for creating options for SelectSingles and SelectMultiples.
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.')
.addOption(option1)
.addOption(option2);
Detailed documentation
setLabel(label)
Sets the label of this option builder. Labels are the text that the user sees when selecting
one or more options from the dropdown.
Parameters
| Name | Type | Description |
label | String | The label to set. |
Return
OptionBuilder — This builder, for chaining.
setValue(value)
Sets the value of this option builder. Values are what is passed to the code when a user
selects one or more options from the dropdown.
Parameters
| Name | Type | Description |
value | String | The value to set. |
Return
OptionBuilder — This builder, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eOptionBuilder\u003c/code\u003e facilitates the creation of options for \u003ccode\u003eSelectSingle\u003c/code\u003e and \u003ccode\u003eSelectMultiple\u003c/code\u003e elements in Data Studio.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods like \u003ccode\u003esetLabel\u003c/code\u003e and \u003ccode\u003esetValue\u003c/code\u003e to define the display text and underlying value of each option.\u003c/p\u003e\n"],["\u003cp\u003eThese options are then added to \u003ccode\u003eSelectSingle\u003c/code\u003e or \u003ccode\u003eSelectMultiple\u003c/code\u003e components for user interaction within a Data Studio connector.\u003c/p\u003e\n"],["\u003cp\u003eUsing \u003ccode\u003eOptionBuilder\u003c/code\u003e simplifies the process of creating interactive dropdown menus in your custom connectors.\u003c/p\u003e\n"]]],[],null,["# Class OptionBuilder\n\nOptionBuilder\n\nA builder for creating options for [SelectSingle](/apps-script/reference/data-studio/select-single)s and [SelectMultiple](/apps-script/reference/data-studio/select-multiple)s.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst config = cc.getConfig();\n\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 .addOption(option1)\n .addOption(option2);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|--------------------------------------|--------------------|----------------------------------------|\n| [setLabel(label)](#setLabel(String)) | [OptionBuilder](#) | Sets the label of this option builder. |\n| [setValue(value)](#setValue(String)) | [OptionBuilder](#) | Sets the value of this option builder. |\n\nDetailed documentation\n----------------------\n\n### `set``Label(label)`\n\nSets the label of this option builder. Labels are the text that the user sees when selecting\none or more options from the dropdown.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|-------------------|\n| `label` | `String` | The label to set. |\n\n#### Return\n\n\n[OptionBuilder](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Value(value)`\n\nSets the value of this option builder. Values are what is passed to the code when a user\nselects one or more options from the dropdown.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|-------------------|\n| `value` | `String` | The value to set. |\n\n#### Return\n\n\n[OptionBuilder](#) --- This builder, for chaining."]]
