Class Fields

Kolom

Berisi kumpulan Field untuk konektor komunitas. Kumpulan {i>field <i}ini menentukan dimensi dan metrik yang dapat digunakan di Data Studio.

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

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

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
asArray()	Field[]	Menampilkan tampilan objek ini sebagai array.
build()	Object[]	Memvalidasi objek ini dan menampilkannya dalam format yang dibutuhkan oleh Data Studio.
forIds(ids)	Fields	Menampilkan objek Fields baru yang difilter ke Field dengan ID di ids.
getDefaultDimension()	Field	Menampilkan dimensi default yang akan digunakan untuk kumpulan kolom.
getDefaultMetric()	Field	Menampilkan metrik default yang akan digunakan untuk kumpulan kolom.
getFieldById(fieldId)	Field	Menampilkan kolom dengan ID yang diberikan, atau null jika tidak ada kolom dengan ID tersebut dalam objek Fields ini.
newDimension()	Field	Menampilkan dimensi baru Field.
newMetric()	Field	Menampilkan metrik baru Field.
setDefaultDimension(fieldId)	void	Menetapkan dimensi default yang akan digunakan untuk kumpulan kolom.
setDefaultMetric(fieldId)	void	Menetapkan metrik default yang akan digunakan untuk kumpulan kolom.

Dokumentasi mendetail

asArray()

Menampilkan tampilan objek ini sebagai array.

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

Pulang pergi

Field[] — Array objek Field.

---

build()

Memvalidasi objek ini dan menampilkannya dalam format yang dibutuhkan oleh Data Studio.

Pulang pergi

Object[] — Data kolom yang divalidasi, direpresentasikan sebagai daftar objek.

Menampilkan

Error — jika objek yang valid tidak dapat dibuat.

---

forIds(ids)

Menampilkan objek Fields baru yang difilter ke Field dengan ID di 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']);

Parameter

Nama	Jenis	Deskripsi
ids	String[]	ID kolom yang harus disimpan.

Pulang pergi

Fields — Objek Fields baru.

---

getDefaultDimension()

Menampilkan dimensi default yang akan digunakan untuk kumpulan kolom. Dimensi default adalah dipilih secara otomatis ketika visualisasi baru dibuat.

Pulang pergi

Field — Dimensi yang ditetapkan sebagai dimensi default, atau null jika tidak ada default dimensi kustom sebelumnya.

---

getDefaultMetric()

Menampilkan metrik default yang akan digunakan untuk kumpulan kolom. Metrik default dipilih secara otomatis ketika visualisasi baru dibuat.

Pulang pergi

Field — Metrik yang ditetapkan sebagai metrik default, atau null jika tidak ada metrik default yang ditetapkan atur.

---

getFieldById(fieldId)

Menampilkan kolom dengan ID yang diberikan, atau null jika tidak ada kolom dengan ID tersebut dalam objek Fields ini.

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

Parameter

Nama	Jenis	Deskripsi
fieldId	String	ID kolom yang akan didapatkan.

Pulang pergi

Field — Field dengan ID yang diberikan, atau null jika tidak ada kolom tersebut dalam objek Fields ini.

---

newDimension()

Menampilkan dimensi baru Field.

Pulang pergi

Field — Dimensi baru Field.

---

newMetric()

Menampilkan metrik baru Field.

Pulang pergi

Field — Metrik baru Field.

---

setDefaultDimension(fieldId)

Menetapkan dimensi default yang akan digunakan untuk kumpulan kolom. Dimensi default dipilih secara otomatis ketika visualisasi baru dibuat.

Parameter

Nama	Jenis	Deskripsi
fieldId	String	ID kolom yang akan digunakan sebagai dimensi default. ID ini harus ada di serangkaian {i>field<i}.

---

setDefaultMetric(fieldId)

Menetapkan metrik default yang akan digunakan untuk kumpulan kolom. Metrik default dipilih secara otomatis ketika visualisasi baru dibuat.

Parameter

Nama	Jenis	Deskripsi
fieldId	String	ID kolom yang akan digunakan sebagai metrik default. ID ini harus ada di satu set bidang isian.