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 .

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

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


getName()

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

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

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


getType()

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

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

FieldType — Тип для этого поля.


isDefault()

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

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

Booleantrue , если это Field является метрикой или параметром по умолчанию; false противном случае.


isDimension()

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

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

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


isHidden()

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

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

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


isMetric()

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

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

Booleantrue , если это поле является метрикой; в противном случае возвращает 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 — это построитель, для цепочки.