Class Fields

Fields

Enthält eine Reihe von Fields für einen Community-Connector. Mit dieser Gruppe von Feldern wird definiert, Dimensionen und Messwerte in Data Studio verwendet werden.

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

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

Methoden

MethodeRückgabetypKurzbeschreibung
asArray()Field[]Gibt eine Ansicht dieses Objekts als Array zurück.
build()Object[]Validiert dieses Objekt und gibt es in dem von Data Studio benötigten Format zurück.
forIds(ids)FieldsGibt ein neues Fields-Objekt zurück, das nach Fields mit einer ID in ids gefiltert ist.
getDefaultDimension()FieldGibt die Standarddimension zurück, die für die Gruppe von Feldern verwendet werden soll
getDefaultMetric()FieldGibt den Standardmesswert zurück, der für die Gruppe von Feldern verwendet werden soll
getFieldById(fieldId)FieldGibt ein Feld mit einer bestimmten ID oder null zurück, wenn sich kein Feld mit dieser ID in diesem Fields-Objekt befindet.
newDimension()FieldGibt die neue Dimension Field zurück.
newMetric()FieldGibt einen neuen Messwert Field zurück.
setDefaultDimension(fieldId)voidLegt die Standarddimension fest, die für die Gruppe von Feldern verwendet werden soll.
setDefaultMetric(fieldId)voidLegt den Standardmesswert fest, der für die Gruppe von Feldern verwendet werden soll.

Detaillierte Dokumentation

asArray()

Gibt eine Ansicht dieses Objekts als Array zurück.

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

Rückflug

Field[]: Ein Array von Field-Objekten.


build()

Validiert dieses Objekt und gibt es in dem von Data Studio benötigten Format zurück.

Rückflug

Object[]: Die validierten Felddaten, dargestellt als Liste von Objekten.

Löst aus

Error – wenn kein gültiges Objekt erstellt werden kann


forIds(ids)

Gibt ein neues Fields-Objekt zurück, das nach Fields mit einer ID in ids gefiltert ist.

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

Parameter

NameTypBeschreibung
idsString[]Die IDs der Felder, die beibehalten werden sollen.

Rückflug

Fields: Ein neues Fields-Objekt.


getDefaultDimension()

Gibt die Standarddimension zurück, die für die Gruppe von Feldern verwendet werden soll Die Standarddimension ist automatisch ausgewählt, wenn eine neue Visualisierung erstellt wird.

Rückflug

Field: Die Dimension, die als Standarddimension festgelegt ist, oder null, wenn keine Standarddimension festgelegt ist Dimension festgelegt.


getDefaultMetric()

Gibt den Standardmesswert zurück, der für die Gruppe von Feldern verwendet werden soll Der Standardmesswert ist ausgewählt bei einer neuen Visualisierung.

Rückflug

Field: Der Messwert, der als Standardmesswert festgelegt ist, oder null, wenn kein Standardmesswert war festgelegt.


getFieldById(fieldId)

Gibt ein Feld mit einer bestimmten ID oder null zurück, wenn sich kein Feld mit dieser ID in diesem Fields-Objekt befindet.

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

Parameter

NameTypBeschreibung
fieldIdStringDie ID des abzurufenden Felds.

Rückflug

Field – Die Field mit der angegebenen ID oder null, wenn kein solches Feld enthalten ist innerhalb dieses Fields-Objekts.


newDimension()

Gibt die neue Dimension Field zurück.

Rückflug

Field: Eine neue Dimension (Field).


newMetric()

Gibt einen neuen Messwert Field zurück.

Rückflug

Field: Ein neuer Messwert (Field).


setDefaultDimension(fieldId)

Legt die Standarddimension fest, die für die Gruppe von Feldern verwendet werden soll. Die Standarddimension ist ausgewählt bei einer neuen Visualisierung.

Parameter

NameTypBeschreibung
fieldIdStringDie ID des Felds, das als Standarddimension verwendet werden soll. Diese ID muss in die Gruppe von Feldern.

setDefaultMetric(fieldId)

Legt den Standardmesswert fest, der für die Gruppe von Feldern verwendet werden soll. Der Standardmesswert ist ausgewählt bei einer neuen Visualisierung.

Parameter

NameTypBeschreibung
fieldIdStringDie ID des Felds, das als Standardmesswert verwendet werden soll. Diese ID muss im Felder hinzu.