Class Field

Campo

Contiene datos relacionados con el campo. Sus propiedades determinan cómo se usa el campo en Data Studio.

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

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

Métodos

MétodoTipo de datos que se muestraDescripción breve
getAggregation()AggregationTypeMuestra el AggregationType de este Field.
getDescription()StringMuestra la descripción de este Field.
getFormula()StringMuestra la fórmula de este Field.
getGroup()StringMuestra el grupo de este Field.
getId()StringMuestra el ID de este Field.
getIsReaggregatable()BooleanMuestra true si este campo se puede volver a agregar, y false en caso contrario.
getName()StringMuestra el nombre de este Field.
getType()FieldTypeMuestra el FieldType de este Field.
isDefault()BooleanMuestra true si este Field es la métrica o dimensión predeterminada.
isDimension()BooleanMuestra true si este campo es una dimensión.
isHidden()BooleanMuestra true si este Field está oculto.
isMetric()BooleanMuestra true si este campo es una métrica.
setAggregation(aggregation)FieldEstablece el tipo de agregación de este Field.
setDescription(description)FieldEstablece la descripción de este Field.
setFormula(formula)FieldEstablece la fórmula de este Field.
setGroup(group)FieldEstablece el grupo de este Field.
setId(id)FieldEstablece el ID de este Field.
setIsHidden(isHidden)FieldEstablece el estado oculto de este Field.
setIsReaggregatable(isReaggregatable)FieldEstablece el estado de reagregación permitida para un Field.
setName(name)FieldEstablece el nombre de este Field.
setType(type)FieldEstablece el FieldType de este Field.

Documentación detallada

getAggregation()

Muestra el AggregationType de este Field. AggregationType determina cómo Data Studio combina datos similares en dimensiones.

Volver

AggregationType: Es el aggregationType de este campo.


getDescription()

Muestra la descripción de este Field. Las descripciones son explicaciones breves del propósito de un campo.

Volver

String: Es la descripción de este campo.


getFormula()

Muestra la fórmula de este Field. Las fórmulas definen una transformación de datos que Data Studio ejecuta en el momento de la consulta.

Volver

String: Es la fórmula de este campo.


getGroup()

Muestra el grupo de este Field. Los campos recopilados en un grupo se presentan juntos en la IU de Data Studio.

Volver

String: Es el grupo de este campo.


getId()

Muestra el ID de este Field. Los IDs son únicos por conjunto de campos y se usan en fórmulas para hacer referencia a campos.

Volver

String: Es el ID de este campo.


getIsReaggregatable()

Muestra true si este campo se puede volver a agregar, y false en caso contrario.

Volver

Boolean: true si este campo se puede volver a agregar, false en caso contrario.


getName()

Muestra el nombre de este Field. Los nombres se muestran al usuario para distinguir los campos.

Volver

String: Es el nombre de este campo.


getType()

Muestra el FieldType de este Field.

Volver

FieldType: Es el tipo de este campo.


isDefault()

Muestra true si este Field es la métrica o dimensión predeterminada.

Volver

Boolean: true si este Field es la métrica o dimensión predeterminada; false de lo contrario.


isDimension()

Muestra true si este campo es una dimensión.

Volver

Boolean: Muestra true si este campo es una dimensión; de lo contrario, muestra false.


isHidden()

Muestra true si este Field está oculto. Puedes usar campos ocultos en fórmulas, pero no en gráficos. No puedes ocultar campos que contengan fórmulas.

Volver

Boolean: Es true si este Field está oculto; false en caso contrario.


isMetric()

Muestra true si este campo es una métrica.

Volver

Boolean: Muestra true si este campo es una métrica; de lo contrario, muestra false.


setAggregation(aggregation)

Establece el tipo de agregación de este Field. AggregationType determina cómo Data Studio combina datos similares en dimensiones. Se mostrará un error si se llama a una métrica.

Parámetros

NombreTipoDescripción
aggregationAggregationTypeEs el tipo de agregación que se establecerá.

Volver

Field: Este compilador, para encadenar.


setDescription(description)

Establece la descripción de este Field. Las descripciones son explicaciones breves del propósito de un campo.

Parámetros

NombreTipoDescripción
descriptionStringEs la descripción que se establecerá.

Volver

Field: Este compilador, para encadenar.


setFormula(formula)

Establece la fórmula de este Field. Las fórmulas definen una transformación de datos que Data Studio ejecuta en el momento de la consulta.

Parámetros

NombreTipoDescripción
formulaStringEs la fórmula que se establecerá.

Volver

Field: Este compilador, para encadenar.


setGroup(group)

Establece el grupo de este Field. Los campos recopilados en un grupo se presentan juntos en la IU de Data Studio.

Parámetros

NombreTipoDescripción
groupStringEs el grupo que se establecerá.

Volver

Field: Este compilador, para encadenar.


setId(id)

Establece el ID de este Field. Los IDs son únicos por conjunto de campos y se usan en fórmulas para referirse a campos.

Parámetros

NombreTipoDescripción
idStringEs el ID que se establecerá.

Volver

Field: Este compilador, para encadenar.


setIsHidden(isHidden)

Establece el estado oculto de este Field. Puedes usar campos ocultos en fórmulas, pero no en gráficos. No puedes ocultar campos que contengan fórmulas.

Parámetros

NombreTipoDescripción
isHiddenBooleanEl estado oculto que se establecerá.

Volver

Field: Este compilador, para encadenar.


setIsReaggregatable(isReaggregatable)

Establece el estado de reagregación permitida para un Field. Si intentas establecer un tipo de agregación en un campo que no se puede reagregar, se generará un error.

Parámetros

NombreTipoDescripción
isReaggregatableBooleanEs el estado de reagregación permitido que se debe establecer.

Volver

Field: Este compilador, para encadenar.


setName(name)

Establece el nombre de este Field. Los nombres se muestran al usuario para distinguir los campos.

Parámetros

NombreTipoDescripción
nameStringEs el nombre que se debe establecer.

Volver

Field: Este compilador, para encadenar.


setType(type)

Establece el FieldType de este Field.

Parámetros

NombreTipoDescripción
typeFieldTypeEs el tipo que se establecerá.

Volver

Field: Este compilador, para encadenar.