Class Fields

字段

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

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

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

方法

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

详细文档

asArray()

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

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

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

返回

Field[] - Field 对象的数组。

build()

验证此对象，并以数据分析所需的格式返回该对象。

返回

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

抛出

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

forIds(ids)

返回一个新的 Fields 对象，其中包含 ID 在 ids 中的 Field 已被过滤掉。 

const fields = DataStudioApp.createCommunityConnector().getFields();
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.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

参数

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

返回

Fields - 一个新的 Fields 对象。

getDefaultDimension()

返回要为这组字段使用的默认维度。创建新可视化图表时，系统会自动选择默认维度。

返回

Field - 设置为默认维度的维度；如果未设置默认维度，则为 null。

getDefaultMetric()

返回要为这组字段使用的默认指标。创建新可视化图表时，系统会自动选择默认指标。

返回

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

getFieldById(fieldId)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

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

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

参数

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

返回

Field - 具有给定 ID 的 Field；如果此 Fields 对象中不包含此类字段，则返回 null。

newDimension()

返回新的维度 Field。

返回

Field - 新维度 Field。

newMetric()

返回新指标 Field。

返回

Field - 新指标 Field。

setDefaultDimension(fieldId)

设置要为这组字段使用的默认维度。创建新可视化图表时，系统会自动选择默认维度。

参数

名称类型说明
fieldIdString要用作默认维度的字段的 ID。此 ID 必须包含在该组字段中。

setDefaultMetric(fieldId)

设置要为这组字段使用的默认指标。创建新可视化图表时，系统会自动选择默认指标。

参数

名称类型说明
fieldIdString要用作默认指标的字段的 ID。此 ID 必须包含在该组字段中。