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é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 | Retornará true se o campo puder ser reagregado. Caso contrário, retornará false . |
getName() | String | Retorna o nome deste Field . |
getType() | FieldType | Retorna o FieldType desse Field . |
isDefault() | Boolean | Retorna true se esse Field for 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 estiver oculto. |
isMetric() | Boolean | Retorna true se esse campo for uma métrica. |
setAggregation(aggregation) | Field | Define o tipo de agregação dessa Field . |
setDescription(description) | Field | Define a descrição desse Field . |
setFormula(formula) | Field | Define a fórmula desse Field . |
setGroup(group) | Field | Define o grupo desse Field . |
setId(id) | Field | Define o ID desse Field . |
setIsHidden(isHidden) | Field | Define o status oculto desse Field . |
setIsReaggregatable(isReaggregatable) | Field | Define o status permitido de 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.
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.
isDefault()
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()
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
Nome | Tipo | Descrição |
---|---|---|
aggregation | AggregationType | O tipo de agregação a ser definido. |
Retorno
Field
: este builder, para encadeamento.
setDescription(description)
setFormula(formula)
setGroup(group)
setId(id)
setIsHidden(isHidden)
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
Nome | Tipo | Descrição |
---|---|---|
isReaggregatable | Boolean | O status permitido de reagregação a ser definido. |
Retorno
Field
: este builder, para encadeamento.