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.

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

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

Metodi

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

Documentazione dettagliata

asArray()

Restituisce una visualizzazione dell'oggetto come array.

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

Ritorni

Field[]: un array di Field oggetti.


build()

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

Ritorni

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

Tiri

Error: se non è possibile creare un oggetto valido.


forIds(ids)

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

Parametri

NomeTipoDescrizione
idsString[]Gli ID dei campi da conservare.

Ritorni

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.

Ritorni

Field: la dimensione impostata come predefinita oppure 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.

Ritorni

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


getFieldById(fieldId)

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

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

Parametri

NomeTipoDescrizione
fieldIdStringL'ID del campo da ottenere.

Ritorni

Field: Field con l'ID specificato oppure null se questo campo non è contenuto all'interno dell'oggetto Fields.


newDimension()

Restituisce una nuova dimensione Field.

Ritorni

Field: una nuova dimensione, Field.


newMetric()

Restituisce una nuova metrica Field.

Ritorni

Field: una nuova metrica Field.


setDefaultDimension(fieldId)

Consente di impostare 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 nell'insieme di campi.

setDefaultMetric(fieldId)

Consente di impostare 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.