Class Field

欄位

包含欄位相關資料。屬性會決定欄位在數據分析中的使用方式。

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

方法

方法傳回類型簡短說明
getAggregation()AggregationType傳回這個 Field 的 AggregationType。
getDescription()String傳回這個 Field 的說明。
getFormula()String傳回這個 Field 的公式。
getGroup()String傳回這個 Field 的群組。
getId()String傳回這個 Field 的 ID。
getIsReaggregatable()Boolean如果這個欄位可以重新彙整,則傳回 true,否則傳回 false。
getName()String傳回這個 Field 的名稱。
getType()FieldType傳回這個 Field 的 FieldType。
isDefault()Boolean如果這個 Field 是預設指標或維度,則傳回 true。
isDimension()Boolean如果這個欄位是維度,則傳回 true。
isHidden()Boolean如果這個 Field 遭到隱藏,則傳回 true。
isMetric()Boolean如果這個欄位是指標,則傳回 true。
setAggregation(aggregation)Field設定這個 Field 的匯總類型。
setDescription(description)Field設定這個 Field 的說明。
setFormula(formula)Field設定這個 Field 的公式。
setGroup(group)Field設定這個 Field 的群組。
setId(id)Field設定這個 Field 的 ID。
setIsHidden(isHidden)Field設定這個 Field 的隱藏狀態。
setIsReaggregatable(isReaggregatable)Field為 Field 設定允許重新彙整的狀態。
setName(name)Field設定這個 Field 的名稱。
setType(type)Field設定這個 Field 的 FieldType。

內容詳盡的說明文件

getAggregation()

傳回這個 Field 的 AggregationType。AggregationType 決定數據分析如何將類似資料合併為維度。

回攻員

AggregationType:這個欄位的 aggregationType。


getDescription()

傳回這個 Field 的說明。說明是欄位用途的簡短解釋。

回攻員

String:這個欄位的說明。


getFormula()

傳回這個 Field 的公式。公式會定義資料轉換,資料工作室會在查詢時執行這項轉換。

回攻員

String:這個欄位的公式。


getGroup()

傳回這個 Field 的群組。系統會將收集到群組中的欄位一起顯示在數據分析使用者介面中。

回攻員

String:這個欄位的群組。


getId()

傳回這個 Field 的 ID。每個欄位組合都有專屬 ID,可用於公式中參照欄位。

回攻員

String:這個欄位的 ID。


getIsReaggregatable()

如果這個欄位可以重新彙整,則傳回 true,否則傳回 false。

回攻員

Boolean:如果可以重新彙整這個欄位,則為 true,否則為 false。


getName()

傳回這個 Field 的名稱。名稱會向使用者顯示,用於區分欄位。

回攻員

String:這個欄位的名稱。


getType()

傳回這個 Field 的 FieldType。

回攻員

FieldType:這個欄位的類型。


isDefault()

如果這個 Field 是預設指標或維度,則傳回 true。

回攻員

Boolean - true (如果這個 Field 是預設指標或維度);false (否則)。


isDimension()

如果這個欄位是維度,則傳回 true。

回攻員

Boolean:如果這個欄位是維度,則傳回 true;否則傳回 false。


isHidden()

如果這個 Field 遭到隱藏,則傳回 true。您可以在公式中使用隱藏欄位,但無法在圖表中使用。含有公式的欄位無法隱藏。

回攻員

Boolean:如果這個 Field 遭到隱藏,則為 true,否則為 false。


isMetric()

如果這個欄位是指標,則傳回 true。

回攻員

Boolean:如果這個欄位是指標,則為 true;否則為 false。


setAggregation(aggregation)

設定這個 Field 的匯總類型。AggregationType 決定數據分析如何將類似資料合併為維度。如果對指標呼叫這個函式,系統會擲回錯誤。

參數

名稱類型說明
aggregationAggregationType要設定的匯總類型。

回攻員

Field:這個建構工具用於串連。


setDescription(description)

設定這個 Field 的說明。說明是欄位用途的簡短解釋。

參數

名稱類型說明
descriptionString要設定的說明。

回攻員

Field:這個建構工具用於串連。


setFormula(formula)

設定這個 Field 的公式。公式會定義資料轉換,數據分析會在查詢時執行這項轉換。

參數

名稱類型說明
formulaString要設定的公式。

回攻員

Field:這個建構工具用於串連。


setGroup(group)

設定這個 Field 的群組。系統會將收集到群組中的欄位一起顯示在數據分析使用者介面中。

參數

名稱類型說明
groupString要設定的群組。

回攻員

Field:這個建構工具用於串連。


setId(id)

設定這個 Field 的 ID。每個欄位組合都有專屬 ID,可用於公式中參照欄位。

參數

名稱類型說明
idString要設定的 ID。

回攻員

Field:這個建構工具用於串連。


setIsHidden(isHidden)

設定這個 Field 的隱藏狀態。您可以在公式中使用隱藏欄位,但無法在圖表中使用。含有公式的欄位無法隱藏。

參數

名稱類型說明
isHiddenBoolean要設定的隱藏狀態。

回攻員

Field:這個建構工具用於串連。


setIsReaggregatable(isReaggregatable)

為 Field 設定允許重新彙整的狀態。嘗試為無法重新匯總的欄位設定匯總類型會導致錯誤。

參數

名稱類型說明
isReaggregatableBoolean要設定的允許重新彙整狀態。

回攻員

Field:這個建構工具用於串連。


setName(name)

設定這個 Field 的名稱。名稱會向使用者顯示,用於區分欄位。

參數

名稱類型說明
nameString要設定的名稱。

回攻員

Field:這個建構工具用於串連。


setType(type)

設定這個 Field 的 FieldType。

參數

名稱類型說明
typeFieldType要設定的類型。

回攻員

Field:這個建構工具用於串連。