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 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	Devuelve un nuevo objeto Fields 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	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 dimensión nueva Field.
newMetric()	Field	Muestra una métrica nueva 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()

Muestra 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[]: Es un array de objetos Field.

---

build()

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

Volver

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

Arroja

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

---

forIds(ids)

Devuelve un nuevo objeto Fields 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: Es un nuevo objeto Fields.

---

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: Es la dimensión que se establece como la dimensión predeterminada o null si no se estableció ninguna 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 crea una visualización nueva.

Volver

Field: Es 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.

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	Es el ID del campo que se obtendrá.

Volver

Field: Es el Field con el ID determinado, o null si no hay ningún campo de este tipo dentro de este objeto Fields.

---

newDimension()

Muestra una dimensión nueva Field.

Volver

Field: Es una dimensión nueva Field.

---

newMetric()

Muestra una métrica nueva Field.

Volver

Field: Es una métrica nueva 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	Es 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	Es el ID del campo que se usará como métrica predeterminada. Este ID debe estar presente en el conjunto de campos.