Class Config

Configuración

Contiene las entradas de configuración para un conector. Estas entradas de configuración definen qué preguntas se hacen cuando se agrega un conector nuevo.

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 datos que se muestraDescripción breve
build()ObjectValida este objeto y lo muestra en el formato que necesita Data Studio.
newCheckbox()CheckboxMuestra una nueva entrada de configuración de la casilla de verificación.
newInfo()InfoMuestra una nueva entrada de configuración de información.
newOptionBuilder()OptionBuilderMuestra un compilador de opciones nuevo.
newSelectMultiple()SelectMultipleMuestra una nueva entrada de configuración de selección múltiple.
newSelectSingle()SelectSingleMuestra una nueva entrada de configuración única seleccionada.
newTextArea()TextAreaMuestra una nueva entrada de configuración de área de texto.
newTextInput()TextInputMuestra una nueva entrada de configuración de entrada de texto.
printJson()StringImprime la representación JSON de este objeto.
setDateRangeRequired(dateRangeRequired)ConfigSi es true, se proporciona un período para las solicitudes getData().
setIsSteppedConfig(isSteppedConfig)ConfigSi es true, se vuelve a llamar a getConfig() con la configuración de usuario actual.

Documentación detallada

build()

Valida este objeto y lo muestra en el formato que necesita Data Studio.

Devolvedor

Object: Es el objeto Config validado.


newCheckbox()

Muestra una nueva entrada de configuración de la casilla de verificación.

Devolvedor

Checkbox: Es una nueva entrada de configuración de la casilla de verificación.


newInfo()

Muestra una nueva entrada de configuración de información.

Devolvedor

Info: Es una entrada de configuración de información nueva.


newOptionBuilder()

Muestra un compilador de opciones nuevo.

Devolvedor

OptionBuilder: Es un compilador de opciones nuevo.


newSelectMultiple()

Muestra una nueva entrada de configuración de selección múltiple.

Devolvedor

SelectMultiple: Es una entrada nueva de selección múltiple.


newSelectSingle()

Muestra una nueva entrada de configuración única seleccionada.

Devolvedor

SelectSingle: Es una entrada de configuración única y selecta.


newTextArea()

Muestra una nueva entrada de configuración de área de texto.

Devolvedor

TextArea: Es una nueva entrada de configuración de área de texto.


newTextInput()

Muestra una nueva entrada de configuración de entrada de texto.

Devolvedor

TextInput: Es una nueva entrada de configuración de entrada de texto.


printJson()

Imprime la representación JSON de este objeto. Esto es solo para depuración.

Devolvedor

String


setDateRangeRequired(dateRangeRequired)

Si es true, se proporciona un período para las solicitudes getData().

Parámetros

NombreTipoDescripción
dateRangeRequiredBooleanIndica si se debe proporcionar un período o no a las solicitudes de getData().

Devolvedor

Config: Este compilador se usa para encadenar.


setIsSteppedConfig(isSteppedConfig)

Si es true, se vuelve a llamar a getConfig() con la configuración de usuario actual.

Parámetros

NombreTipoDescripción
isSteppedConfigBooleanEl estado de configuración escalonado que se establecerá.

Devolvedor

Config: Este compilador se usa para encadenar.