Class Field

欄位

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

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

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

方法

方法傳回類型簡短說明
getAggregation()AggregationType傳回此 FieldAggregationType
getDescription()String傳回此 Field 的說明。
getFormula()String傳回這個 Field 的公式。
getGroup()String傳回這個 Field 的群組。
getId()String傳回此 Field 的 ID。
getIsReaggregatable()Boolean如果這個欄位可以重新匯總,則傳回 true,否則傳回 false
getName()String傳回此 Field 的名稱。
getType()FieldType傳回此 FieldFieldType
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設定這個 FieldFieldType

內容詳盡的說明文件

getAggregation()

傳回此 FieldAggregationTypeAggregationType 會決定 Google 數據分析如何將類似資料合併成維度。

回攻員

AggregationType:這個欄位的 aggregateType。


getDescription()

傳回此 Field 的說明。說明是欄位用途的簡短說明。

回攻員

String:這個欄位的說明。


getFormula()

傳回這個 Field 的公式。公式定義了 Data Studio 在查詢時執行的資料轉換。

回攻員

String:這個欄位的公式。


getGroup()

傳回這個 Field 的群組。收集至群組的欄位會一起顯示在數據分析 UI 中。

回攻員

String:這個欄位的群組。


getId()

傳回此 Field 的 ID。ID 是每個欄位組合的專屬 ID,用於在公式中參照欄位。

回攻員

String:這個欄位的 ID。


getIsReaggregatable()

如果這個欄位可以重新匯總,則傳回 true,否則傳回 false

回攻員

Booleantrue 如果這個欄位可重新匯總,則傳回 false


getName()

傳回此 Field 的名稱。系統會向使用者顯示名稱來區分欄位。

回攻員

String:這個欄位的名稱。


getType()

傳回此 FieldFieldType

回攻員

FieldType:這個欄位的類型。


isDefault()

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

回攻員

Boolean — 如果 Field 是預設指標或維度,則為 true,否則為 false


isDimension()

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

回攻員

Boolean - 如果這個欄位是維度,則為 true;否則會傳回 false


isHidden()

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

回攻員

Boolean - 如果此 Field 為隱藏,則為 true;否則為 false


isMetric()

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

回攻員

Boolean — 如果這個欄位是指標,則為 true;否則會傳回 false


setAggregation(aggregation)

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

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setDescription(description)

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

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setFormula(formula)

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

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setGroup(group)

設定這個 Field 的群組。收集至群組的欄位會一起顯示在數據分析 UI 中。

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setId(id)

設定此 Field 的 ID。ID 是每個欄位組合的專屬 ID,用於參照欄位的公式。

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setIsHidden(isHidden)

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

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setIsReaggregatable(isReaggregatable)

設定 Field 的重新匯總允許狀態。如果您嘗試在無法重新匯總的欄位上設定匯總類型,就會導致錯誤。

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setName(name)

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

參數

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

回攻員

Field — 這個建構工具用於鏈結。


setType(type)

設定這個 FieldFieldType

參數

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

回攻員

Field — 這個建構工具用於鏈結。