Class Fields

Contains a set of Fields for a community connector. This set of fields define which dimensions and metrics can be used in Data Studio.

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

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

Methods

Method	Return type	Brief description
`asArray()`	`Field[]`	Returns a view of this object as an array.
`build()`	`Object[]`	Validates this object and returns it in the format needed by Data Studio.
`forIds(ids)`	`Fields`	Returns a new `Fields` object filtered to `Field`s with an ID in `ids`.
`getDefaultDimension()`	`Field`	Returns the default dimension to be used for the set of fields.
`getDefaultMetric()`	`Field`	Returns the default metric to be used for the set of fields.
`getFieldById(fieldId)`	`Field`	Returns a field with a given ID, or `null` if no field with that ID is in this `Fields` object.
`newDimension()`	`Field`	Returns a new dimension `Field`.
`newMetric()`	`Field`	Returns a new metric `Field`.
`setDefaultDimension(fieldId)`	`void`	Sets the default dimension to be used for the set of fields.
`setDefaultMetric(fieldId)`	`void`	Sets the default metric to be used for the set of fields.

Detailed documentation

`asArray()`

Returns a view of this object as an array.

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

Return

Field[] — An array of Field objects.

`build()`

Validates this object and returns it in the format needed by Data Studio.

Return

Object[] — The validated field data, represented as a list of objects.

Throws

Error — if a valid object cannot be constructed.

`forIds(ids)`

Returns a new Fields object filtered to Fields with an ID in 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']);

Parameters

Name	Type	Description
`ids`	`String[]`	The IDs of fields that should be kept.

Return

Fields — A new Fields object.

`getDefaultDimension()`

Returns the default dimension to be used for the set of fields. The default dimension is selected automatically when a new visualization is made.

Return

Field — The dimension that is set as the default dimension, or null if no default dimension was set.

`getDefaultMetric()`

Returns the default metric to be used for the set of fields. The default metric is selected automatically when a new visualization is made.

Return

Field — The metric that is set as the default metric, or null if no default metric was set.

`getFieldById(fieldId)`

Returns a field with a given ID, or null if no field with that ID is in this Fields object.

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

Parameters

Name	Type	Description
`fieldId`	`String`	The ID of the field to get.

Return

Field — The Field with the given ID, or null if no such field is contained within this Fields object.

`newDimension()`

Returns a new dimension Field.

Return

Field — A new dimension Field.

`newMetric()`

Returns a new metric Field.

Return

Field — A new metric Field.

`setDefaultDimension(fieldId)`

Sets the default dimension to be used for the set of fields. The default dimension is selected automatically when a new visualization is made.

Parameters

Name	Type	Description
`fieldId`	`String`	The ID of the field to use as the default dimension. This ID must be present in the set of fields.

`setDefaultMetric(fieldId)`

Sets the default metric to be used for the set of fields. The default metric is selected automatically when a new visualization is made.

Parameters

Name	Type	Description
`fieldId`	`String`	The ID of the field to use as the default metric. This ID must be present in the set of fields.