Class Fields

Fields

Contiene un insieme di Field per un connettore della community. Questo insieme di campi definisce quali dimensioni e metriche possono essere utilizzate in Data Studio.

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

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

Metodi

Metodo	Tipo restituito	Breve descrizione
asArray()	Field[]	Restituisce una visualizzazione di questo oggetto come array.
build()	Object[]	Convalida questo oggetto e lo restituisce nel formato richiesto da Data Studio.
forIds(ids)	Fields	Restituisce un nuovo oggetto Fields filtrato in base ai Field con un ID in ids.
getDefaultDimension()	Field	Restituisce la dimensione predefinita da utilizzare per l'insieme di campi.
getDefaultMetric()	Field	Restituisce la metrica predefinita da utilizzare per l'insieme di campi.
getFieldById(fieldId)	Field	Restituisce un campo con un determinato ID o null se nell'oggetto Fields non è presente alcun campo con quell'ID.
newDimension()	Field	Restituisce un nuovo Field di dimensione.
newMetric()	Field	Restituisce un nuovo Field di metrica.
setDefaultDimension(fieldId)	void	Imposta la dimensione predefinita da utilizzare per l'insieme di campi.
setDefaultMetric(fieldId)	void	Imposta la metrica predefinita da utilizzare per l'insieme di campi.

Documentazione dettagliata

asArray()

Restituisce una visualizzazione di questo oggetto come array.

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());
});

Indietro

Field[] : un array di oggetti Field.

---

build()

Convalida questo oggetto e lo restituisce nel formato richiesto da Data Studio.

Indietro

Object[] : i dati dei campi convalidati, rappresentati come un elenco di oggetti.

Genera

Error : se non è possibile costruire un oggetto valido.

---

forIds(ids)

Restituisce un nuovo oggetto Fields filtrato in base ai Field con un ID in 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']);

Parametri

Nome	Tipo	Descrizione
ids	String[]	Gli ID dei campi da conservare.

Indietro

Fields : un nuovo oggetto Fields.

---

getDefaultDimension()

Restituisce la dimensione predefinita da utilizzare per l'insieme di campi. La dimensione predefinita viene selezionata automaticamente quando viene creata una nuova visualizzazione.

Indietro

Field : la dimensione impostata come predefinita o null se non è stata impostata alcuna dimensione predefinita.

---

getDefaultMetric()

Restituisce la metrica predefinita da utilizzare per l'insieme di campi. La metrica predefinita viene selezionata automaticamente quando viene creata una nuova visualizzazione.

Indietro

Field : la metrica impostata come predefinita o null se non è stata impostata alcuna metrica predefinita.

---

getFieldById(fieldId)

Restituisce un campo con un determinato ID o null se nell'oggetto Fields non è presente alcun campo con quell'ID.

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');

Parametri

Nome	Tipo	Descrizione
fieldId	String	L'ID del campo da recuperare.

Indietro

Field : il Field con l'ID specificato o null se nell'oggetto Fields non è presente alcun campo di questo tipo.

---

newDimension()

Restituisce un nuovo Field di dimensione.

Indietro

Field : un nuovo Field di dimensione.

---

newMetric()

Restituisce un nuovo Field di metrica.

Indietro

Field : un nuovo Field di metrica.

---

setDefaultDimension(fieldId)

Imposta la dimensione predefinita da utilizzare per l'insieme di campi. La dimensione predefinita viene selezionata automaticamente quando viene creata una nuova visualizzazione.

Parametri

Nome	Tipo	Descrizione
fieldId	String	L'ID del campo da utilizzare come dimensione predefinita. Questo ID deve essere presente in l'insieme di campi.

---

setDefaultMetric(fieldId)

Imposta la metrica predefinita da utilizzare per l'insieme di campi. La metrica predefinita viene selezionata automaticamente quando viene creata una nuova visualizzazione.

Parametri

Nome	Tipo	Descrizione
fieldId	String	L'ID del campo da utilizzare come metrica predefinita. Questo ID deve essere presente nell' insieme di campi.