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

Class Fields

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

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`	Возвращает поле с заданным идентификатором или `null` если в этом объекте `Fields` нет поля с этим идентификатором.
`new Dimension()`	`Field`	Возвращает новое измерение `Field` .
`new Metric()`	`Field`	Возвращает новое `Field` метрики.
`set Default Dimension(fieldId)`	`void`	Устанавливает размерность по умолчанию, которая будет использоваться для набора полей.
`set Default Metric(fieldId)`	`void`	Устанавливает метрику по умолчанию, которая будет использоваться для набора полей.

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

`as Array()`

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

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 — если действительный объект не может быть создан.

`for Ids(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 .

`get Default Dimension()`

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

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

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

`get Default Metric()`

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

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

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

`get Field By Id(fieldId)`

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

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 .

`new Dimension()`

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

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

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

`new Metric()`

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

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

Field — новая метрика Field .

`set Default Dimension(fieldId)`

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

Параметры

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

`set Default Metric(fieldId)`

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

Параметры

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