Enthält eine Reihe von Field
s für einen Community-Connector. Mit diesen Feldern wird definiert, welche Dimensionen und Messwerte in Data Studio verwendet werden können.
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 das Objekt und gibt es in dem für 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 wird. |
getDefaultDimension() | Field | Gibt die Standarddimension zurück, die für den Satz 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 in diesem Fields -Objekt kein Feld mit dieser ID befindet. |
newDimension() | Field | Gibt die neue Dimension Field zurück. |
newMetric() | Field | Gibt den 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()); });
Return
build()
Validiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
Return
Object[]
: Die validierten Felddaten, die als Liste von Objekten dargestellt werden.
Löst aus
Error
: Wenn kein gültiges Objekt konstruiert werden kann.
forIds(ids)
Gibt ein neues Fields
-Objekt zurück, das nach Field
s mit einer ID in ids
gefiltert wird.
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[] | IDs der Felder, die beibehalten werden sollen. |
Return
getDefaultDimension()
Gibt die Standarddimension zurück, die für den Satz von Feldern verwendet werden soll. Die Standarddimension wird bei einer neuen Visualisierung automatisch ausgewählt.
Return
Field
: Die Dimension, die als Standarddimension festgelegt ist, oder null
, wenn keine Standarddimension festgelegt wurde.
getDefaultMetric()
Gibt den Standardmesswert zurück, der für die Gruppe von Feldern verwendet werden soll. Der Standardmesswert wird bei einer neuen Visualisierung automatisch ausgewählt.
Return
Field
: Der Messwert, der als Standardmesswert festgelegt ist, oder null
, wenn kein Standardmesswert festgelegt wurde.
getFieldById(fieldId)
Gibt ein Feld mit einer bestimmten ID oder null
zurück, wenn sich in diesem Fields
-Objekt kein Feld mit dieser ID 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 Feldes. |
Return
Field
: Der Field
mit der angegebenen ID oder null
, wenn kein solches Feld in diesem Fields
-Objekt enthalten ist.
setDefaultDimension(fieldId)
Legt die Standarddimension fest, die für die Gruppe von Feldern verwendet werden soll. Die Standarddimension wird bei einer neuen Visualisierung automatisch ausgewählt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
fieldId | String | Die ID des Felds, das als Standarddimension verwendet werden soll. Diese ID muss in der Gruppe von Feldern vorhanden sein. |
setDefaultMetric(fieldId)
Legt den Standardmesswert fest, der für die Gruppe von Feldern verwendet werden soll. Der Standardmesswert wird bei einer neuen Visualisierung automatisch ausgewählt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
fieldId | String | Die ID des Felds, das als Standardmesswert verwendet werden soll. Diese ID muss in den Feldern vorhanden sein. |