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	返回一个新的 Fields 对象，该对象过滤为 Field 且 ID 为 ids。
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)

返回一个新的 Fields 对象，该对象过滤为 Field 且 ID 为 ids。

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']);

参数

名称	类型	说明
ids	String[]	应保留的字段的 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');

参数

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

弃踢回攻

Field - 具有指定 ID 的 Field，或 null（如果此 Fields 对象中不包含此类字段）。

---

newDimension()

返回新维度 Field。

弃踢回攻

Field - 新维度 Field。

---

newMetric()

返回新指标 Field。

弃踢回攻

Field - 新指标 Field。

---

setDefaultDimension(fieldId)

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

参数

名称	类型	说明
fieldId	String	要用作默认维度的字段的 ID。此 ID 必须存在于一组字段中。

---

setDefaultMetric(fieldId)

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

参数

名称	类型	说明
fieldId	String	要用作默认指标的字段的 ID。此 ID 必须存在于一组字段中。