Эта страница переведена с помощью 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` .

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

`get Aggregation()`

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

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

Aggregation Type — тип агрегации для этого поля.

`get Description()`

Возвращает описание этого Field . Описания — это краткие пояснения назначения поля.

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

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

`get Formula()`

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

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

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

`get Group()`

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

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

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

`get Id()`

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

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

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

`get Is Reaggregatable()`

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

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

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

`get Name()`

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

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

String — имя этого поля.

`get Type()`

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

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

Field Type — тип этого поля.

`is Default()`

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

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

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

`is Dimension()`

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

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

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

`is Hidden()`

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

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

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

`is Metric()`

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

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

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

`set Aggregation(aggregation)`

Устанавливает тип агрегирования этого Field . Aggregation Type определяет, как Data Studio объединяет схожие данные в измерения. Это выдает ошибку при вызове метрики.

Параметры

Имя	Тип	Описание
`aggregation`	`Aggregation Type`	Тип агрегации, который необходимо установить.

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

Field — это конструктор, для цепочки.

`set Description(description)`

Устанавливает описание этого Field . Описания — это краткие пояснения назначения поля.

Параметры

Имя	Тип	Описание
`description`	`String`	Описание для установки.

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

Field — это конструктор, для цепочки.

`set Formula(formula)`

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

Параметры

Имя	Тип	Описание
`formula`	`String`	Формула для установки.

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

Field — это конструктор, для цепочки.

`set Group(group)`

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

Параметры

Имя	Тип	Описание
`group`	`String`	Группа для установки.

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

Field — это конструктор, для цепочки.

`set Id(id)`

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

Параметры

Имя	Тип	Описание
`id`	`String`	Идентификатор, который необходимо установить.

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

Field — это конструктор, для цепочек.

`set Is Hidden(isHidden)`

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

Параметры

Имя	Тип	Описание
`is Hidden`	`Boolean`	Скрытый статус, который нужно установить.

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

Field — это конструктор, для цепочек.

`set Is Reaggregatable(isReaggregatable)`

Устанавливает статус разрешения реагрегации для Field . Попытка установить тип агрегирования для поля, которое невозможно повторно агрегировать, приводит к ошибке.

Параметры

Имя	Тип	Описание
`is Reaggregatable`	`Boolean`	Устанавливаемый статус разрешенной реагрегации.

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

Field — это конструктор, для цепочек.

`set Name(name)`

Устанавливает имя этого Field . Имена отображаются пользователю, чтобы различать поля.

Параметры

Имя	Тип	Описание
`name`	`String`	Имя для установки.

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

Field — это конструктор, для цепочки.

`set Type(type)`

Устанавливает Field Type этого Field .

Параметры

Имя	Тип	Описание
`type`	`Field Type`	Тип, который необходимо установить.

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

Field — это конструктор, для цепочки.