Class Field

字段

包含与字段相关的数据。其属性决定了该字段在数据洞察中的使用方式。

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)FieldField 设置允许重新汇总的状态。
setName(name)Field设置此 Field 的名称。
setType(type)Field设置此 FieldFieldType

详细文档

getAggregation()

返回该 FieldAggregationTypeAggregationType 决定了数据洞察如何将类似数据组合成维度。

弃踢回攻

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()

返回该 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 决定了数据洞察如何将类似数据组合成维度。如果对指标进行调用,则会抛出错误。

参数

名称类型说明
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)

设置此 FieldFieldType

参数

名称类型说明
typeFieldType要设置的类型。

弃踢回攻

Field - 此构建器,用于链接。