Class Fields

Campi

Contiene un insieme di Field per un connettore della community. Questo insieme di campi definisce le dimensioni e le metriche che 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

MetodoTipo restituitoBreve descrizione
asArray()Field[]Restituisce una visualizzazione di questo oggetto come array.
build()Object[]Convalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
forIds(ids)FieldsRestituisce un nuovo oggetto Fields filtrato per Field con un ID in ids.
getDefaultDimension()FieldRestituisce la dimensione predefinita da utilizzare per l'insieme di campi.
getDefaultMetric()FieldRestituisce la metrica predefinita da utilizzare per l'insieme di campi.
getFieldById(fieldId)FieldRestituisce un campo con un determinato ID o null se non è presente alcun campo con questo ID in questo oggetto Fields.
newDimension()FieldRestituisce una nuova dimensione Field.
newMetric()FieldRestituisce una nuova metrica Field.
setDefaultDimension(fieldId)voidImposta la dimensione predefinita da utilizzare per l'insieme di campi.
setDefaultMetric(fieldId)voidImposta 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());
});

Invio

Field[]: un array di oggetti Field.

build()

Convalida questo oggetto e lo restituisce nel formato necessario per Data Studio.

Invio

Object[]: i dati di campo convalidati, rappresentati come elenco di oggetti.

Lanci

Error: se non è possibile creare un oggetto valido.

forIds(ids)

Restituisce un nuovo oggetto Fields filtrato per 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

NomeTipoDescrizione
idsString[]Gli ID dei campi da conservare.

Invio

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.

Invio

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.

Invio

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

getFieldById(fieldId)

Restituisce un campo con un determinato ID o null se non è presente alcun campo con questo ID in questo oggetto 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');

Parametri

NomeTipoDescrizione
fieldIdStringL'ID del campo da ottenere.

Invio

Field: l'elemento Field con l'ID specificato o null se non è presente un campo di questo tipo all'interno di questo oggetto Fields.

newDimension()

Restituisce una nuova dimensione Field.

Invio

Field: una nuova dimensione Field.

newMetric()

Restituisce una nuova metrica Field.

Invio

Field: una nuova metrica Field.

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

NomeTipoDescrizione
fieldIdStringL'ID del campo da utilizzare come dimensione predefinita. Questo ID deve essere presente nel set 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

NomeTipoDescrizione
fieldIdStringL'ID del campo da utilizzare come metrica predefinita. Questo ID deve essere presente nell'insieme di campi.