Class Config

配置

包含连接器的配置条目。这些配置条目定义了 系统会询问您几个问题。

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.");

方法

方法返回类型简介
build()Object验证此对象并以数据洞察所需的格式返回它。
newCheckbox()Checkbox返回新的复选框配置条目。
newInfo()Info返回新的信息配置条目。
newOptionBuilder()OptionBuilder返回新的选项构建器。
newSelectMultiple()SelectMultiple返回一个新的多选配置条目。
newSelectSingle()SelectSingle返回一个新的单选配置条目。
newTextArea()TextArea返回新的文本区域配置条目。
newTextInput()TextInput返回新的文本输入配置条目。
printJson()String输出此对象的 JSON 表示法。
setDateRangeRequired(dateRangeRequired)Config如果为 true,则需要为 getData() 请求提供日期范围。
setIsSteppedConfig(isSteppedConfig)Config如果为 true,则使用当前的用户配置再次调用 getConfig()

详细文档

build()

验证此对象并以数据洞察所需的格式返回它。

返回

Object - 经过验证的 Config 对象。


newCheckbox()

返回新的复选框配置条目。

返回

Checkbox - 新的复选框配置条目。


newInfo()

返回新的信息配置条目。

返回

Info - 新的信息配置条目。


newOptionBuilder()

返回新的选项构建器。

返回

OptionBuilder - 新的选项构建器。


newSelectMultiple()

返回一个新的多选配置条目。

返回

SelectMultiple - 新的多选配置条目。


newSelectSingle()

返回一个新的单选配置条目。

返回

SelectSingle - 新的单选配置条目。


newTextArea()

返回新的文本区域配置条目。

返回

TextArea - 新的文本区域配置条目。


newTextInput()

返回新的文本输入配置条目。

返回

TextInput - 新的文本输入配置条目。


printJson()

输出此对象的 JSON 表示法。这仅用于调试。

返回

String


setDateRangeRequired(dateRangeRequired)

如果为 true,则需要为 getData() 请求提供日期范围。

参数

名称类型说明
dateRangeRequiredBoolean是否应向 getData() 提供日期范围 请求。

返回

Config - 此构建器,用于链接。


setIsSteppedConfig(isSteppedConfig)

如果为 true,则使用当前的用户配置再次调用 getConfig()

参数

名称类型说明
isSteppedConfigBoolean要设置的分步配置状态。

返回

Config - 此构建器,用于链接。