Эта страница переведена с помощью Cloud Translation API.

Class Field

Содержит данные, относящиеся к полю. Его свойства определяют, как поле используется в 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');

Методы

Метод	Тип возвращаемого значения	Краткое описание
`get Aggregation()`	`Aggregation Type`	Возвращает `Aggregation Type` этого `Field` .
`get Description()`	`String`	Возвращает описание этого `Field` .
`get Formula()`	`String`	Возвращает формулу этого `Field` .
`get Group()`	`String`	Возвращает группу этого `Field` .
`get Id()`	`String`	Возвращает идентификатор этого `Field` .
`get Is Reaggregatable()`	`Boolean`	Возвращает `true` , если это поле можно повторно агрегировать, `false` в противном случае.
`get Name()`	`String`	Возвращает имя этого `Field` .
`get Type()`	`Field Type`	Возвращает `Field Type` данного `Field` .
`is Default()`	`Boolean`	Возвращает `true` если это `Field` является метрикой или измерением по умолчанию.
`is Dimension()`	`Boolean`	Возвращает `true` если это поле является измерением.
`is Hidden()`	`Boolean`	Возвращает `true` если это `Field` скрыто.
`is Metric()`	`Boolean`	Возвращает `true` если это поле является метрикой.
`set Aggregation(aggregation)`	`Field`	Задает тип агрегации для этого `Field` .
`set Description(description)`	`Field`	Задает описание этого `Field` .
`set Formula(formula)`	`Field`	Задает формулу для этого `Field` .
`set Group(group)`	`Field`	Задает группу для этого `Field` .
`set Id(id)`	`Field`	Задает идентификатор этого `Field` .
`set Is Hidden(isHidden)`	`Field`	Устанавливает скрытый статус этого `Field` .
`set Is Reaggregatable(isReaggregatable)`	`Field`	Устанавливает статус разрешения повторной агрегации для `Field` .
`set Name(name)`	`Field`	Задает имя этого `Field` .
`set Type(type)`	`Field`	Задает `Field Type` для данного `Field` .

Подробная документация

`getAggregation()`

Возвращает тип AggregationType этого Field . AggregationType определяет, как Data Studio объединяет похожие данные в измерения.

Возвращаться

AggregationType — Тип агрегации для этого поля.

`getDescription()`

Возвращает описание данного Field . Описания представляют собой краткие пояснения назначения поля.

Возвращаться

String — Описание для этого поля.

`getFormula()`

Возвращает формулу этого Field . Формулы определяют преобразование данных, которое Data Studio выполняет во время выполнения запроса.

Возвращаться

String — формула для этого поля.

`getGroup()`

Возвращает группу данного Field . Поля, объединенные в группу, отображаются вместе в пользовательском интерфейсе Data Studio.

Возвращаться

String — Группа для этого поля.

`getId()`

Возвращает идентификатор этого Field . Идентификаторы уникальны для каждого набора полей и используются в формулах для ссылки на поля.

Возвращаться

String — Идентификатор этого поля.

`getIsReaggregatable()`

Возвращает true , если это поле можно повторно агрегировать, false в противном случае.

Возвращаться

Boolean — true если это поле можно повторно агрегировать, false в противном случае.

`getName()`

Возвращает имя этого Field . Имена отображаются пользователю для различения полей.

Возвращаться

String — Название этого поля.

`getType()`

Возвращает FieldType этого Field .

Возвращаться

FieldType — Тип данных для этого поля.

`isDefault()`

Возвращает true если это Field является метрикой или измерением по умолчанию.

Возвращаться

Boolean — true если это Field является метрикой или измерением по умолчанию; false в противном случае.

`isDimension()`

Возвращает true если это поле является измерением.

Возвращаться

Boolean — true если это поле является измерением; в противном случае возвращает false .

`isHidden()`

Возвращает true если это Field скрыто. Скрытые поля можно использовать в формулах, но не в диаграммах. Поля, содержащие формулы, скрыть нельзя.

Возвращаться

Boolean — true если это Field скрыто; false в противном случае.

`isMetric()`

Возвращает true если это поле является метрикой.

Возвращаться

Boolean — true , если это поле является метрикой; в противном случае возвращает false .

`setAggregation(aggregation)`

Задает тип агрегации для этого Field . AggregationType определяет, как Data Studio объединяет похожие данные в измерения. При вызове этой функции для метрики возникнет ошибка.