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 - 如果此 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 的公式。公式定义了数据洞察在查询时运行的数据转换。

参数

名称	类型	说明
formula	String	要设置的公式。

返回

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

---

setGroup(group)

设置相应 Field 的组。归入同一组的字段会一起显示在数据洞察界面中。

参数

名称	类型	说明
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 - 此构建器，用于链式调用。