Class Fields

Campos

Contém um conjunto de Fields para um conector da comunidade. Esse conjunto de campos define quais dimensões e métricas podem ser usadas no Data Studio.

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

var field1 = fields.newDimension()
  // Set other properties as needed.
  .setId('field1_id');

Métodos

MétodoTipo de retornoBreve descrição
asArray()Field[]Retorna uma visualização do objeto como uma matriz.
build()Object[]Valida esse objeto e o retorna no formato exigido pelo Data Studio.
forIds(ids)FieldsRetorna um novo objeto Fields filtrado para Fields com um ID em ids.
getDefaultDimension()FieldRetorna a dimensão padrão a ser usada para o conjunto de campos.
getDefaultMetric()FieldRetorna a métrica padrão a ser usada para o conjunto de campos.
getFieldById(fieldId)FieldRetorna um campo com um determinado ID ou null se nenhum campo com esse ID estiver nesse objeto Fields.
newDimension()FieldRetorna uma nova dimensão Field.
newMetric()FieldRetorna uma nova métrica Field.
setDefaultDimension(fieldId)voidDefine a dimensão padrão a ser usada para o conjunto de campos.
setDefaultMetric(fieldId)voidDefine a métrica padrão a ser usada para o conjunto de campos.

Documentação detalhada

asArray()

Retorna uma visualização do objeto como uma matriz.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields
  .asArray()
  .map(function(field) {
     Logger.log(field.getId());
  });

Retorno

Field[]: uma matriz de objetos Field.


build()

Valida esse objeto e o retorna no formato exigido pelo Data Studio.

Retorno

Object[]: os dados de campo validados, representados como uma lista de objetos.

Gera

Error: se um objeto válido não puder ser construído.


forIds(ids)

Retorna um novo objeto Fields filtrado para Fields com um ID em ids.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

Parâmetros

NomeTipoDescrição
idsString[]Os IDs dos campos que devem ser mantidos.

Retorno

Fields: um novo objeto Fields.


getDefaultDimension()

Retorna a dimensão padrão a ser usada para o conjunto de campos. A dimensão padrão é selecionada automaticamente quando uma nova visualização é criada.

Retorno

Field: a dimensão definida como padrão ou null se nenhuma dimensão padrão tiver sido definida.


getDefaultMetric()

Retorna a métrica padrão a ser usada para o conjunto de campos. A métrica padrão é selecionada automaticamente quando uma nova visualização é feita.

Retorno

Field: a métrica que é definida como a métrica padrão, ou null se nenhuma métrica padrão tiver sido definida.


getFieldById(fieldId)

Retorna um campo com um determinado ID ou null se nenhum campo com esse ID estiver nesse objeto Fields.

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
var byId = fields.getFieldById('field1_id');

// byId2 is null.
var byId2 = fields.getFieldById('not present id');

Parâmetros

NomeTipoDescrição
fieldIdStringO ID do campo a ser recebido.

Retorno

Field: o Field com o ID fornecido ou null se nenhum campo assim estiver contido no objeto Fields.


newDimension()

Retorna uma nova dimensão Field.

Retorno

Field: uma nova dimensão Field.


newMetric()

Retorna uma nova métrica Field.

Retorno

Field: uma nova métrica Field.


setDefaultDimension(fieldId)

Define a dimensão padrão a ser usada para o conjunto de campos. A dimensão padrão é selecionada automaticamente quando uma nova visualização é feita.

Parâmetros

NomeTipoDescrição
fieldIdStringO ID do campo a ser usado como dimensão padrão. Esse ID precisa estar presente no conjunto de campos.

setDefaultMetric(fieldId)

Define a métrica padrão a ser usada para o conjunto de campos. A métrica padrão é selecionada automaticamente quando uma nova visualização é feita.

Parâmetros

NomeTipoDescrição
fieldIdStringO ID do campo a ser usado como a métrica padrão. Esse ID precisa estar presente no conjunto de campos.