Class Field

Pole

Zawiera dane związane z polem. Jej właściwości określają sposób używania pola w Studiu 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

MetodaZwracany typKrótki opis
getAggregation()AggregationTypeZwraca AggregationType tego Field.
getDescription()StringZwraca opis tego elementu Field.
getFormula()StringZwraca formułę tego elementu Field.
getGroup()StringZwraca grupę tego elementu Field.
getId()StringZwraca identyfikator tego Field.
getIsReaggregatable()BooleanZwraca wartość true, jeśli to pole można ponownie zreagować, a w przeciwnym razie – wartość false.
getName()StringZwraca nazwę tego Field.
getType()FieldTypeZwraca FieldType tego Field.
isDefault()BooleanZwraca wartość true, jeśli ten element Field to domyślne dane lub wymiar.
isDimension()BooleanZwraca wartość true, jeśli to pole jest wymiarem.
isHidden()BooleanZwraca true, jeśli element Field jest ukryty.
isMetric()BooleanZwraca wartość true, jeśli to pole jest polem danych.
setAggregation(aggregation)FieldUstawia typ agregacji tego Field.
setDescription(description)FieldUstawia opis tego Field.
setFormula(formula)FieldUstawia formułę tego elementu Field.
setGroup(group)FieldUstawia grupę tego Field.
setId(id)FieldUstawia identyfikator tego Field.
setIsHidden(isHidden)FieldUstawia ukryty stan tego Field.
setIsReaggregatable(isReaggregatable)FieldUstawia stan dozwolonego ponownego zgrupowania dla Field.
setName(name)FieldUstawia nazwę tego Field.
setType(type)FieldUstawia FieldType tego Field.

Szczegółowa dokumentacja

getAggregation()

Zwraca AggregationType tego Field. AggregationType określa, jak Data Studio łączy podobne dane w wymiary.

Powrót

AggregationType – typ agregacji dla tego pola.


getDescription()

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

Powrót

String – opis tego pola.


getFormula()

Zwraca formułę tego elementu Field. Formuły definiują przekształcenie danych, które jest wykonywane przez Studio danych w momencie wykonywania zapytania.

Powrót

String – formuła tego pola.


getGroup()

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

Powrót

String – grupa tego pola.


getId()

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

Powrót

String – identyfikator tego pola.


getIsReaggregatable()

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

Powrót

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


getName()

Zwraca nazwę tego Field. Nazwy są widoczne dla użytkownika, aby odróżniać 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 to domyślne dane lub wymiar.

Powrót

Boolean – true, jeśli Field to domyślne dane lub wymiar; falsew przeciwnym razie.


isDimension()

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

Powrót

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


isHidden()

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

Powrót

Boolean – true, jeśli element Field jest ukryty, w przeciwnym razie false.


isMetric()

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

Powrót

Boolean – true, jeśli to pole zawiera dane, w przeciwnym razie zwraca false.


setAggregation(aggregation)

Ustawia typ agregacji tego Field. AggregationType określa, jak Data Studio łączy podobne dane w wymiary. Jeśli wywołasz go w przypadku wskaźnika, powoduje to błąd.

Parametry

NazwaTypOpis
aggregationAggregationTypeTyp agregacji do ustawienia.

Powrót

Field – ten kreator do łańcuchowania.


setDescription(description)

Ustawia opis tego Field. Opisy to krótkie objaśnienia przeznaczenia pola.

Parametry

NazwaTypOpis
descriptionStringOpis do ustawienia.

Powrót

Field – ten kreator do łańcuchowania.


setFormula(formula)

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

Parametry

NazwaTypOpis
formulaStringFormuła do ustawienia.

Powrót

Field – ten kreator do łańcuchowania.


setGroup(group)

Ustawia grupę tego Field. Pola zebrane w grupę są wyświetlane razem w interfejsie Studia danych.

Parametry

NazwaTypOpis
groupStringGrupa, którą chcesz skonfigurować.

Powrót

Field – ten kreator do łańcuchowania.


setId(id)

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

Parametry

NazwaTypOpis
idStringIdentyfikator do ustawienia.

Powrót

Field – ten kreator do łańcuchowania.


setIsHidden(isHidden)

Ustawia ukryty stan tego Field. Ukrytych pól możesz używać w formułach, ale nie w wykresach. Nie można ukryć pól zawierających formuły.

Parametry

NazwaTypOpis
isHiddenBooleanUstawiony stan ukryty.

Powrót

Field – ten kreator do łańcuchowania.


setIsReaggregatable(isReaggregatable)

Ustawia stan dozwolonego ponownego zgrupowania dla Field. Próba ustawienia rodzaju agregacji w polu, które nie może być ponownie zgrupowane, powoduje błąd.

Parametry

NazwaTypOpis
isReaggregatableBooleanStan „reaggregation-permitted” do ustawienia.

Powrót

Field – ten kreator do łańcuchowania.


setName(name)

Ustawia nazwę tego Field. Nazwy są widoczne dla użytkownika, aby odróżniać pola.

Parametry

NazwaTypOpis
nameStringNazwa do ustawienia.

Powrót

Field – ten kreator do łańcuchowania.


setType(type)

Ustawia FieldType tego Field.

Parametry

NazwaTypOpis
typeFieldTypeTyp do ustawienia.

Powrót

Field – ten kreator do łańcuchowania.