Esta página foi traduzida pela API Cloud Translation.

Class Field

Contém dados relacionados ao campo. Suas propriedades determinam como o campo é usado no 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étodo	Tipo de retorno	Breve descrição
`getAggregation()`	`AggregationType`	Retorna o `AggregationType` desse `Field`.
`getDescription()`	`String`	Retorna a descrição desse `Field`.
`getFormula()`	`String`	Retorna a fórmula desse `Field`.
`getGroup()`	`String`	Retorna o grupo desse `Field`.
`getId()`	`String`	Retorna o ID desse `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` desse `Field`.
`isDefault()`	`Boolean`	Retorna `true` se esse `Field` é a métrica ou dimensão padrão.
`isDimension()`	`Boolean`	Retorna `true` se esse campo for uma dimensão.
`isHidden()`	`Boolean`	Retorna `true` se esse `Field` está oculto.
`isMetric()`	`Boolean`	Retorna `true` se esse campo é uma métrica.
`setAggregation(aggregation)`	`Field`	Define o tipo de agregação desse `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 desse `Field`.
`setId(id)`	`Field`	Define o ID desse `Field`.
`setIsHidden(isHidden)`	`Field`	Define o status oculto deste `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Define o status permitido para reagregação para um `Field`.
`setName(name)`	`Field`	Define o nome desse `Field`.
`setType(type)`	`Field`	Define o `FieldType` desse `Field`.

Documentação detalhada

`getAggregation()`

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

Retornar

AggregationType: o agregaçõesType deste campo.

`getDescription()`

Retorna a descrição desse Field. As descrições são breves explicações sobre a do propósito da tecnologia.

Retornar

String: a descrição deste campo.

`getFormula()`

Retorna a fórmula desse Field. As fórmulas definem uma transformação que os dados O Studio é executado no momento da consulta.

Retornar

String: a fórmula desse campo.

`getGroup()`

Retorna o grupo desse 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 desse Field. Os IDs são exclusivos por conjunto de campos e são 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. Caso contrário, false.

`getName()`

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

Retornar

String: o nome deste campo.

`getType()`

Retorna o FieldType desse Field.

Retornar

FieldType: o tipo deste campo.

`isDefault()`

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

Retornar

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

`isDimension()`

Retorna true se esse campo for uma dimensão.

Retornar

Boolean — true se o campo for uma dimensão retorna false caso contrário.

`isHidden()`

Retorna true se esse Field está oculto. É possível usar campos ocultos em fórmulas, mas não em gráficos. Não é possível ocultar campos que contenham fórmulas.

Retornar

Boolean: true se esse Field estiver oculto. Caso contrário, false.

`isMetric()`

Retorna true se esse campo é uma métrica.

Retornar

Boolean — true se o campo for uma métrica. retorna false caso contrário.

`setAggregation(aggregation)`

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