Class Field

Feld

Enthält feldbezogene Daten. Die Eigenschaften des Felds bestimmen, wie es in Data Studio verwendet wird.

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

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

Methoden

MethodeRückgabetypKurzbeschreibung
getAggregation()AggregationTypeGibt die AggregationType dieses Field zurück.
getDescription()StringGibt die Beschreibung dieses Field zurück.
getFormula()StringGibt die Formel dieses Field zurück.
getGroup()StringGibt die Gruppe dieses Field zurück.
getId()StringGibt die ID dieses 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 die FieldType dieses Field zurück.
isDefault()BooleanGibt true zurück, wenn dieser 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 Aggregationstyp dieses Field fest.
setDescription(description)FieldLegt die Beschreibung dieses Field fest.
setFormula(formula)FieldLegt die Formel für diese Field fest.
setGroup(group)FieldLegt die Gruppe für dieses Field fest.
setId(id)FieldLegt die ID für dieses Field fest.
setIsHidden(isHidden)FieldLegt den verborgenen Status von Field fest.
setIsReaggregatable(isReaggregatable)FieldLegt den Status „Reaggregation zulässig“ für eine Field fest.
setName(name)FieldLegt den Namen dieser Field fest.
setType(type)FieldLegt FieldType für Field fest.

Detaillierte Dokumentation

getAggregation()

Gibt die AggregationType dieses Field zurück. Mit AggregationType wird festgelegt, wie ähnliche Daten in Data Studio 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 des Zwecks eines Felds.

Rückflug

String: Die Beschreibung für dieses Feld.


getFormula()

Gibt die Formel dieses Field zurück. Mit Formeln wird eine Datentransformation definiert, die von Data Studio zur Abfragezeit ausgeführt wird.

Rückflug

String: Die Formel für dieses Feld.


getGroup()

Gibt die Gruppe dieses Field zurück. Felder, die in einer Gruppe zusammengefasst sind, werden in der Data Studio-Benutzeroberfläche zusammen dargestellt.

Rückflug

String: Die Gruppe für dieses Feld.


getId()

Gibt die ID dieses Field zurück. IDs sind für jede Gruppe von Feldern eindeutig und werden in Formeln verwendet, um 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. Namen werden dem Nutzer angezeigt, um Felder zu unterscheiden.

Rückflug

String: Der Name für dieses Feld.


getType()

Gibt die FieldType dieses Field zurück.

Rückflug

FieldType: Der Typ für dieses Feld.


isDefault()

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

Rückflug

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


isDimension()

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

Rückflug

Boolean: true, wenn dieses Feld eine Dimension ist, ansonsten false.


isHidden()

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

Rückflug

Boolean – true, wenn diese 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, ansonsten false.


setAggregation(aggregation)

Legt den Aggregationstyp dieses Field fest. Mit AggregationType wird festgelegt, wie ähnliche Daten in Data Studio in Dimensionen zusammengefasst werden. Gibt beim Aufruf für eine Messung einen Fehler zurück.

Parameter

NameTypBeschreibung
aggregationAggregationTypeDer festzulegende Aggregationstyp.

Rückflug

Field – Dieser Builder zur Verkettung.


setDescription(description)

Legt die Beschreibung dieses Field fest. Beschreibungen sind kurze Erläuterungen des Zwecks eines Felds.

Parameter

NameTypBeschreibung
descriptionStringDie festzulegende Beschreibung.

Rückflug

Field – Dieser Builder zur Verkettung.


setFormula(formula)

Legt die Formel für diese Field fest. Mit Formeln wird eine Datentransformation definiert, die von Data Studio zur Abfragezeit ausgeführt wird.

Parameter

NameTypBeschreibung
formulaStringDie festzulegende Formel.

Rückflug

Field – Dieser Builder zur Verkettung.


setGroup(group)

Legt die Gruppe für dieses Field fest. Felder, die in einer Gruppe zusammengefasst sind, werden in der Data Studio-Benutzeroberfläche zusammen dargestellt.

Parameter

NameTypBeschreibung
groupStringDie festzulegende Gruppe.

Rückflug

Field – Dieser Builder zur Verkettung.


setId(id)

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

Parameter

NameTypBeschreibung
idStringDie festzulegende ID.

Rückflug

Field – Dieser Builder zur Verkettung.


setIsHidden(isHidden)

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

Parameter

NameTypBeschreibung
isHiddenBooleanDer festzulegende Status „Ausgeblendet“.

Rückflug

Field – Dieser Builder zur Verkettung.


setIsReaggregatable(isReaggregatable)

Legt den Status „Reaggregation zulässig“ für eine Field fest. Wenn Sie versuchen, einen Zusammenfassungstyp für ein Feld festzulegen, das nicht neu aggregiert werden kann, führt das zu einem Fehler.

Parameter

NameTypBeschreibung
isReaggregatableBooleanDer festzulegende Status für die erneute Aggregation.

Rückflug

Field – Dieser Builder zur Verkettung.


setName(name)

Legt den Namen dieser Field fest. Namen werden dem Nutzer angezeigt, um Felder zu unterscheiden.

Parameter

NameTypBeschreibung
nameStringDer festzulegende Name.

Rückflug

Field – Dieser Builder zur Verkettung.


setType(type)

Legt FieldType für Field fest.

Parameter

NameTypBeschreibung
typeFieldTypeDer festzulegende Typ.

Rückflug

Field – Dieser Builder zur Verkettung.