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	驗證這個物件，並以 Data Studio 所需的格式傳回。
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()

驗證這個物件，並以 Data Studio 所需的格式傳回。

回攻員

Object：已驗證的 Config 物件。

---

newCheckbox()

傳回新的核取方塊設定項目。

回攻員

Checkbox：新的核取方塊設定項目。

---

newInfo()

傳回新的資訊設定項目。

回攻員

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：這個建構工具可用於鏈結。