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

Class Field

Содержит данные, относящиеся к полю. Его свойства определяют, как поле используется в Data Studio.

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

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

Методы

Метод	Тип возврата	Краткое описание
`getAggregation()`	`AggregationType`	Возвращает `AggregationType` этого `Field` .
`getDescription()`	`String`	Возвращает описание этого `Field` .
`getFormula()`	`String`	Возвращает формулу этого `Field` .
`getGroup()`	`String`	Возвращает группу этого `Field` .
`getId()`	`String`	Возвращает идентификатор этого `Field` .
`getIsReaggregatable()`	`Boolean`	Возвращает `true` , если это поле можно повторно агрегировать, в противном случае — `false` .
`getName()`	`String`	Возвращает имя этого `Field` .
`getType()`	`FieldType`	Возвращает `FieldType` этого `Field` .
`isDefault()`	`Boolean`	Возвращает `true` , если это `Field` является метрикой или измерением по умолчанию.
`isDimension()`	`Boolean`	Возвращает `true` , если это поле является измерением.
`isHidden()`	`Boolean`	Возвращает `true` , если это `Field` скрыто.
`isMetric()`	`Boolean`	Возвращает `true` , если это поле является метрикой.
`setAggregation(aggregation)`	`Field`	Устанавливает тип агрегирования этого `Field` .
`setDescription(description)`	`Field`	Устанавливает описание этого `Field` .
`setFormula(formula)`	`Field`	Устанавливает формулу этого `Field` .
`setGroup(group)`	`Field`	Устанавливает группу этого `Field` .
`setId(id)`	`Field`	Устанавливает идентификатор этого `Field` .
`setIsHidden(isHidden)`	`Field`	Устанавливает скрытый статус этого `Field` .
`setIsReaggregatable(isReaggregatable)`	`Field`	Устанавливает статус разрешения реагрегации для `Field` .
`setName(name)`	`Field`	Устанавливает имя этого `Field` .
`setType(type)`	`Field`	Устанавливает `FieldType` этого `Field` .

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

`getAggregation()`

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

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

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

`getDescription()`

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

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

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

`getFormula()`

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

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

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

`getGroup()`

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

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

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 объединяет схожие данные в измерения. Это выдает ошибку при вызове метрики.

Параметры

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

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

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

`setDescription(description)`

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

Параметры

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

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

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

`setFormula(formula)`

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

Параметры

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

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

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

`setGroup(group)`

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

Параметры

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

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

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

`setId(id)`

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

Параметры

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

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

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

`setIsHidden(isHidden)`

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

Параметры

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

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

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

`setIsReaggregatable(isReaggregatable)`

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

Параметры

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

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

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

`setName(name)`

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

Параметры

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

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

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

`setType(type)`

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

Параметры

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

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

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