Class Field

Campo

Contém dados relacionados ao campo. As propriedades dele 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étodoTipo de retornoBreve descrição
getAggregation()AggregationTypeRetorna o AggregationType desse Field.
getDescription()StringRetorna a descrição desse Field.
getFormula()StringRetorna a fórmula desse Field.
getGroup()StringRetorna o grupo desse Field.
getId()StringRetorna o ID desse Field.
getIsReaggregatable()BooleanRetornará true se o campo puder ser reagregado. Caso contrário, retornará false.
getName()StringRetorna o nome deste Field.
getType()FieldTypeRetorna o FieldType desse Field.
isDefault()BooleanRetorna true se esse Field for a métrica ou dimensão padrão.
isDimension()BooleanRetorna true se esse campo for uma dimensão.
isHidden()BooleanRetorna true se esse Field estiver oculto.
isMetric()BooleanRetorna true se esse campo for uma métrica.
setAggregation(aggregation)FieldDefine o tipo de agregação dessa Field.
setDescription(description)FieldDefine a descrição desse Field.
setFormula(formula)FieldDefine a fórmula desse Field.
setGroup(group)FieldDefine o grupo desse Field.
setId(id)FieldDefine o ID desse Field.
setIsHidden(isHidden)FieldDefine o status oculto desse Field.
setIsReaggregatable(isReaggregatable)FieldDefine o status permitido de reagregação para um Field.
setName(name)FieldDefine o nome desse Field.
setType(type)FieldDefine 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.

Retorno

AggregationType: o agregaçãoType deste campo.


getDescription()

Retorna a descrição desse Field. As descrições são explicações curtas sobre o propósito de um campo.

Retorno

String: a descrição deste campo.


getFormula()

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

Retorno

String: a fórmula deste campo.


getGroup()

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

Retorno

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.

Retorno

String: o ID deste campo.


getIsReaggregatable()

Retornará true se o campo puder ser reagregado. Caso contrário, retornará false.

Retorno

Boolean: true se esse 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.

Retorno

String: o nome deste campo.


getType()

Retorna o FieldType desse Field.

Retorno

FieldType: o tipo deste campo.


isDefault()

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

Retorno

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


isDimension()

Retorna true se esse campo for uma dimensão.

Retorno

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


isHidden()

Retorna true se esse Field estiver oculto. Você pode usar campos ocultos em fórmulas, mas não em gráficos. Não é possível ocultar campos com fórmulas.

Retorno

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


isMetric()

Retorna true se esse campo for uma métrica.

Retorno

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


setAggregation(aggregation)

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

Parâmetros

NomeTipoDescrição
aggregationAggregationTypeO tipo de agregação a ser definido.

Retorno

Field: este builder, para encadeamento.


setDescription(description)

Define a descrição desse Field. As descrições são explicações curtas sobre o propósito de um campo.

Parâmetros

NomeTipoDescrição
descriptionStringDescrição a ser definida.

Retorno

Field: este builder, para encadeamento.


setFormula(formula)

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

Parâmetros

NomeTipoDescrição
formulaStringA fórmula a ser definida.

Retorno

Field: este builder, para encadeamento.


setGroup(group)

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

Parâmetros

NomeTipoDescrição
groupStringO grupo a ser definido.

Retorno

Field: este builder, para encadeamento.


setId(id)

Define o ID desse Field. Os IDs são exclusivos por conjunto de campos e são usados em fórmulas para se referir aos campos.

Parâmetros

NomeTipoDescrição
idStringO ID a ser definido.

Retorno

Field: este builder, para encadeamento.


setIsHidden(isHidden)

Define o status oculto desse Field. Você pode usar campos ocultos em fórmulas, mas não em gráficos. Não é possível ocultar campos com fórmulas.

Parâmetros

NomeTipoDescrição
isHiddenBooleanO status oculto a ser definido.

Retorno

Field: este builder, para encadeamento.


setIsReaggregatable(isReaggregatable)

Define o status permitido de reagregação para um Field. A tentativa de definir um tipo de agregação em um campo que não pode ser reagregado resulta em erro.

Parâmetros

NomeTipoDescrição
isReaggregatableBooleanO status permitido de reagregação a ser definido.

Retorno

Field: este builder, para encadeamento.


setName(name)

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

Parâmetros

NomeTipoDescrição
nameStringNome a ser definido.

Retorno

Field: este builder, para encadeamento.


setType(type)

Define o FieldType desse Field.

Parâmetros

NomeTipoDescrição
typeFieldTypeO tipo a ser definido.

Retorno

Field: este builder, para encadeamento.