Class Field

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étodo	Tipo de datos que se devuelve	Descripción breve
`getAggregation()`	`AggregationType`	Devuelve el `AggregationType` de este `Field`.
`getDescription()`	`String`	Devuelve la descripción de este `Field`.
`getFormula()`	`String`	Devuelve la fórmula de este `Field`.
`getGroup()`	`String`	Devuelve el grupo de este `Field`.
`getId()`	`String`	Devuelve el ID de este `Field`.
`getIsReaggregatable()`	`Boolean`	Devuelve `true` si este campo se puede volver a agregar; de lo contrario, devuelve `false`.
`getName()`	`String`	Devuelve el nombre de este `Field`.
`getType()`	`FieldType`	Devuelve el `FieldType` de este `Field`.
`isDefault()`	`Boolean`	Devuelve `true` si este `Field` es la métrica o la dimensión predeterminada.
`isDimension()`	`Boolean`	Devuelve `true` si este campo es una dimensión.
`isHidden()`	`Boolean`	Devuelve `true` si este `Field` está oculto.
`isMetric()`	`Boolean`	Devuelve `true` si este campo es una métrica.
`setAggregation(aggregation)`	`Field`	Establece el tipo de agregación de este `Field`.
`setDescription(description)`	`Field`	Establece la descripción de este `Field`.
`setFormula(formula)`	`Field`	Establece la fórmula de este `Field`.
`setGroup(group)`	`Field`	Establece el grupo de este `Field`.
`setId(id)`	`Field`	Establece el ID de este objeto `Field`.
`setIsHidden(isHidden)`	`Field`	Establece el estado oculto de este `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Establece el estado de reagregación permitida para un `Field`.
`setName(name)`	`Field`	Establece el nombre de este `Field`.
`setType(type)`	`Field`	Establece el `FieldType` de este `Field`.

Documentación detallada

`getAggregation()`

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

Volver

AggregationType: Es el valor de aggregationType para este campo.

`getDescription()`

Devuelve 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()`

Devuelve 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()`

Devuelve 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()`

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

Volver

String: Es el ID de este campo.

`getIsReaggregatable()`

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

Volver

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

`getName()`

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

Volver

String: Es el nombre de este campo.

`getType()`

Devuelve el FieldType de este Field.

Volver

FieldType: Es el tipo de este campo.

`isDefault()`

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

Volver

Boolean: true si este Field es la métrica o dimensión predeterminada; false en otros casos

`isDimension()`

Devuelve true si este campo es una dimensión.

Volver

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

`isHidden()`

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

Volver

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

`isMetric()`

Devuelve true si este campo es una métrica.

Volver

Boolean: true si este campo es una métrica; de lo contrario, devuelve 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 en una métrica.