本頁面由 Cloud Translation API 翻譯而成。

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 的公式。公式定義了 Data Studio 在查詢時執行的資料轉換作業。

回攻員

String：這個欄位的公式。

`getGroup()`

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

回攻員

String：這個欄位的群組。

`getId()`

傳回此 Field 的 ID。ID 是每組欄位的專屬值，可用於公式中參照欄位。

回攻員

String：這個欄位的 ID。

`getIsReaggregatable()`

如果這個欄位可重新匯總，就會傳回 true，否則傳回 false。

回攻員

Boolean：如果這個欄位可重新匯總，則為 true；否則為 false。

`getName()`

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

回攻員

String：這個欄位的名稱。

`getType()`

傳回此 Field 的 FieldType。

回攻員

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 會決定數據分析如何將類似資料合併為維度。如果在指標上呼叫，這個方法會擲回錯誤。

參數

名稱	類型	說明
`aggregation`	`AggregationType`	要設定的匯總類型。

回攻員

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

`setDescription(description)`

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

參數

名稱	類型	說明
`description`	`String`	要設定的說明。

回攻員

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

`setFormula(formula)`

設定此 Field 的公式。公式定義了 Data Studio 在查詢時執行的資料轉換作業。

參數

名稱	類型	說明
`formula`	`String`	要設定的公式。

回攻員

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

`setGroup(group)`

可設定此 Field 的群組。收集到群組中的欄位會在 Data Studio UI 中一起顯示。

參數

名稱	類型	說明
`group`	`String`	要設定的群組。

回攻員

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

`setId(id)`

設定此 Field 的 ID。ID 是每組欄位的專屬值，可用於公式中參照欄位。

參數

名稱	類型	說明
`id`	`String`	要設定的 ID。

回攻員

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

`setIsHidden(isHidden)`

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

參數

名稱	類型	說明
`isHidden`	`Boolean`	要設定的隱藏狀態。

回攻員

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

`setIsReaggregatable(isReaggregatable)`

設定 Field 的重新匯總許可狀態。嘗試在無法重新匯總的欄位上設定匯總類型，會導致錯誤。

參數

名稱	類型	說明
`isReaggregatable`	`Boolean`	要設定的重新匯總許可狀態。

回攻員

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

`setName(name)`

設定此 Field 的名稱。系統會向使用者顯示名稱，以便區分欄位。

參數

名稱	類型	說明
`name`	`String`	要設定的名稱。

回攻員

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

`setType(type)`

設定此 Field 的 FieldType。

參數

名稱	類型	說明
`type`	`FieldType`	要設定的類型。

回攻員

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