Class Field

Feld

Enthält feldbezogene Daten. Seine Eigenschaften 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

MethodeRückgabetypKurzbeschreibung
getAggregation()AggregationTypeGibt den AggregationType dieses Field zurück.
getDescription()StringGibt die Beschreibung dieses Field zurück.
getFormula()StringGibt die Formel für diesen Field zurück.
getGroup()StringGibt die Gruppe von Field zurück.
getId()StringGibt die ID von Field zurück.
getIsReaggregatable()BooleanGibt true zurück, wenn dieses Feld neu aggregiert werden kann, andernfalls false.
getName()StringGibt den Namen dieses Field zurück.
getType()FieldTypeGibt den FieldType dieses Field zurück.
isDefault()BooleanGibt true zurück, wenn Field der Standardmesswert oder die Standarddimension ist.
isDimension()BooleanGibt true zurück, wenn dieses Feld eine Dimension ist.
isHidden()BooleanGibt true zurück, wenn Field ausgeblendet ist.
isMetric()BooleanGibt true zurück, wenn dieses Feld ein Messwert ist.
setAggregation(aggregation)FieldLegt den Aggregationstyp dieser Field fest.
setDescription(description)FieldLegt die Beschreibung dieses Field fest.
setFormula(formula)FieldLegt die Formel für diesen Field fest.
setGroup(group)FieldLegt die Gruppe von Field fest.
setId(id)FieldLegt die ID von Field fest.
setIsHidden(isHidden)FieldLegt den ausgeblendeten Status dieses Field fest.
setIsReaggregatable(isReaggregatable)FieldLegt den Status der erneuten Aggregation für eine Field fest.
setName(name)FieldLegt den Namen dieses Field fest.
setType(type)FieldLegt den FieldType dieses Field fest.

Detaillierte Dokumentation

getAggregation()

Gibt den AggregationType dieses Field zurück. AggregationType bestimmt wie in Data Studio ähnliche Daten in Dimensionen kombiniert werden.

Rückflug

AggregationType: Der aggregationType für dieses Feld.


getDescription()

Gibt die Beschreibung dieses Field zurück. Beschreibungen sind kurze Erläuterungen der zu verstehen.

Rückflug

String: Die Beschreibung dieses Felds.


getFormula()

Gibt die Formel für diesen Field zurück. Formeln definieren eine Datentransformation, die Daten Studio wird zum Zeitpunkt der Abfrage ausgeführt.

Rückflug

String – Die Formel für dieses Feld.


getGroup()

Gibt die Gruppe von Field zurück. In einer Gruppe gesammelte Felder werden zusammen angezeigt auf der Data Studio-Benutzeroberfläche.

Rückflug

String: Die Gruppe für dieses Feld.


getId()

Gibt die ID von Field zurück. IDs sind pro Feldsatz eindeutig und werden in Formeln verwendet auf Felder zu verweisen.

Rückflug

String: Die ID für dieses Feld.


getIsReaggregatable()

Gibt true zurück, wenn dieses Feld neu aggregiert werden kann, andernfalls false.

Rückflug

Boolean: true, wenn dieses Feld neu aggregiert werden kann, andernfalls false.


getName()

Gibt den Namen dieses Field zurück. Die Namen werden dem Nutzer angezeigt, damit er die Felder unterscheiden kann.

Rückflug

String: Der Name des Felds.


getType()

Gibt den FieldType dieses Field zurück.

Rückflug

FieldType: Der Typ für dieses Feld.


isDefault()

Gibt true zurück, wenn Field der Standardmesswert oder die Standarddimension ist.

Rückflug

Boolean: true, wenn Field der Standardmesswert oder die Standarddimension ist. false sonst.


isDimension()

Gibt true zurück, wenn dieses Feld eine Dimension ist.

Rückflug

Boolean: true, wenn dieses Feld eine Dimension ist; Andernfalls wird false zurückgegeben.


isHidden()

Gibt true zurück, wenn Field ausgeblendet ist. Sie können ausgeblendete Felder in Formeln, aber nicht in Diagrammen. Felder mit Formeln können nicht ausgeblendet werden.

Rückflug

Boolean: true, wenn Field ausgeblendet ist; Andernfalls false.


isMetric()

Gibt true zurück, wenn dieses Feld ein Messwert ist.

Rückflug

Boolean: true, wenn dieses Feld ein Messwert ist; Andernfalls wird false zurückgegeben.


setAggregation(aggregation)

Legt den Aggregationstyp dieser Field fest. AggregationType bestimmt, wie Daten Studio kombiniert ähnliche Daten in Dimensionen. Beim Aufruf für einen Messwert wird ein Fehler ausgegeben.

Parameter

NameTypBeschreibung
aggregationAggregationTypeDer festzulegende Aggregationstyp.

Rückflug

Field: Dieser Builder für Verkettungen.


setDescription(description)

Legt die Beschreibung dieses Field fest. Beschreibungen sind kurze Erläuterungen der zu verstehen.

Parameter

NameTypBeschreibung
descriptionStringDie festzulegende Beschreibung.

Rückflug

Field: Dieser Builder für Verkettungen.


setFormula(formula)

Legt die Formel für diesen Field fest. Formeln definieren eine Datentransformation, die in Data Studio zum Zeitpunkt der Abfrage ausgeführt wird.

Parameter

NameTypBeschreibung
formulaStringDie festzulegende Formel.

Rückflug

Field: Dieser Builder für Verkettungen.


setGroup(group)

Legt die Gruppe von Field fest. In einer Gruppe gesammelte Felder werden zusammen in auf der Data Studio-Benutzeroberfläche.

Parameter

NameTypBeschreibung
groupStringDie festzulegende Gruppe.

Rückflug

Field: Dieser Builder für Verkettungen.


setId(id)

Legt die ID von Field fest. IDs sind pro Feldsatz eindeutig und werden in Formeln verwendet, um auf Felder.

Parameter

NameTypBeschreibung
idStringDie ID, die festgelegt werden soll.

Rückflug

Field: Dieser Builder für Verkettungen.


setIsHidden(isHidden)

Legt den ausgeblendeten Status dieses Field fest. Sie können ausgeblendete Felder in Formeln verwenden, aber nicht in . Felder mit Formeln können nicht ausgeblendet werden.

Parameter

NameTypBeschreibung
isHiddenBooleanDer festzulegende ausgeblendete Status.

Rückflug

Field: Dieser Builder für Verkettungen.


setIsReaggregatable(isReaggregatable)

Legt den Status der erneuten Aggregation für eine Field fest. Es wird versucht, eine Aggregation festzulegen Feld ein, das nicht neu aggregiert werden kann, führt zu einem Fehler.

Parameter

NameTypBeschreibung
isReaggregatableBooleanDer festzulegende Status für die erneute Aggregation.

Rückflug

Field: Dieser Builder für Verkettungen.


setName(name)

Legt den Namen dieses Field fest. Die Namen werden dem Nutzer angezeigt, damit er die Felder unterscheiden kann.

Parameter

NameTypBeschreibung
nameStringDer festzulegende Name.

Rückflug

Field: Dieser Builder für Verkettungen.


setType(type)

Legt den FieldType dieses Field fest.

Parameter

NameTypBeschreibung
typeFieldTypeDer Typ, der festgelegt werden soll.

Rückflug

Field: Dieser Builder für Verkettungen.