Contém as entradas de configuração de um conector. Essas entradas de configuração definem as perguntas que são feitas 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étodo | Tipo de retorno | Breve descrição |
|---|---|---|
build() | Object | Valida esse objeto e o retorna no formato exigido pelo Data Studio. |
newCheckbox() | Checkbox | Retorna uma nova entrada de configuração da 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 para selecionar várias configurações. |
newSelectSingle() | SelectSingle | Retorna uma nova entrada de configuração única selecionada. |
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 | Mostra a representação JSON desse objeto. |
setDateRangeRequired(dateRangeRequired) | Config | Se for true, um período será fornecido para solicitações getData(). |
setIsSteppedConfig(isSteppedConfig) | Config | Se true, getConfig() será chamado novamente com a configuração atual do usuário. |
Documentação detalhada
build()
Valida esse objeto e o retorna no formato exigido pelo Data Studio.
Retorno
Object: o objeto Config validado.
newCheckbox()
Retorna uma nova entrada de configuração da caixa de seleção.
Retorno
Checkbox: uma nova entrada de configuração da caixa de seleção.
newInfo()
Retorna uma nova entrada de configuração de informações.
Retorno
Info: uma nova entrada de configuração de informações.
newOptionBuilder()
newSelectMultiple()
Retorna uma nova entrada para selecionar várias configurações.
Retorno
SelectMultiple: uma nova entrada para selecionar várias configurações.
newSelectSingle()
Retorna uma nova entrada de configuração única selecionada.
Retorno
SelectSingle: uma nova entrada de configuração única de seleção.
newTextArea()
Retorna uma nova entrada de configuração de área de texto.
Retorno
TextArea: uma nova entrada de configuração da área de texto.
newTextInput()
Retorna uma nova entrada de configuração de entrada de texto.
Retorno
TextInput: uma nova entrada de configuração de entrada de texto.
printJson()
Mostra a representação JSON desse objeto. Isso é apenas para depuração.
Retorno
String
setDateRangeRequired(dateRangeRequired)
Se for 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 ou não para solicitações getData(). |
Retorno
Config: este builder, para encadeamento.
setIsSteppedConfig(isSteppedConfig)
Se true, getConfig() será chamado novamente com a configuração atual do usuário.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
isSteppedConfig | Boolean | O status de configuração por etapas a ser definido. |
Retorno
Config: este builder, para encadeamento.