Class Fields

Pola

Zawiera zestaw elementów Field dla społecznościowego oprogramowania sprzęgającego. Ten zestaw pól określa, wymiarów i danych można używać w Studiu danych.

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

var field1 = fields.newDimension()
  // Set other properties as needed.
  .setId('field1_id');

Metody

Metoda	Zwracany typ	Krótki opis
asArray()	Field[]	Zwraca widok tego obiektu w postaci tablicy.
build()	Object[]	Sprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
forIds(ids)	Fields	Zwraca nowy obiekt Fields przefiltrowany zgodnie z danymi Field o identyfikatorze w ids.
getDefaultDimension()	Field	Zwraca domyślny wymiar, który ma być używany na potrzeby zbioru pól.
getDefaultMetric()	Field	Zwraca domyślne dane, które mają być używane w zbiorze pól.
getFieldById(fieldId)	Field	Zwraca pole o podanym identyfikatorze lub null, jeśli w obiekcie Fields nie ma pola o tym identyfikatorze.
newDimension()	Field	Zwraca nowy wymiar Field.
newMetric()	Field	Zwraca nowe dane: Field.
setDefaultDimension(fieldId)	void	Określa domyślny wymiar zbioru pól.
setDefaultMetric(fieldId)	void	Określa domyślne dane, które mają być używane w zestawie pól.

Szczegółowa dokumentacja

asArray()

Zwraca widok tego obiektu w postaci tablicy.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields
  .asArray()
  .map(function(field) {
     Logger.log(field.getId());
  });

Powrót

Field[] – tablica Field obiektów.

---

build()

Sprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.

Powrót

Object[] – zweryfikowane dane pól reprezentowane w postaci listy obiektów.

Rzuty

Error – jeśli nie można skonstruować prawidłowego obiektu.

---

forIds(ids)

Zwraca nowy obiekt Fields przefiltrowany zgodnie z danymi Field o identyfikatorze w ids.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

Parametry

Nazwa	Typ	Opis
ids	String[]	Identyfikatory pól, które należy zachować.

Powrót

Fields – nowy obiekt Fields.

---

getDefaultDimension()

Zwraca domyślny wymiar, który ma być używany na potrzeby zbioru pól. Domyślny wymiar to wybierana automatycznie podczas tworzenia nowej wizualizacji.

Powrót

Field – wymiar, który jest ustawiony jako domyślny lub null, jeśli nie ma wymiaru domyślnego. który został ustawiony.

---

getDefaultMetric()

Zwraca domyślne dane, które mają być używane w zbiorze pól. Wybrano domyślne dane. automatycznie przy tworzeniu nowej wizualizacji.

Powrót

Field – dane ustawione jako domyślne lub null, jeśli nie było danych domyślnych; ustawiony.

---

getFieldById(fieldId)

Zwraca pole o podanym identyfikatorze lub null, jeśli w obiekcie Fields nie ma pola o tym identyfikatorze.

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
var byId = fields.getFieldById('field1_id');

// byId2 is null.
var byId2 = fields.getFieldById('not present id');

Parametry

Nazwa	Typ	Opis
fieldId	String	Identyfikator pola, które ma zostać pobrane.

Powrót

Field – Field o podanym identyfikatorze lub null, jeśli nie zawiera takiego pola; w tym obiekcie Fields.

---

newDimension()

Zwraca nowy wymiar Field.

Powrót

Field – nowy wymiar Field.

---

newMetric()

Zwraca nowe dane: Field.

Powrót

Field – nowy rodzaj danych: Field.

---

setDefaultDimension(fieldId)

Określa domyślny wymiar zbioru pól. Wybrano wymiar domyślny automatycznie przy tworzeniu nowej wizualizacji.

Parametry

Nazwa	Typ	Opis
fieldId	String	Identyfikator pola, które ma być używane jako wymiar domyślny. Ten identyfikator musi znajdować się w zbiór pól.

---

setDefaultMetric(fieldId)

Określa domyślne dane, które mają być używane w zestawie pól. Wybrano domyślne dane. automatycznie przy tworzeniu nowej wizualizacji.

Parametry

Nazwa	Typ	Opis
fieldId	String	Identyfikator pola, które ma być używane jako dane domyślne. Ten identyfikator musi znajdować się w zestaw pól.