Class Field

Feld

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

MethodeRückgabetypKurzbeschreibung
getAggregation()AggregationTypeGibt den AggregationType von Field zurück.
getDescription()StringGibt die Beschreibung von Field zurück.
getFormula()StringGibt die Formel von Field zurück.
getGroup()StringGibt die Gruppe von Field zurück.
getId()StringGibt die ID für diesen Field zurück.
getIsReaggregatable()BooleanGibt true zurück, wenn dieses Feld neu aggregiert werden kann, andernfalls false.
getName()StringGibt den Namen von Field zurück
getType()FieldTypeGibt den FieldType von 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 diese Field ausgeblendet ist.
isMetric()BooleanGibt true zurück, wenn dieses Feld ein Messwert ist.
setAggregation(aggregation)FieldLegt den Zusammenfassungstyp für diesen 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 dieses Field fest.
setIsHidden(isHidden)FieldLegt den ausgeblendeten Status dieses Field fest.
setIsReaggregatable(isReaggregatable)FieldLegt den Status für die erneute Aggregation für einen Field fest.
setName(name)FieldLegt den Namen der Field fest.
setType(type)FieldLegt 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.


getType()

Gibt den FieldType von Field zurück.

Return

FieldType: Der Typ für dieses Feld.


isDefault()

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

Return

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


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

Gibt true zurück, wenn diese Field ausgeblendet ist. Ausgeblendete Felder können in Formeln, aber nicht in Diagrammen verwendet werden. Felder, die Formeln enthalten, können nicht ausgeblendet werden.

Return

Boolean: true, wenn diese Field ausgeblendet ist; andernfalls false.


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

NameTypBeschreibung
aggregationAggregationTypeDer festzulegende Zusammenfassungstyp.

Return

Field: Dieser Builder für Verkettungen.


setDescription(description)

Legt die Beschreibung dieses Field fest. Beschreibungen sind kurze Erläuterungen zum Zweck eines Felds.

Parameter

NameTypBeschreibung
descriptionStringDie festzulegende Beschreibung.

Return

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.

Return

Field: Dieser Builder für Verkettungen.


setGroup(group)

Legt die Gruppe von Field fest. In einer Gruppe zusammengefasste Felder werden auf der Data Studio-Benutzeroberfläche gemeinsam angezeigt.

Parameter

NameTypBeschreibung
groupStringDie festzulegende Gruppe.

Return

Field: Dieser Builder für Verkettungen.


setId(id)

Legt die ID dieses Field fest. IDs sind für jeden Satz von Feldern eindeutig und werden in Formeln verwendet, um auf Felder zu verweisen.

Parameter

NameTypBeschreibung
idStringDie festzulegende ID.

Return

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 Diagrammen. Felder, die Formeln enthalten, können nicht ausgeblendet werden.

Parameter

NameTypBeschreibung
isHiddenBooleanDer 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

NameTypBeschreibung
isReaggregatableBooleanDer festzulegende Status für die erneute Aggregation.

Return

Field: Dieser Builder für Verkettungen.


setName(name)

Legt den Namen der Field fest. Die Namen werden dem Nutzer zur Unterscheidung der Felder angezeigt.

Parameter

NameTypBeschreibung
nameStringDer festzulegende Name.

Return

Field: Dieser Builder für Verkettungen.


setType(type)

Legt den FieldType von Field fest.

Parameter

NameTypBeschreibung
typeFieldTypeDer festzulegende Typ.

Return

Field: Dieser Builder für Verkettungen.