Class Fields

Pola

Zawiera zestaw komponentów Field na potrzeby społecznościowego oprogramowania sprzęgającego. Określają one, których 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 jako tablicę.
build()	Object[]	Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.
forIds(ids)	Fields	Zwraca nowy obiekt Fields przefiltrowany według kryteriów Field z identyfikatorem w ids.
getDefaultDimension()	Field	Zwraca wymiar domyślny do użycia w zbiorze pól.
getDefaultMetric()	Field	Zwraca domyślny wskaźnik, który ma być używany w zbiorze pól.
getFieldById(fieldId)	Field	Zwraca pole o podanym identyfikatorze lub null, jeśli w obiekcie Fields nie ma pola o takim identyfikatorze.
newDimension()	Field	Zwraca nowy wymiar Field.
newMetric()	Field	Zwraca nowy wskaźnik Field.
setDefaultDimension(fieldId)	void	Określa domyślny wymiar, który ma być używany dla zbioru pól.
setDefaultMetric(fieldId)	void	Określa domyślny wskaźnik do użycia w zbiorze pól.

Szczegółowa dokumentacja

asArray()

Zwraca widok tego obiektu jako tablicę.

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());
  });

Powroty

Field[] – tablica obiektów Field.

---

build()

Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.

Powroty

Object[] – dane ze zweryfikowanych pól w postaci listy obiektów.

Rzuty

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

---

forIds(ids)

Zwraca nowy obiekt Fields przefiltrowany według kryteriów Field z identyfikatorem 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 powinny zostać zachowane.

Powroty

Fields – nowy obiekt Fields.

---

getDefaultDimension()

Zwraca wymiar domyślny do użycia w zbiorze pól. Domyślny wymiar jest wybierany automatycznie po utworzeniu nowej wizualizacji.

Powroty

Field – wymiar ustawiony jako domyślny lub null, jeśli nie określono żadnego wymiaru domyślnego.

---

getDefaultMetric()

Zwraca domyślny wskaźnik, który ma być używany w zbiorze pól. Domyślne dane są wybierane automatycznie po utworzeniu nowej wizualizacji.

Powroty

Field – wskaźnik ustawiony jako domyślny lub null, jeśli nie ustawiono danych domyślnych.

---

getFieldById(fieldId)

Zwraca pole o podanym identyfikatorze lub null, jeśli w obiekcie Fields nie ma pola o takim 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 do pobrania.

Powroty

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

---

newDimension()

Zwraca nowy wymiar Field.

Powroty

Field – nowy wymiar Field.

---

newMetric()

Zwraca nowy wskaźnik Field.

Powroty

Field – nowy wskaźnik Field.

---

setDefaultDimension(fieldId)

Określa domyślny wymiar, który ma być używany dla zbioru pól. Domyślny wymiar jest wybierany automatycznie po utworzeniu 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 zbiorze pól.

---

setDefaultMetric(fieldId)

Określa domyślny wskaźnik do użycia w zbiorze pól. Domyślne dane są wybierane automatycznie po utworzeniu 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 zbiorze pól.