Contém um conjunto de Field
s 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étodo | Tipo de retorno | Breve 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) | Fields | Retorna um novo objeto Fields filtrado para Field s com um ID em ids . |
getDefaultDimension() | Field | Retorna a dimensão padrão a ser usada para o conjunto de campos. |
getDefaultMetric() | Field | Retorna a métrica padrão a ser usada para o conjunto de campos. |
getFieldById(fieldId) | Field | Retorna um campo com um determinado ID ou null se nenhum campo com esse ID estiver nesse objeto Fields . |
newDimension() | Field | Retorna uma nova dimensão Field . |
newMetric() | Field | Retorna uma nova métrica Field . |
setDefaultDimension(fieldId) | void | Define a dimensão padrão a ser usada para o conjunto de campos. |
setDefaultMetric(fieldId) | void | Define 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
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 Field
s 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
Nome | Tipo | Descrição |
---|---|---|
ids | String[] | Os IDs dos campos que devem ser mantidos. |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
fieldId | String | O 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
.
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
Nome | Tipo | Descrição |
---|---|---|
fieldId | String | O 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
Nome | Tipo | Descrição |
---|---|---|
fieldId | String | O ID do campo a ser usado como a métrica padrão. Esse ID precisa estar presente no conjunto de campos. |