Class Fields

Campos

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

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

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

Métodos

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

Devuelve una vista de este objeto como un 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());
});

Volver

Field[] : Un array de objetos Field.

---

build()

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

Volver

Object[] : Los datos de campo validados, representados como una lista de objetos.

Arroja

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

---

forIds(ids)

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

Parámetros

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

Volver

Fields : Un objeto Fields nuevo.

---

getDefaultDimension()

Devuelve la dimensión predeterminada que se usará para el conjunto de campos. La dimensión predeterminada se selecciona automáticamente cuando se crea una visualización nueva.

Volver

Field : La dimensión que se establece como la dimensión predeterminada o null si no se estableció ninguna dimensión predeterminada.

---

getDefaultMetric()

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

Volver

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

---

getFieldById(fieldId)

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

Parámetros

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

Volver

Field : El Field con el ID determinado o null si no se incluye ningún campo de ese tipo en este objeto Fields.

---

newDimension()

Devuelve una nueva dimensión Field.

Volver

Field : Una nueva dimensión Field.

---

newMetric()

Devuelve una nueva métrica Field.

Volver

Field : Una nueva métrica Field.

---

setDefaultDimension(fieldId)

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

Parámetros

Nombre	Tipo	Descripción
fieldId	String	El ID del campo que se usará como 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 crea 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.