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.

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const 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 desse objeto como uma matriz.
build()	Object[]	Valida e retorna o objeto no formato necessário para o Data Studio.
forIds(ids)	Fields	Retorna um novo objeto Fields filtrado para Fields 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 neste 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 desse objeto como uma matriz.

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

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

Retornar

Field[]: uma matriz de objetos Field.

---

build()

Valida e retorna o objeto no formato necessário para o Data Studio.

Retornar

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

Gera

Error: se não for possível criar um objeto válido.

---

forIds(ids)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
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.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

Parâmetros

Nome	Tipo	Descrição
ids	String[]	Os IDs dos campos que precisam ser mantidos.

Retornar

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 é feita.

Retornar

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.

Retornar

Field: a métrica definida como padrão ou null se nenhuma métrica padrão foi definida.

---

getFieldById(fieldId)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

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

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

Parâmetros

Nome	Tipo	Descrição
fieldId	String	O ID do campo a ser recebido.

Retornar

Field: o Field com o ID fornecido ou null se nenhum campo desse tipo estiver contido neste objeto Fields.

---

newDimension()

Retorna uma nova dimensão Field.

Retornar

Field: uma nova dimensão Field.

---

newMetric()

Retorna uma nova métrica Field.

Retornar

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

Nome	Tipo	Descrição
fieldId	String	O ID do campo a ser usado como a 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.