Class Config

配置

包含连接器的配置条目。这些配置条目用于定义在添加新连接器时系统会询问哪些问题。

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

方法

方法	返回类型	简介
build()	Object	验证此对象，并以数据分析所需的格式返回该对象。
newCheckbox()	Checkbox	返回新的复选框配置条目。
newInfo()	Info	返回新的 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 配置条目。

返回

Info - 新的 info 配置条目。

---

newOptionBuilder()

返回新的选项构建器。

返回

OptionBuilder - 新的选项构建器。

---

newSelectMultiple()

返回新的多选配置条目。

返回

SelectMultiple - 新增了“选择多个配置”条目。

---

newSelectSingle()

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

返回

SelectSingle - 新的“选择单个配置”条目。

---

newTextArea()

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

返回

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

---

newTextInput()

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

返回

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

---

printJson()

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

返回

String

---

setDateRangeRequired(dateRangeRequired)

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

参数

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

返回

Config - 此构建器，用于链式调用。

---

setIsSteppedConfig(isSteppedConfig)

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

参数

名称	类型	说明
isSteppedConfig	Boolean	要设置的分级配置状态。

返回

Config - 此构建器，用于链式调用。