Class Fields

Pola

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

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const 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[]	Sprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
forIds(ids)	Fields	Zwraca nowy obiekt Fields, który jest filtrowany pod kątem Field z identyfikatorem w ids.
getDefaultDimension()	Field	Zwraca domyślny wymiar, który ma być używany w przypadku zestawu pól.
getDefaultMetric()	Field	Zwraca domyślny wskaźnik, który ma być używany w przypadku zestawu pól.
getFieldById(fieldId)	Field	Zwraca pole o podanym identyfikatorze lub null, jeśli w tym obiekcie Fields nie ma pola o tym identyfikatorze.
newDimension()	Field	Zwraca nowy wymiar Field.
newMetric()	Field	Zwraca nowe dane Field.
setDefaultDimension(fieldId)	void	Ustawia domyślny wymiar, który ma być używany w przypadku zbioru pól.
setDefaultMetric(fieldId)	void	Ustawia domyślny rodzaj danych, który ma być używany w przypadku zbioru pól.

Szczegółowa dokumentacja

asArray()

Zwraca widok tego obiektu jako tablicę.

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

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

Powrót

Field[] – tablica obiektów Field.

---

build()

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

Powrót

Object[] – zweryfikowane dane pola w formie listy obiektów.

Rzuty

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

---

forIds(ids)

Zwraca nowy obiekt Fields, który jest filtrowany pod kątem Field z identyfikatorem w ids.

const fields = DataStudioApp.createCommunityConnector().getFields();
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.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

Parametry

Nazwa	Typ	Opis
ids	String[]	Identyfikatory pól, które mają zostać zachowane.

Powrót

Fields – nowy obiekt Fields.

---

getDefaultDimension()

Zwraca domyślny wymiar, który ma być używany w przypadku zestawu pól. Domyślny wymiar jest wybierany automatycznie podczas tworzenia nowej wizualizacji.

Powrót

Field – wymiar ustawiony jako domyślny lub null, jeśli nie ustawiono domyślnego wymiaru.

---

getDefaultMetric()

Zwraca domyślny wskaźnik, który ma być używany w przypadku zestawu pól. Domyślna wartość jest wybierana automatycznie podczas tworzenia nowej wizualizacji.

Powrót

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

---

getFieldById(fieldId)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

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

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

Parametry

Nazwa	Typ	Opis
fieldId	String	Identyfikator pola do pobrania.

Powrót

Field – Field z podanym identyfikatorem lub null, jeśli w tym obiekcie Fields nie ma takiego pola.

---

newDimension()

Zwraca nowy wymiar Field.

Powrót

Field – nowy wymiar Field.

---

newMetric()

Zwraca nowe dane Field.

Powrót

Field– nowe daneField.

---

setDefaultDimension(fieldId)

Ustawia domyślny wymiar, który ma być używany w przypadku zbioru pól. Wymiar domyślny jest wybierany automatycznie podczas tworzenia nowej wizualizacji.

Parametry

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

---

setDefaultMetric(fieldId)

Ustawia domyślny rodzaj danych, który ma być używany w przypadku zbioru pól. Domyślna wartość jest wybierana automatycznie podczas tworzenia nowej wizualizacji.

Parametry

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