Enthält feldbezogene Daten. Die Eigenschaften des Felds bestimmen, wie das Feld in Data Studio verwendet wird.
var cc = DataStudioApp.createCommunityConnector(); var fields = cc.getFields(); var types = cc.FieldType; var field1 = fields.newDimension() .setId('field1_id') .setName('Field 1 ID') .setDescription('The first field.') .setType(types.YEAR_MONTH) .setGroup('DATETIME');
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getAggregation() | AggregationType | Gibt den AggregationType von Field zurück. |
getDescription() | String | Gibt die Beschreibung von Field zurück. |
getFormula() | String | Gibt die Formel von Field zurück. |
getGroup() | String | Gibt die Gruppe von Field zurück. |
getId() | String | Gibt die ID für diesen Field zurück. |
getIsReaggregatable() | Boolean | Gibt true zurück, wenn dieses Feld neu aggregiert werden kann, andernfalls false . |
getName() | String | Gibt den Namen von Field zurück |
getType() | FieldType | Gibt den FieldType von Field zurück. |
isDefault() | Boolean | Gibt true zurück, wenn Field der Standardmesswert oder die Standarddimension ist. |
isDimension() | Boolean | Gibt true zurück, wenn dieses Feld eine Dimension ist. |
isHidden() | Boolean | Gibt true zurück, wenn diese Field ausgeblendet ist. |
isMetric() | Boolean | Gibt true zurück, wenn dieses Feld ein Messwert ist. |
setAggregation(aggregation) | Field | Legt den Zusammenfassungstyp für diesen Field fest. |
setDescription(description) | Field | Legt die Beschreibung dieses Field fest. |
setFormula(formula) | Field | Legt die Formel für diesen Field fest. |
setGroup(group) | Field | Legt die Gruppe von Field fest. |
setId(id) | Field | Legt die ID dieses Field fest. |
setIsHidden(isHidden) | Field | Legt den ausgeblendeten Status dieses Field fest. |
setIsReaggregatable(isReaggregatable) | Field | Legt den Status für die erneute Aggregation für einen Field fest. |
setName(name) | Field | Legt den Namen der Field fest. |
setType(type) | Field | Legt den FieldType von Field fest. |
Detaillierte Dokumentation
getAggregation()
Gibt den AggregationType
von Field
zurück. AggregationType
bestimmt, wie in Data Studio ähnliche Daten zu Dimensionen kombiniert werden.
Return
AggregationType
: Der aggregationType für dieses Feld.
getDescription()
Gibt die Beschreibung von Field
zurück. Beschreibungen sind kurze Erläuterungen zum Zweck eines Felds.
Return
String
: Die Beschreibung für dieses Feld.
getFormula()
Gibt die Formel von Field
zurück. Formeln definieren eine Datentransformation, die in Data Studio zum Zeitpunkt der Abfrage ausgeführt wird.
Return
String
: Die Formel für dieses Feld.
getGroup()
Gibt die Gruppe von Field
zurück. In einer Gruppe zusammengefasste Felder werden auf der Data Studio-Benutzeroberfläche gemeinsam angezeigt.
Return
String
: Die Gruppe für dieses Feld.
getId()
Gibt die ID für diesen Field
zurück. IDs sind für jeden Satz von Feldern eindeutig und werden in Formeln verwendet, um auf Felder zu verweisen.
Return
String
: Die ID für dieses Feld.
getIsReaggregatable()
Gibt true
zurück, wenn dieses Feld neu aggregiert werden kann, andernfalls false
.
Return
Boolean
: true
, wenn dieses Feld neu aggregiert werden kann, andernfalls false
.
getName()
Gibt den Namen von Field
zurück Die Namen werden dem Nutzer zur Unterscheidung der Felder angezeigt.
Return
String
: Der Name für dieses Feld.
isDefault()
isDimension()
Gibt true
zurück, wenn dieses Feld eine Dimension ist.
Return
Boolean
: true
, wenn dieses Feld eine Dimension ist. Andernfalls wird false
zurückgegeben.
isHidden()
isMetric()
Gibt true
zurück, wenn dieses Feld ein Messwert ist.
Return
Boolean
: true
, wenn dieses Feld ein Messwert ist. Andernfalls wird false
zurückgegeben.
setAggregation(aggregation)
Legt den Zusammenfassungstyp für diesen Field
fest. AggregationType
bestimmt, wie in Data Studio ähnliche Daten zu Dimensionen kombiniert werden. Beim Aufruf für einen Messwert wird ein Fehler ausgegeben.
Parameter
Name | Typ | Beschreibung |
---|---|---|
aggregation | AggregationType | Der festzulegende Zusammenfassungstyp. |
Return
Field
: Dieser Builder für Verkettungen.
setDescription(description)
setFormula(formula)
setGroup(group)
setId(id)
setIsHidden(isHidden)
Legt den ausgeblendeten Status dieses Field
fest. Sie können ausgeblendete Felder in Formeln verwenden, aber nicht in Diagrammen. Felder, die Formeln enthalten, können nicht ausgeblendet werden.
Parameter
Name | Typ | Beschreibung |
---|---|---|
isHidden | Boolean | Der festzulegende ausgeblendete Status. |
Return
Field
: Dieser Builder für Verkettungen.
setIsReaggregatable(isReaggregatable)
Legt den Status für die erneute Aggregation für einen Field
fest. Wenn Sie versuchen, einen Zusammenfassungstyp für ein Feld festzulegen, das nicht neu aggregiert werden kann, wird ein Fehler ausgegeben.
Parameter
Name | Typ | Beschreibung |
---|---|---|
isReaggregatable | Boolean | Der festzulegende Status für die erneute Aggregation. |
Return
Field
: Dieser Builder für Verkettungen.