此页面由 Cloud Translation API 翻译。

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`	返回此 `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 的公式。公式用于定义数据转换 Studio 在查询时运行。

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决定了数据 Studio 会将类似的数据合并到维度中。如果对指标调用，则会抛出错误。

参数

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