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.
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 a los objetos 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 utilizará 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()); });
Volver
build()
Valida este objeto y lo muestra 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)
Muestra un objeto Fields
nuevo filtrado a los objetos 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. |
Volver
getDefaultDimension()
Muestra la dimensión predeterminada que se utilizará para el conjunto de campos. La dimensión predeterminada es automáticamente cuando se crea una nueva visualización.
Volver
Field
: Es la dimensión que se establece como la dimensión predeterminada, o null
si no la hay.
se configuró esa dimensión.
getDefaultMetric()
Muestra la métrica predeterminada que se utilizará para el conjunto de campos. Se seleccionó la métrica predeterminada automáticamente cuando se crea una nueva visualización.
Volver
Field
: La métrica que se establece como la métrica predeterminada, o null
si no se estableció ninguna.
automático.
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á. |
Volver
Field
: Es el Field
con el ID proporcionado, o null
si no se contiene tal campo.
dentro de este objeto Fields
.
setDefaultDimension(fieldId)
Establece la dimensión predeterminada que se utilizará para el conjunto de campos. Se seleccionó la dimensión predeterminada automáticamente cuando se crea una nueva visualización.
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. Se seleccionó la métrica predeterminada automáticamente cuando se crea una nueva visualización.
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. |