Enthält eine Reihe von Field
s 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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
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) | Fields | Gibt ein neues Fields -Objekt zurück, das nach Field s mit einer ID in ids gefiltert ist. |
getDefaultDimension() | Field | Gibt die Standarddimension zurück, die für die Gruppe von Feldern verwendet werden soll |
getDefaultMetric() | Field | Gibt den Standardmesswert zurück, der für die Gruppe von Feldern verwendet werden soll |
getFieldById(fieldId) | Field | Gibt ein Feld mit einer bestimmten ID oder null zurück, wenn sich kein Feld mit dieser ID in diesem Fields -Objekt befindet. |
newDimension() | Field | Gibt die neue Dimension Field zurück. |
newMetric() | Field | Gibt einen neuen Messwert Field zurück. |
setDefaultDimension(fieldId) | void | Legt die Standarddimension fest, die für die Gruppe von Feldern verwendet werden soll. |
setDefaultMetric(fieldId) | void | Legt 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
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 Field
s 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
Name | Typ | Beschreibung |
---|---|---|
ids | String[] | Die IDs der Felder, die beibehalten werden sollen. |
Rückflug
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
Name | Typ | Beschreibung |
---|---|---|
fieldId | String | Die 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.
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
Name | Typ | Beschreibung |
---|---|---|
fieldId | String | Die 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
Name | Typ | Beschreibung |
---|---|---|
fieldId | String | Die ID des Felds, das als Standardmesswert verwendet werden soll. Diese ID muss im Felder hinzu. |