Class Config

Configuração

Contém as entradas de configuração de um conector. Essas entradas de configuração definem ao adicionar um novo conector.

var cc = DataStudioApp.createCommunityConnector();
var config = cc.getConfig();

var info_entry = config.newInfo()
  .setId("info_id")
  .setHelpText("This connector can connect to multiple data endpoints.");

Métodos

MétodoTipo de retornoBreve descrição
build()ObjectValida esse objeto e o retorna no formato exigido pelo Data Studio.
newCheckbox()CheckboxRetorna uma nova entrada de configuração de caixa de seleção.
newInfo()InfoRetorna uma nova entrada de configuração de informações.
newOptionBuilder()OptionBuilderRetorna um novo criador de opções.
newSelectMultiple()SelectMultipleRetorna uma nova entrada de configuração selecionada para vários itens.
newSelectSingle()SelectSingleRetorna uma nova entrada de configuração única selecionada.
newTextArea()TextAreaRetorna uma nova entrada de configuração de área de texto.
newTextInput()TextInputRetorna uma nova entrada de configuração de entrada de texto.
printJson()StringImprime a representação JSON desse objeto.
setDateRangeRequired(dateRangeRequired)ConfigSe for true, um período será fornecido para solicitações getData().
setIsSteppedConfig(isSteppedConfig)ConfigSe true, getConfig() será chamado novamente com a configuração do usuário atual.

Documentação detalhada

build()

Valida esse objeto e o retorna no formato exigido pelo Data Studio.

Retornar

Object: o objeto Config validado.


newCheckbox()

Retorna uma nova entrada de configuração de caixa de seleção.

Retornar

Checkbox: uma nova entrada de configuração de caixa de seleção.


newInfo()

Retorna uma nova entrada de configuração de informações.

Retornar

Info: uma nova entrada de configuração de informações.


newOptionBuilder()

Retorna um novo criador de opções.

Retornar

OptionBuilder: um novo builder de opções.


newSelectMultiple()

Retorna uma nova entrada de configuração selecionada para vários itens.

Retornar

SelectMultiple: uma nova entrada para seleção de várias configurações.


newSelectSingle()

Retorna uma nova entrada de configuração única selecionada.

Retornar

SelectSingle: uma nova entrada de configuração única selecionada.


newTextArea()

Retorna uma nova entrada de configuração de área de texto.

Retornar

TextArea: uma nova entrada de configuração de área de texto.


newTextInput()

Retorna uma nova entrada de configuração de entrada de texto.

Retornar

TextInput: uma nova entrada de configuração de entrada de texto.


printJson()

Imprime a representação JSON desse objeto. Isso é apenas para depuração.

Retornar

String


setDateRangeRequired(dateRangeRequired)

Se for true, um período será fornecido para solicitações getData().

Parâmetros

NomeTipoDescrição
dateRangeRequiredBooleanSe um período deve ou não ser fornecido para getData() solicitações.

Retornar

Config: este builder para encadeamento.


setIsSteppedConfig(isSteppedConfig)

Se true, getConfig() será chamado novamente com a configuração do usuário atual.

Parâmetros

NomeTipoDescrição
isSteppedConfigBooleanO status da configuração em etapas a ser definido.

Retornar

Config: este builder para encadeamento.