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 se puede volver a agregar este campo; de lo contrario, muestra false.
getName()StringMuestra el nombre de este Field.
getType()FieldTypeMuestra el FieldType de este Field.
isDefault()BooleanMuestra true si esta 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 elemento 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 por reagregación para un objeto 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 de la API de un campo que no tiene ningún propósito específico.

Volver

String: la descripción de este campo.


getFormula()

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

Volver

String: 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 los campos.

Volver

String: el ID de este campo.


getIsReaggregatable()

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

Volver

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 campos.

Volver

String: Es el nombre de este campo.


getType()

Muestra el FieldType de este Field.

Volver

FieldType: el tipo de este campo.


isDefault()

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

Volver

Boolean: true si esta 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: 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.

Volver

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


isMetric()

Muestra true si este campo es una métrica.

Volver

Boolean: 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 se usan Studio combina datos similares en dimensiones. Esto arroja un error si se lo llama en una métrica.

Parámetros

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

Volver

Field: Este compilador, para encadenamiento,


setDescription(description)

Establece la descripción de este Field. Las descripciones son explicaciones breves de la API de un campo que no tiene ningún propósito específico.

Parámetros

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

Volver

Field: Este compilador, para encadenamiento,


setFormula(formula)

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

Parámetros

NombreTipoDescripción
formulaStringLa fórmula a establecer.

Volver

Field: Este compilador, para encadenamiento,


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 configurará.

Volver

Field: Este compilador, para encadenamiento,


setId(id)

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

Parámetros

NombreTipoDescripción
idStringEl ID que se configurará.

Volver

Field: Este compilador, para encadenamiento,


setIsHidden(isHidden)

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

Parámetros

NombreTipoDescripción
isHiddenBooleanEl estado oculto que se debe establecer.

Volver

Field: Este compilador, para encadenamiento,


setIsReaggregatable(isReaggregatable)

Establece el estado permitido por reagregación para un objeto Field. Intentar establecer una agregación escribir en un campo que no se puede volver a agregar da como resultado un error.

Parámetros

NombreTipoDescripción
isReaggregatableBooleanEl estado permitido por reagregación que se debe establecer.

Volver

Field: Este compilador, para encadenamiento,


setName(name)

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

Parámetros

NombreTipoDescripción
nameStringEl nombre que se configurará.

Volver

Field: Este compilador, para encadenamiento,


setType(type)

Establece el FieldType de este Field.

Parámetros

NombreTipoDescripción
typeFieldTypeEl tipo que se configurará.

Volver

Field: Este compilador, para encadenamiento,