Se usó la API de Cloud Translation para traducir esta página.

Class Fields

Contiene un conjunto de elementos Field para un conector de comunidad. Este conjunto de campos define qué dimensiones y métricas se pueden usar en Data Studio.

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

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

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`asArray()`	`Field[]`	Muestra una vista de este objeto como un array.
`build()`	`Object[]`	Valida este objeto y lo muestra en el formato que necesita Data Studio.
`forIds(ids)`	`Fields`	Muestra un objeto `Fields` nuevo filtrado por `Field` con un ID en `ids`.
`getDefaultDimension()`	`Field`	Muestra la dimensión predeterminada que se utilizará para el conjunto de campos.
`getDefaultMetric()`	`Field`	Muestra la métrica predeterminada que se usará para el conjunto de campos.
`getFieldById(fieldId)`	`Field`	Muestra un campo con un ID determinado o `null` si no hay ningún campo con ese ID en este objeto `Fields`.
`newDimension()`	`Field`	Muestra una nueva dimensión `Field`.
`newMetric()`	`Field`	Muestra una métrica nueva `Field`.
`setDefaultDimension(fieldId)`	`void`	Establece la dimensión predeterminada que se utilizará para el conjunto de campos.
`setDefaultMetric(fieldId)`	`void`	Establece la métrica predeterminada que se usará para el conjunto de campos.

Documentación detallada

`asArray()`

Muestra una vista de este objeto como un array.

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());
  });

Devolvedor

Field[]: Es un array de objetos Field.

`build()`

Valida este objeto y lo muestra en el formato que necesita Data Studio.

Devolvedor

Object[]: Son los datos del campo validados, representados como una lista de objetos.

Arroja

Error: Si no se puede construir un objeto válido.

`forIds(ids)`

Muestra un objeto Fields nuevo filtrado por Field con un ID en 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']);

Parámetros

Nombre	Tipo	Descripción
`ids`	`String[]`	Los ID de los campos que se deben conservar.

Devolvedor

Fields: Es un objeto Fields nuevo.

`getDefaultDimension()`

Muestra la dimensión predeterminada que se utilizará para el conjunto de campos. La dimensión predeterminada se selecciona automáticamente cuando se realiza una visualización nueva.

Devolvedor

Field: Es la dimensión que se establece como predeterminada, o null si no se estableció una dimensión predeterminada.

`getDefaultMetric()`

Muestra la métrica predeterminada que se usará para el conjunto de campos. La métrica predeterminada se selecciona automáticamente cuando se realiza una visualización nueva.

Devolvedor

Field: La métrica que se establece como la métrica predeterminada, o null si no se estableció ninguna métrica predeterminada.

`getFieldById(fieldId)`

Muestra un campo con un ID determinado o null si no hay ningún campo con ese ID en este objeto 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');

Parámetros

Nombre	Tipo	Descripción
`fieldId`	`String`	El ID del campo que se obtendrá.

Devolvedor

Field: Es el Field con el ID dado, o null si no está contenido ese campo dentro de este objeto Fields.

`newDimension()`

Muestra una nueva dimensión Field.

Devolvedor

Field: Es una nueva dimensión Field.

`newMetric()`

Muestra una métrica nueva Field.

Devolvedor

Field: Es una métrica nueva Field.

`setDefaultDimension(fieldId)`

Establece la dimensión predeterminada que se utilizará para el conjunto de campos. La dimensión predeterminada se selecciona automáticamente cuando se realiza una visualización nueva.

Parámetros

Nombre	Tipo	Descripción
`fieldId`	`String`	Indica el ID del campo que se utilizará como la dimensión predeterminada. Este ID debe estar presente en el conjunto de campos.

`setDefaultMetric(fieldId)`

Establece la métrica predeterminada que se usará para el conjunto de campos. La métrica predeterminada se selecciona automáticamente cuando se realiza una visualización nueva.

Parámetros

Nombre	Tipo	Descripción
`fieldId`	`String`	El ID del campo que se usará como métrica predeterminada. Este ID debe estar presente en el conjunto de campos.