Class Fields

Fields

Enthält eine Reihe von Fields für einen Community-Connector. Mit diesen Feldern wird festgelegt, welche Dimensionen und Messwerte in Data Studio verwendet werden können.

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const 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[]	Dieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
forIds(ids)	Fields	Gibt ein neues Fields-Objekt zurück, das nach Fields 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 zurück oder null, wenn dieses Fields-Objekt kein Feld mit dieser ID enthält.
newDimension()	Field	Gibt eine neue Dimension Field zurück.
newMetric()	Field	Gibt den neuen Messwert Field zurück.
setDefaultDimension(fieldId)	void	Legt die Standarddimension für den Feldsatz fest.
setDefaultMetric(fieldId)	void	Legt den Standardmesswert für die Gruppe von Feldern fest.

Detaillierte Dokumentation

asArray()

Gibt eine Ansicht dieses Objekts als Array zurück.

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

Rückflug

Field[]: Ein Array von Field-Objekten.

---

build()

Dieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.

Rückflug

Object[]: Die Daten des validierten Felds, dargestellt als Liste von Objekten.

Löst

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.

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

Parameter

Name	Typ	Beschreibung
ids	String[]	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 wird 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 wurde.

---

getDefaultMetric()

Gibt den Standardmesswert zurück, der für die Gruppe von Feldern verwendet werden soll. Der Standardmesswert wird automatisch ausgewählt, wenn eine neue Visualisierung erstellt wird.

Rückflug

Field: Der als Standardmesswert festgelegte Messwert oder null, wenn kein Standardmesswert festgelegt wurde.

---

getFieldById(fieldId)

Gibt ein Feld mit einer bestimmten ID zurück oder null, wenn dieses Fields-Objekt kein Feld mit dieser ID enthält.

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

Parameter

Name	Typ	Beschreibung
fieldId	String	Die ID des Felds, das abgerufen werden soll.

Rückflug

Field: Der Field mit der angegebenen ID oder null, wenn dieses Fields-Objekt kein solches Feld enthält.

---

newDimension()

Gibt eine neue Dimension Field zurück.

Rückflug

Field – eine neue Dimension Field.

---

newMetric()

Gibt den neuen Messwert Field zurück.

Rückflug

Field – neuer Messwert Field

---

setDefaultDimension(fieldId)

Legt die Standarddimension für den Feldsatz fest. Die Standarddimension wird automatisch ausgewählt, wenn eine neue Visualisierung erstellt wird.

Parameter

Name	Typ	Beschreibung
fieldId	String	Die ID des Felds, das als Standarddimension verwendet werden soll. Diese ID muss in den Feldern vorhanden sein.

---

setDefaultMetric(fieldId)

Legt den Standardmesswert für die Gruppe von Feldern fest. Der Standardmesswert wird automatisch ausgewählt, wenn eine neue Visualisierung erstellt wird.

Parameter

Name	Typ	Beschreibung
fieldId	String	Die ID des Felds, das als Standardmesswert verwendet werden soll. Diese ID muss in den Feldern vorhanden sein.