Class Field

Feld

Enthält feldbezogene Daten. Anhand der Eigenschaften wird festgelegt, wie das Feld 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 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)FieldHiermit wird der Aggregationstyp dieser Field festgelegt.
setDescription(description)FieldHiermit wird die Beschreibung dieser Field festgelegt.
setFormula(formula)FieldLegt die Formel für diese Field fest.
setGroup(group)FieldLegt die Gruppe dieses 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 zulässige Zusammenführung für eine Field fest.
setName(name)FieldLegt den Namen dieser Field fest.
setType(type)FieldLegt die FieldType dieses Field fest.

Detaillierte Dokumentation

getAggregation()

Gibt die AggregationType dieses Field zurück. AggregationType bestimmt, wie ähnliche Daten in Data Studio zu 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 zum Zweck eines Felds.

Rückflug

String: Die Beschreibung für dieses Feld.


getFormula()

Gibt die Formel dieses Field zurück. Mithilfe von Formeln wird eine Datentransformation definiert, die in Data Studio zum Zeitpunkt der Abfrage 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 gemeinsam angezeigt.

Rückflug

String: Die Gruppe für dieses Feld.


getId()

Gibt die ID dieses Field zurück. IDs sind für jeden Satz 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 Nutzern angezeigt, um Felder zu unterscheiden.

Rückflug

String: Der Name dieses Felds.


getType()

Gibt die FieldType dieses Field zurück.

Rückflug

FieldType: Der Typ dieses Felds.


isDefault()

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

Rückflug

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


isDimension()

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

Rückflug

Boolean – true, wenn dieses Feld eine Dimension ist, andernfalls false.


isHidden()

Gibt true zurück, wenn diese Field ausgeblendet ist. Ausgeblendete Felder können in Formeln, aber nicht in Diagrammen verwendet werden. 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, andernfalls false.


setAggregation(aggregation)

Hiermit wird der Aggregationstyp dieser Field festgelegt. AggregationType legt fest, wie ähnliche Daten in Data Studio zu Dimensionen kombiniert werden. Wenn dieser Operator für einen Messwert aufgerufen wird, wird ein Fehler ausgegeben.

Parameter

NameTypBeschreibung
aggregationAggregationTypeDer zu festzulegende Aggregationstyp.

Rückflug

Field – Dieser Builder zur Verkettung.


setDescription(description)

Hiermit wird die Beschreibung dieser Field festgelegt. Beschreibungen sind kurze Erläuterungen zum Zweck eines Felds.

Parameter

NameTypBeschreibung
descriptionStringDie Beschreibung, die festgelegt werden soll.

Rückflug

Field – Dieser Builder zur Verkettung.


setFormula(formula)

Legt die Formel für diese Field fest. Mithilfe von Formeln wird eine Datentransformation definiert, die in Data Studio zum Zeitpunkt der Abfrage ausgeführt wird.

Parameter

NameTypBeschreibung
formulaStringDie Formel, die festgelegt werden soll.

Rückflug

Field – Dieser Builder zur Verkettung.


setGroup(group)

Legt die Gruppe dieses Field fest. In einer Gruppe zusammengefasste Felder werden in der Data Studio-Benutzeroberfläche zusammen angezeigt.

Parameter

NameTypBeschreibung
groupStringDie Gruppe, die festgelegt werden soll.

Rückflug

Field – Dieser Builder zur Verkettung.


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 ID, die festgelegt werden soll.

Rückflug

Field – Dieser Builder zur Verkettung.


setIsHidden(isHidden)

Legt den ausgeblendeten Status dieses Field fest. Ausgeblendete Felder können in Formeln, aber nicht in Diagrammen verwendet werden. Felder mit Formeln können nicht ausgeblendet werden.

Parameter

NameTypBeschreibung
isHiddenBooleanDer zu setzende ausgeblendete Status.

Rückflug

Field – Dieser Builder zur Verkettung.


setIsReaggregatable(isReaggregatable)

Legt den Status für die zulässige Zusammenführung für eine Field fest. Wenn Sie versuchen, einen Zusammenfassungstyp für ein Feld festzulegen, das nicht neu aggregiert werden kann, führt dies zu einem Fehler.

Parameter

NameTypBeschreibung
isReaggregatableBooleanDer Status, der für die Zusammenführung festgelegt werden soll.

Rückflug

Field – Dieser Builder zur Verkettung.


setName(name)

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

Parameter

NameTypBeschreibung
nameStringDer Name, der festgelegt werden soll.

Rückflug

Field – Dieser Builder zur Verkettung.


setType(type)

Legt die FieldType dieses Field fest.

Parameter

NameTypBeschreibung
typeFieldTypeDer zu festzulegende Typ.

Rückflug

Field – Dieser Builder zur Verkettung.