Class Field

Zawiera dane związane z polem. Jego właściwości określają, jak pole jest używane w Studio danych.

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');

Metody

Metoda	Zwracany typ	Krótki opis
`getAggregation()`	`AggregationType`	Zwraca `AggregationType` tego `Field`.
`getDescription()`	`String`	Zwraca opis tego elementu `Field`.
`getFormula()`	`String`	Zwraca formułę tego `Field`.
`getGroup()`	`String`	Zwraca grupę tego elementu `Field`.
`getId()`	`String`	Zwraca identyfikator tego `Field`.
`getIsReaggregatable()`	`Boolean`	Zwraca wartość `true`, jeśli to pole można ponownie zagregować, a w przeciwnym razie `false`.
`getName()`	`String`	Zwraca nazwę tego `Field`.
`getType()`	`FieldType`	Zwraca `FieldType` tego `Field`.
`isDefault()`	`Boolean`	Zwraca wartość `true`, jeśli ten element `Field` jest domyślnymi danymi lub wymiarem.
`isDimension()`	`Boolean`	Zwraca `true`, jeśli to pole jest wymiarem.
`isHidden()`	`Boolean`	Zwraca wartość `true`, jeśli ten element `Field` jest ukryty.
`isMetric()`	`Boolean`	Zwraca wartość `true`, jeśli to pole jest danymi.
`setAggregation(aggregation)`	`Field`	Ustawia typ agregacji tego `Field`.
`setDescription(description)`	`Field`	Ustawia opis tego elementu `Field`.
`setFormula(formula)`	`Field`	Ustawia formułę tego `Field`.
`setGroup(group)`	`Field`	Ustawia grupę tego elementu `Field`.
`setId(id)`	`Field`	Ustawia identyfikator tego `Field`.
`setIsHidden(isHidden)`	`Field`	Ustawia stan ukrycia tego `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Ustawia stan zezwolenia na ponowne agregowanie dla `Field`.
`setName(name)`	`Field`	Ustawia nazwę tego `Field`.
`setType(type)`	`Field`	Ustawia `FieldType` tego `Field`.

Szczegółowa dokumentacja

`getAggregation()`

Zwraca AggregationType tego Field. AggregationType określa, w jaki sposób Studio danych łączy podobne dane w wymiary.

Powrót

AggregationType – typ agregacji dla tego pola.

`getDescription()`

Zwraca opis tego elementu Field. Opisy to krótkie wyjaśnienia przeznaczenia pola.

Powrót

String – opis tego pola.

`getFormula()`

Zwraca formułę tego Field. Formuły definiują przekształcenie danych, które Studio danych wykonuje w momencie zapytania.

Powrót

String – formuła dla tego pola.

`getGroup()`

Zwraca grupę tego elementu Field. Pola zebrane w grupę są wyświetlane razem w interfejsie Studio danych.

Powrót

String – grupa tego pola.

`getId()`

Zwraca identyfikator tego Field. Identyfikatory są niepowtarzalne w przypadku każdego zestawu pól i są używane w formułach do odwoływania się do pól.

Powrót

String – identyfikator tego pola.

`getIsReaggregatable()`

Zwraca wartość true, jeśli to pole można ponownie zagregować, a w przeciwnym razie false.

Powrót

Boolean – true, jeśli to pole można ponownie zagregować, w przeciwnym razie false.

`getName()`

Zwraca nazwę tego Field. Nazwy są wyświetlane użytkownikowi, aby odróżnić pola.

Powrót

String – nazwa tego pola.

`getType()`

Zwraca FieldType tego Field.

Powrót

FieldType – typ tego pola.

`isDefault()`

Zwraca wartość true, jeśli ten element Field jest domyślnymi danymi lub wymiarem.

Powrót

Boolean – true, jeśli ten Field jest domyślnymi danymi lub wymiarem; false w przeciwnym razie.

`isDimension()`

Zwraca true, jeśli to pole jest wymiarem.

Powrót

Boolean – true, jeśli to pole jest wymiarem; w przeciwnym razie zwraca false.

`isHidden()`

Zwraca wartość true, jeśli ten element Field jest ukryty. Ukrytych pól możesz używać w formułach, ale nie na wykresach. Nie można ukrywać pól zawierających formuły.

Powrót

Boolean – true, jeśli ten element Field jest ukryty; w innym przypadku false.

`isMetric()`

Zwraca wartość true, jeśli to pole jest danymi.

Powrót

Boolean – true, jeśli to pole jest danymi; w przeciwnym razie zwraca false.

`setAggregation(aggregation)`

Ustawia typ agregacji tego Field. AggregationType określa, w jaki sposób Studio danych łączy podobne dane w wymiary. Jeśli ta funkcja zostanie wywołana w przypadku wskaźnika, spowoduje błąd.