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

Class Fields

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

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

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

Методы

Метод	Тип возврата	Краткое описание
`asArray()`	`Field[]`	Возвращает представление этого объекта в виде массива.
`build()`	`Object[]`	Проверяет этот объект и возвращает его в формате, необходимом Data Studio.
`forIds(ids)`	`Fields`	Возвращает новый объект `Fields` , отфильтрованный по `Field` с идентификатором в `ids` .
`getDefaultDimension()`	`Field`	Возвращает измерение по умолчанию, которое будет использоваться для набора полей.
`getDefaultMetric()`	`Field`	Возвращает метрику по умолчанию, которая будет использоваться для набора полей.
`getFieldById(fieldId)`	`Field`	Возвращает поле с заданным идентификатором или `null` , если в этом объекте `Fields` нет поля с этим идентификатором.
`newDimension()`	`Field`	Возвращает новое измерение `Field` .
`newMetric()`	`Field`	Возвращает новое `Field` метрики.
`setDefaultDimension(fieldId)`	`void`	Устанавливает размерность по умолчанию, которая будет использоваться для набора полей.
`setDefaultMetric(fieldId)`	`void`	Устанавливает метрику по умолчанию, которая будет использоваться для набора полей.

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

`asArray()`

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

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

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

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

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

`build()`

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

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

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

Броски

Error — если действительный объект не может быть создан.

`forIds(ids)`

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

var fields = //reference to fields object.
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.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

Параметры

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

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

Fields — новый объект Fields .

`getDefaultDimension()`

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

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

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

`getDefaultMetric()`

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

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

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

`getFieldById(fieldId)`

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

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

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

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

Параметры

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

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

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

`newDimension()`

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

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

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

`newMetric()`

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

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

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

`setDefaultDimension(fieldId)`

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

Параметры

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

`setDefaultMetric(fieldId)`

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

Параметры

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