Class Field

AI-generated Key Takeaways

A Field object contains data-related information and its properties determine how it's used in Data Studio.
You can create a new field using fields.newDimension() or similar methods.
Field objects have methods to get and set various properties like ID, name, description, type, and aggregation.
Methods starting with get retrieve the current value of a field property.
Methods starting with set modify the value of a field property and return the Field object for chaining.

Contains field-related data. Its properties determine how the field is used in Data Studio.

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

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

Methods

Method	Return type	Brief description
`getAggregation()`	`AggregationType`	Returns the `AggregationType` of this `Field`.
`getDescription()`	`String`	Returns the description of this `Field`.
`getFormula()`	`String`	Returns the formula of this `Field`.
`getGroup()`	`String`	Returns the group of this `Field`.
`getId()`	`String`	Returns the ID of this `Field`.
`getIsReaggregatable()`	`Boolean`	Returns `true` if this field can be reaggregated, `false` otherwise.
`getName()`	`String`	Returns the name of this `Field`.
`getType()`	`FieldType`	Returns the `FieldType` of this `Field`.
`isDefault()`	`Boolean`	Returns `true` if this `Field` is the default metric or dimension.
`isDimension()`	`Boolean`	Returns `true` if this field is a dimension.
`isHidden()`	`Boolean`	Returns `true` if this `Field` is hidden.
`isMetric()`	`Boolean`	Returns `true` if this field is a metric.
`setAggregation(aggregation)`	`Field`	Sets the aggregation type of this `Field`.
`setDescription(description)`	`Field`	Sets the description of this `Field`.
`setFormula(formula)`	`Field`	Sets the formula of this `Field`.
`setGroup(group)`	`Field`	Sets the group of this `Field`.
`setId(id)`	`Field`	Sets the ID of this `Field`.
`setIsHidden(isHidden)`	`Field`	Sets the hidden status of this `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Sets the reaggregation-permitted status for a `Field`.
`setName(name)`	`Field`	Sets the name of this `Field`.
`setType(type)`	`Field`	Sets the `FieldType` of this `Field`.

Detailed documentation

`getAggregation()`

Returns the AggregationType of this Field. AggregationType determines how Data Studio combines similar data into dimensions.

Return

AggregationType — The aggregationType for this field.

`getDescription()`

Returns the description of this Field. Descriptions are short explanations of a field's purpose.

Return

String — The description for this field.

`getFormula()`

Returns the formula of this Field. Formulas define a data transformation that Data Studio runs at query-time.

Return

String — The formula for this field.

`getGroup()`

Returns the group of this Field. Fields collected into a group are presented together in the Data Studio UI.

Return

String — The group for this field.

`getId()`

Returns the ID of this Field. IDs are unique per set of fields and are used in formulas to refer to fields.

Return

String — The ID for this field.

`getIsReaggregatable()`

Returns true if this field can be reaggregated, false otherwise.

Return

Boolean — true if this field can be reaggregated, false otherwise.

`getName()`

Returns the name of this Field. Names are shown to the user to distinguish fields.

Return

String — The name for this field.

`getType()`

Returns the FieldType of this Field.

Return

FieldType — The type for this field.

`isDefault()`

Returns true if this Field is the default metric or dimension.

Return

Boolean — true if this Field is the default metric or dimension; false otherwise.

`isDimension()`

Returns true if this field is a dimension.

Return

Boolean — true if this field is a dimension; returns false otherwise.

`isHidden()`

Returns true if this Field is hidden. You can use hidden fields in formulas, but not in charts. You cannot hide fields containing formulas.

Return

Boolean — true if this Field is hidden; false otherwise.

`isMetric()`

Returns true if this field is a metric.

Return

Boolean — true if this field is a metric; returns false otherwise.

`setAggregation(aggregation)`

Sets the aggregation type of this Field. AggregationType determines how Data Studio combines similar data into dimensions. This throws an error if called on a metric.