Class Fields

Поля

Содержит набор Field для коннектора сообщества. Этот набор полей определяет, какие измерения и метрики можно использовать в Data Studio.

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

const field1 = fields
                   .newDimension()
                   // Set other properties as needed.
                   .setId('field1_id');

Методы

Метод Тип возвращаемого значения Краткое описание
as Array() Field[] Возвращает представление этого объекта в виде массива.
build() Object[] Проверяет этот объект и возвращает его в формате, необходимом для Data Studio.
for Ids(ids) Fields Возвращает новый объект Fields , отфильтрованный по Field с идентификатором из ids .
get Default Dimension() Field Возвращает измерение по умолчанию, которое будет использоваться для набора полей.
get Default Metric() Field Возвращает метрику по умолчанию, которая будет использоваться для набора полей.
get Field By Id(fieldId) Field Возвращает поле с заданным ID или null , если в объекте Fields нет поля с таким ID.
new Dimension() Field Возвращает новое измерение Field .
new Metric() Field Возвращает новый объект метрики Field .
set Default Dimension(fieldId) void Задает измерение по умолчанию, которое будет использоваться для набора полей.
set Default Metric(fieldId) void Задает метрику по умолчанию, которая будет использоваться для набора полей.

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

asArray()

Возвращает представление этого объекта в виде массива.

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields.asArray().map((field) => {
  Logger.log(field.getId());
});

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

Field[] — Массив объектов Field .

build()

Проверяет этот объект и возвращает его в формате, необходимом для Data Studio.

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

Object[] — Проверенные данные поля, представленные в виде списка объектов.

Броски

Error — если не удаётся создать допустимый объект.

forIds(ids)

Возвращает новый объект Fields , отфильтрованный по Field с идентификатором из ids .

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

Параметры

Имя Тип Описание
ids String[] Идентификаторы полей, которые следует сохранить.

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

Fields — Новый объект типа Fields .

getDefaultDimension()

Возвращает измерение по умолчанию, используемое для набора полей. Измерение по умолчанию выбирается автоматически при создании новой визуализации.

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

Field — измерение, которое устанавливается в качестве измерения по умолчанию, или null если измерение по умолчанию не было установлено.

getDefaultMetric()

Возвращает метрику по умолчанию, используемую для набора полей. Метрика по умолчанию выбирается автоматически при создании новой визуализации.

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

Field — метрика, которая устанавливается в качестве метрики по умолчанию, или null если метрика по умолчанию не была установлена.

getFieldById(fieldId)

Возвращает поле с заданным ID или null , если в объекте Fields нет поля с таким ID.

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
const byId = fields.getFieldById('field1_id');

// byId2 is null.
const byId2 = fields.getFieldById('not present id');

Параметры

Имя Тип Описание
field Id String Идентификатор поля, которое нужно получить.

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

Field — Field с заданным идентификатором или null , если такое поле отсутствует в объекте Fields .

newDimension()

Возвращает новое измерение Field .

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

Field — новое измерение Field

newMetric()

Возвращает новый объект метрики Field .

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

Field — новая Field .

setDefaultDimension(fieldId)

Задает измерение по умолчанию, используемое для набора полей. Измерение по умолчанию выбирается автоматически при создании новой визуализации.

Параметры

Имя Тип Описание
field Id String Идентификатор поля, используемого в качестве измерения по умолчанию. Этот идентификатор должен присутствовать в наборе полей.

setDefaultMetric(fieldId)

Задает метрику по умолчанию, которая будет использоваться для набора полей. Метрика по умолчанию выбирается автоматически при создании новой визуализации.

Параметры

Имя Тип Описание
field Id String Идентификатор поля, используемого в качестве метрики по умолчанию. Этот идентификатор должен присутствовать в наборе полей.