Contém informações de seleção única para a configuração. As propriedades determinam como a seleção única é mostrada no 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);
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
add | Select | Adiciona uma nova opção de seleção. |
set | Select | Permite a substituição dessa entrada de configuração. |
set | Select | Define o texto de ajuda para essa entrada de configuração. |
set | Select | Define o ID exclusivo para essa entrada de configuração. |
set | Select | Define o status dinâmico para essa entrada de configuração. |
set | Select | Define o nome de exibição para essa entrada de configuração. |
Documentação detalhada
addOption(optionBuilder)
Adiciona uma nova opção de seleção.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
option | Option | Um builder para uma opção. |
Retornar
SelectSingle — Este builder, para encadeamento.
setAllowOverride(allowOverride)
Permite a substituição dessa entrada de configuração. Se definido como true, os criadores da fonte de dados têm a opção de ativar esse recurso para editores de relatórios.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
allow | Boolean | Se essa entrada de configuração pode ou não ser substituída em relatórios. |
Retornar
SelectSingle — Este builder, para encadeamento.
setHelpText(helpText)
Define o texto de ajuda para essa entrada de configuração.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
help | String | O texto de ajuda a ser definido. |
Retornar
SelectSingle — Este builder, para encadeamento.
setId(id)
Define o ID exclusivo para essa entrada de configuração.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
id | String | O ID a ser definido. |
Retornar
SelectSingle — Este builder, para encadeamento.
setIsDynamic(isDynamic)
Define o status dinâmico para essa entrada de configuração.
Se uma entrada de configuração dinâmica for modificada, as entradas de configuração subsequentes serão limpas.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
is | Boolean | O status dinâmico a ser definido. |
Retornar
SelectSingle — Este builder, para encadeamento.
setName(name)
Define o nome de exibição para essa entrada de configuração.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
name | String | O nome a ser definido. |
Retornar
SelectSingle — Este builder, para encadeamento.