Class Fields

字段

包含社区连接器的一组 Field。这组字段定义了 维度和指标可在数据洞察中使用 

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

var field1 = fields.newDimension()
  // Set other properties as needed.
  .setId('field1_id');

方法

方法返回类型简介
asArray()Field[]以数组的形式返回此对象的视图。
build()Object[]验证此对象并以数据洞察所需的格式返回它。
forIds(ids)Fields返回过滤到 Field 且 ID 为 ids 的新 Fields 对象。
getDefaultDimension()Field返回要用于一组字段的默认维度。
getDefaultMetric()Field返回用于一组字段的默认指标。
getFieldById(fieldId)Field返回具有指定 ID 的字段，或者如果此 Fields 对象中没有具有该 ID 的字段，则返回 null。
newDimension()Field返回新维度 Field。
newMetric()Field返回新指标 Field。
setDefaultDimension(fieldId)void设置用于一组字段的默认维度。
setDefaultMetric(fieldId)void设置用于一组字段的默认指标。

详细文档

asArray()

以数组的形式返回此对象的视图。 

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields
  .asArray()
  .map(function(field) {
     Logger.log(field.getId());
  });

返回

Field[] - 一组 Field 对象。

build()

验证此对象并以数据洞察所需的格式返回它。

返回

Object[] - 经过验证的字段数据，表示为对象列表。

抛出

Error - 如果无法构建有效对象。

forIds(ids)

返回过滤到 Field 且 ID 为 ids 的新 Fields 对象。 

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

参数

名称类型说明
idsString[]应保留的字段的 ID。

返回

Fields - 一个新的 Fields 对象。

getDefaultDimension()

返回用于一组字段的默认维度。默认维度为 在生成新可视化图表时会自动选择的项目。

返回

Field - 设置为默认维度的维度，如果没有默认维度，则为 null 已设置维度。

getDefaultMetric()

返回要用于一组字段的默认指标。已选择默认指标 在生成新可视化图表时自动显示

返回

Field - 设置为默认指标的指标，如果未设置默认指标，则为 null 。

getFieldById(fieldId)

返回具有指定 ID 的字段，或者如果此 Fields 对象中没有具有该 ID 的字段，则返回 null。 

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
var byId = fields.getFieldById('field1_id');

// byId2 is null.
var byId2 = fields.getFieldById('not present id');

参数

名称类型说明
fieldIdString要获取的字段的 ID。

返回

Field - 具有指定 ID 的 Field，如果未包含此类字段，则为 null 此 Fields 对象中。

newDimension()

返回新维度 Field。

返回

Field - 新维度 Field。

newMetric()

返回新指标 Field。

返回

Field - 新指标 Field。

setDefaultDimension(fieldId)

设置用于一组字段的默认维度。已选择默认维度 在生成新可视化图表时自动显示

参数

名称类型说明
fieldIdString要用作默认维度的字段的 ID。此 ID 必须出现在 这组字段。

setDefaultMetric(fieldId)

设置用于一组字段的默认指标。已选择默认指标 在生成新可视化图表时自动显示

参数

名称类型说明
fieldIdString要用作默认指标的字段的 ID。此 ID 必须出现在 一组字段。