Class Field

Contém dados relacionados ao campo. As propriedades determinam como o campo é usado no 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 retorno	Breve descrição
`getAggregation()`	`AggregationType`	Retorna o `AggregationType` deste `Field`.
`getDescription()`	`String`	Retorna a descrição deste `Field`.
`getFormula()`	`String`	Retorna a fórmula deste `Field`.
`getGroup()`	`String`	Retorna o grupo deste `Field`.
`getId()`	`String`	Retorna o ID deste `Field`.
`getIsReaggregatable()`	`Boolean`	Retorna `true` se o campo puder ser reagregado. Caso contrário, retorna `false`.
`getName()`	`String`	Retorna o nome deste `Field`.
`getType()`	`FieldType`	Retorna o `FieldType` deste `Field`.
`isDefault()`	`Boolean`	Retorna `true` se este `Field` for a métrica ou dimensão padrão.
`isDimension()`	`Boolean`	Retorna `true` se este campo for uma dimensão.
`isHidden()`	`Boolean`	Retorna `true` se este `Field` estiver oculto.
`isMetric()`	`Boolean`	Retorna `true` se este campo for uma métrica.
`setAggregation(aggregation)`	`Field`	Define o tipo de agregação deste `Field`.
`setDescription(description)`	`Field`	Define a descrição deste `Field`.
`setFormula(formula)`	`Field`	Define a fórmula deste `Field`.
`setGroup(group)`	`Field`	Define o grupo deste `Field`.
`setId(id)`	`Field`	Define o ID deste `Field`.
`setIsHidden(isHidden)`	`Field`	Define o status oculto deste `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Define o status de reagregação permitida para um `Field`.
`setName(name)`	`Field`	Define o nome deste `Field`.
`setType(type)`	`Field`	Define o `FieldType` deste `Field`.

Documentação detalhada

`getAggregation()`

Retorna o AggregationType deste Field. O AggregationType determina como o Data Studio combina dados semelhantes em dimensões.

Retornar

AggregationType: o aggregationType deste campo.

`getDescription()`

Retorna a descrição deste Field. As descrições são explicações curtas da finalidade de um campo.

Retornar

String: a descrição deste campo.

`getFormula()`

Retorna a fórmula deste Field. As fórmulas definem uma transformação de dados que o Data Studio executa no momento da consulta.

Retornar

String: a fórmula para esse campo.

`getGroup()`

Retorna o grupo deste Field. Os campos coletados em um grupo são apresentados juntos na interface do Data Studio.

Retornar

String: o grupo deste campo.

`getId()`

Retorna o ID deste Field. Os IDs são exclusivos por conjunto de campos e usados em fórmulas para se referir a campos.

Retornar

String: o ID deste campo.

`getIsReaggregatable()`

Retorna true se o campo puder ser reagregado. Caso contrário, retorna false.

Retornar

Boolean: true se o campo puder ser reagregado, false caso contrário.

`getName()`

Retorna o nome deste Field. Os nomes são mostrados ao usuário para distinguir os campos.

Retornar

String: o nome desse campo.

`getType()`

Retorna o FieldType deste Field.

Retornar

FieldType: o tipo deste campo.

`isDefault()`

Retorna true se este Field for a métrica ou dimensão padrão.

Retornar

Boolean: true se este Field for a métrica ou dimensão padrão; false caso contrário.

`isDimension()`

Retorna true se este campo for uma dimensão.

Retornar

Boolean: true se o campo for uma dimensão. Caso contrário, retorna false.

`isHidden()`

Retorna true se este Field estiver oculto. É possível usar campos ocultos em fórmulas, mas não em gráficos. Não é possível ocultar campos que contêm fórmulas.

Retornar

Boolean: true se este Field estiver oculto; false caso contrário.

`isMetric()`

Retorna true se este campo for uma métrica.

Retornar

Boolean: true se este campo for uma métrica. Caso contrário, retorna false.

`setAggregation(aggregation)`

Define o tipo de agregação deste Field. O AggregationType determina como o Data Studio combina dados semelhantes em dimensões. Isso gera um erro se for chamado em uma métrica.