Class Field

Campo

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

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

var field1 = fields.newDimension()
  .setId('field1_id')
  .setName('Field 1 ID')
  .setDescription('The first field.')
  .setType(types.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; de lo contrario, muestra false.
getName()StringMuestra el nombre de este Field.
getType()FieldTypeMuestra el FieldType de este Field.
isDefault()BooleanMuestra true si 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 permitido de reagregación para una 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.

Devolvedor

AggregationType: Es el tipo de agregación de este campo.


getDescription()

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

Devolvedor

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.

Devolvedor

String: Es la fórmula para este campo.


getGroup()

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

Devolvedor

String: Es el grupo para este campo.


getId()

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

Devolvedor

String: Es el ID de este campo.


getIsReaggregatable()

Muestra true si este campo se puede volver a agregar; de lo contrario, muestra false.

Devolvedor

Boolean: Es true si se puede volver a agregar este campo, de lo contrario, false.


getName()

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

Devolvedor

String: Es el nombre de este campo.


getType()

Muestra el FieldType de este Field.

Devolvedor

FieldType: Es el tipo de este campo.


isDefault()

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

Devolvedor

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


isDimension()

Muestra true si este campo es una dimensión.

Devolvedor

Boolean: Es 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 las fórmulas, pero no en los gráficos. No puedes ocultar campos que contengan fórmulas.

Devolvedor

Boolean: Es true si este Field está oculto; de lo contrario, false.


isMetric()

Muestra true si este campo es una métrica.

Devolvedor

Boolean: Es 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. Esto arroja un error si se llama en una métrica.

Parámetros

NombreTipoDescripción
aggregationAggregationTypeEl tipo de agregación que se configurará.

Devolvedor

Field: Este compilador se usa 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
descriptionStringLa descripción que se establecerá.

Devolvedor

Field: Este compilador se usa 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
formulaStringLa fórmula que se va a establecer

Devolvedor

Field: Este compilador se usa 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
groupStringEl grupo que se establecerá.

Devolvedor

Field: Este compilador se usa para encadenar.


setId(id)

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

Parámetros

NombreTipoDescripción
idStringEl ID que se establecerá.

Devolvedor

Field: Este compilador se usa para encadenar.


setIsHidden(isHidden)

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

Parámetros

NombreTipoDescripción
isHiddenBooleanEl estado oculto que se establecerá.

Devolvedor

Field: Este compilador se usa para encadenar.


setIsReaggregatable(isReaggregatable)

Establece el estado permitido de reagregación para una Field. Si intentas establecer un tipo de agregación en un campo que no se puede volver a agregar, se producirá un error.

Parámetros

NombreTipoDescripción
isReaggregatableBooleanEl estado permitido de reagregación que se establecerá.

Devolvedor

Field: Este compilador se usa para encadenar.


setName(name)

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

Parámetros

NombreTipoDescripción
nameStringEl nombre que se establecerá.

Devolvedor

Field: Este compilador se usa para encadenar.


setType(type)

Establece el FieldType de este Field.

Parámetros

NombreTipoDescripción
typeFieldTypeEs el tipo que se establecerá.

Devolvedor

Field: Este compilador se usa para encadenar.