Class Config

Config

Contém as entradas de configuração de um conector. Essas entradas 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 esse objeto e o retorna 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 criador de opções.
newSelectMultiple()	SelectMultiple	Retorna uma nova entrada de configuração de seleção múltipla.
newSelectSingle()	SelectSingle	Retorna uma nova entrada de configuração de seleção única.
newTextArea()	TextArea	Retorna uma nova entrada de configuração de área de texto.
newTextInput()	TextInput	Retorna uma nova entrada de configuração de entrada de texto.
printJson()	String	Imprime a representação JSON desse objeto.
setDateRangeRequired(dateRangeRequired)	Config	Quando ela é definida como true, um período é informado para solicitações getData().
setIsSteppedConfig(isSteppedConfig)	Config	Quando ela é definida como true, getConfig() é chamada novamente com a configuração do usuário atual.

Documentação detalhada

build()

Valida esse objeto e o retorna 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 criador de opções.

Retornar

OptionBuilder: um novo criador de opções.

---

newSelectMultiple()

Retorna uma nova entrada de configuração de seleção múltipla.

Retornar

SelectMultiple: uma nova entrada de configuração de seleção múltipla.

---

newSelectSingle()

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

Retornar

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

---

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)

Quando ela é definida como true, um período é informado para solicitações getData().

Parâmetros

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

Retornar

Config: esse criador, para encadeamento.

---

setIsSteppedConfig(isSteppedConfig)

Quando ela é definida como true, getConfig() é chamada novamente com a configuração do usuário atual.

Parâmetros

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

Retornar

Config: esse criador, para encadeamento.