Class Config

Configuração

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

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

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

Métodos

Método	Tipo de retorno	Breve descrição
build()	Object	Valida e retorna o objeto no formato necessário para o Data Studio.
newCheckbox()	Checkbox	Retorna uma nova entrada de configuração de caixa de seleção.
newInfo()	Info	Retorna uma nova entrada de configuração de informações.
newOptionBuilder()	OptionBuilder	Retorna um novo builder de opções.
newSelectMultiple()	SelectMultiple	Retorna uma nova entrada de seleção de várias configurações.
newSelectSingle()	SelectSingle	Retorna uma nova entrada de configuração única selecionada.
newTextArea()	TextArea	Retorna uma nova entrada de configuração da área de texto.
newTextInput()	TextInput	Retorna uma nova entrada de configuração de entrada de texto.
printJson()	String	Mostra a representação JSON desse objeto.
setDateRangeRequired(dateRangeRequired)	Config	Se true, um período será fornecido para solicitações getData().
setIsSteppedConfig(isSteppedConfig)	Config	Se true, getConfig() é chamado novamente com a configuração atual do usuário.

Documentação detalhada

build()

Valida e retorna o objeto no formato necessário para o 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 builder de opções.

Retornar

OptionBuilder: um novo construtor de opções.

---

newSelectMultiple()

Retorna uma nova entrada de seleção de várias configurações.

Retornar

SelectMultiple: uma nova entrada de 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 da área de texto.

Retornar

TextArea: uma nova entrada de configuração da á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()

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

Retornar

String

---

setDateRangeRequired(dateRangeRequired)

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

Parâmetros

Nome	Tipo	Descrição
dateRangeRequired	Boolean	Indica se um período precisa ser fornecido para solicitações getData().

Retornar

Config: este builder, para encadeamento.

---

setIsSteppedConfig(isSteppedConfig)

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

Parâmetros

Nome	Tipo	Descrição
isSteppedConfig	Boolean	O status de configuração em etapas a ser definido.

Retornar

Config: este builder, para encadeamento.