Class Field

Pole

Zawiera dane związane z polami. Właściwości tego pola określają, jak jest ono używane w Studiu danych.

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

Metody

MetodaZwracany typKrótki opis
getAggregation()AggregationTypeZwraca AggregationType elementu Field.
getDescription()StringZwraca opis elementu Field.
getFormula()StringZwraca formułę tej funkcji Field.
getGroup()StringZwraca grupę Field.
getId()StringZwraca identyfikator elementu Field.
getIsReaggregatable()BooleanZwraca wartość true, jeśli można ponownie zagregować to pole. W przeciwnym razie zwraca wartość false.
getName()StringZwraca nazwę tego elementu (Field).
getType()FieldTypeZwraca FieldType elementu Field.
isDefault()BooleanZwraca wartość true, jeśli ta Field jest domyślnymi danymi lub wymiarami.
isDimension()BooleanZwraca wartość true, jeśli to pole jest wymiarem.
isHidden()BooleanZwraca wartość true, jeśli parametr Field jest ukryty.
isMetric()BooleanZwraca wartość true, jeśli to pole zawiera dane.
setAggregation(aggregation)FieldUstawia typ agregacji obiektu Field.
setDescription(description)FieldUstawia opis obiektu Field.
setFormula(formula)FieldUstawia formułę tej funkcji: Field.
setGroup(group)FieldUstawia grupę urządzeń Field.
setId(id)FieldUstawia identyfikator tego zasobu (Field).
setIsHidden(isHidden)FieldUstawia stan ukryty dla obiektu Field.
setIsReaggregatable(isReaggregatable)FieldWyznacza stan zezwolenia na ponowną agregację dla obiektu Field.
setName(name)FieldUstawia nazwę tego urządzenia Field.
setType(type)FieldUstawia FieldType tego komponentu (Field).

Szczegółowa dokumentacja

getAggregation()

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

Powroty

AggregationType – typ aggregationType dla danego pola.


getDescription()

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

Powroty

String — opis danego pola.


getFormula()

Zwraca formułę tej funkcji Field. Formuły definiują przekształcenie danych uruchamiane przez Studio danych podczas wykonywania zapytania.

Powroty

String – formuła dla danego pola.


getGroup()

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

Powroty

String – grupa dla danego pola.


getId()

Zwraca identyfikator elementu Field. Identyfikatory są unikalne na zbiór pól i są używane w formułach do odwoływania się do pól.

Powroty

String – identyfikator pola.


getIsReaggregatable()

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

Powroty

Booleantrue, jeśli można ponownie zagregować to pole, lub false, jeśli można je ponownie zagregować.


getName()

Zwraca nazwę tego elementu (Field). Nazwy są wyświetlane użytkownikowi, aby umożliwić rozróżnianie pól.

Powroty

String – nazwa pola.


getType()

Zwraca FieldType elementu Field.

Powroty

FieldType – typ danego pola.


isDefault()

Zwraca wartość true, jeśli ta Field jest domyślnymi danymi lub wymiarami.

Powroty

Booleantrue, jeśli ta wartość (Field) jest domyślnym danymi lub wymiarem. W przeciwnym razie false.


isDimension()

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

Powroty

Booleantrue, jeśli pole jest wymiarem; w przeciwnym razie zwraca false.


isHidden()

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

Powroty

Booleantrue, jeśli parametr Field jest ukryty. W przeciwnym razie: false.


isMetric()

Zwraca wartość true, jeśli to pole zawiera dane.

Powroty

Booleantrue, jeśli pole zawiera dane; w przeciwnym razie zwraca false.


setAggregation(aggregation)

Ustawia typ agregacji obiektu Field. AggregationType określa, w jaki sposób Studio danych łączy podobne dane w wymiary. Powoduje to wystąpienie błędu w przypadku wywołania wskaźnika.

Parametry

NazwaTypOpis
aggregationAggregationTypeTyp agregacji do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.


setDescription(description)

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

Parametry

NazwaTypOpis
descriptionStringOpis do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.


setFormula(formula)

Ustawia formułę tej funkcji: Field. Formuły definiują przekształcenie danych wykonywane przez Studio danych w czasie zapytania.

Parametry

NazwaTypOpis
formulaStringFormuła do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.


setGroup(group)

Ustawia grupę urządzeń Field. Pola zebrane w grupę są wyświetlane w interfejsie Studia danych.

Parametry

NazwaTypOpis
groupStringGrupa do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.


setId(id)

Ustawia identyfikator tego zasobu (Field). Identyfikatory są unikalne na zbiór pól i są używane w formułach do odwoływania się do pól.

Parametry

NazwaTypOpis
idStringIdentyfikator do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.


setIsHidden(isHidden)

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

Parametry

NazwaTypOpis
isHiddenBooleanStan ukryty do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.


setIsReaggregatable(isReaggregatable)

Wyznacza stan zezwolenia na ponowną agregację dla obiektu Field. Próba ustawienia typu agregacji w polu, którego nie można ponownie zagregować, kończy się błędem.

Parametry

NazwaTypOpis
isReaggregatableBooleanStan dozwolony na ponowną agregację.

Powroty

Field – kreator do tworzenia łańcuchów.


setName(name)

Ustawia nazwę tego urządzenia Field. Nazwy są wyświetlane użytkownikowi, aby umożliwić rozróżnianie pól.

Parametry

NazwaTypOpis
nameStringNazwa do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.


setType(type)

Ustawia FieldType tego komponentu (Field).

Parametry

NazwaTypOpis
typeFieldTypeTyp do ustawienia.

Powroty

Field – kreator do tworzenia łańcuchów.