Class Field

Kolom

Berisi data terkait kolom. Propertinya menentukan cara kolom digunakan di Data Studio.

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getAggregation()AggregationTypeMenampilkan AggregationType dari Field ini.
getDescription()StringMenampilkan deskripsi Field ini.
getFormula()StringMenampilkan formula Field ini.
getGroup()StringMenampilkan grup Field ini.
getId()StringMenampilkan ID Field ini.
getIsReaggregatable()BooleanMenampilkan true jika kolom ini dapat digabungkan ulang, atau false jika tidak.
getName()StringMenampilkan nama Field ini.
getType()FieldTypeMenampilkan FieldType dari Field ini.
isDefault()BooleanMenampilkan true jika Field ini merupakan metrik atau dimensi default.
isDimension()BooleanMenampilkan true jika kolom ini adalah dimensi.
isHidden()BooleanMenampilkan true jika Field ini disembunyikan.
isMetric()BooleanMenampilkan true jika kolom ini berupa metrik.
setAggregation(aggregation)FieldMenetapkan jenis agregasi Field ini.
setDescription(description)FieldMenetapkan deskripsi Field ini.
setFormula(formula)FieldMenetapkan formula Field ini.
setGroup(group)FieldMenetapkan grup Field ini.
setId(id)FieldMenetapkan ID Field ini.
setIsHidden(isHidden)FieldMenetapkan status tersembunyi Field ini.
setIsReaggregatable(isReaggregatable)FieldMenetapkan status yang diizinkan agregasi ulang untuk Field.
setName(name)FieldMenetapkan nama Field ini.
setType(type)FieldMenetapkan FieldType untuk Field ini.

Dokumentasi mendetail

getAggregation()

Menampilkan AggregationType dari Field ini. AggregationType menentukan cara Data Studio menggabungkan data yang serupa ke dalam dimensi.

Return

AggregationType — AggregationType untuk kolom ini.


getDescription()

Menampilkan deskripsi Field ini. Deskripsi adalah penjelasan singkat tentang tujuan kolom.

Return

String — Deskripsi untuk kolom ini.


getFormula()

Menampilkan formula Field ini. Formula menentukan transformasi data yang dijalankan Data Studio pada waktu kueri.

Return

String — Formula untuk kolom ini.


getGroup()

Menampilkan grup Field ini. Kolom yang dikumpulkan ke dalam grup ditampilkan bersama di UI Data Studio.

Return

String — Grup untuk kolom ini.


getId()

Menampilkan ID Field ini. ID bersifat unik untuk setiap kumpulan kolom dan digunakan dalam formula untuk merujuk ke kolom.

Return

String — ID untuk kolom ini.


getIsReaggregatable()

Menampilkan true jika kolom ini dapat digabungkan ulang, atau false jika tidak.

Return

Booleantrue jika kolom ini dapat digabungkan ulang, false jika tidak.


getName()

Menampilkan nama Field ini. Nama ditampilkan kepada pengguna untuk membedakan kolom.

Return

String — Nama untuk kolom ini.


getType()

Menampilkan FieldType dari Field ini.

Return

FieldType — Jenis untuk kolom ini.


isDefault()

Menampilkan true jika Field ini merupakan metrik atau dimensi default.

Return

Booleantrue jika Field ini adalah metrik atau dimensi default; false jika tidak.


isDimension()

Menampilkan true jika kolom ini adalah dimensi.

Return

Booleantrue jika kolom ini adalah dimensi; menampilkan false jika tidak.


isHidden()

Menampilkan true jika Field ini disembunyikan. Anda dapat menggunakan {i>field<i} tersembunyi dalam formula, tetapi tidak dalam diagram. Anda tidak dapat menyembunyikan kolom yang berisi formula.

Return

Booleantrue jika Field ini disembunyikan; false jika sebaliknya.


isMetric()

Menampilkan true jika kolom ini berupa metrik.

Return

Booleantrue jika kolom ini berupa metrik; menampilkan false jika tidak.


setAggregation(aggregation)

Menetapkan jenis agregasi Field ini. AggregationType menentukan cara Data Studio menggabungkan data yang serupa ke dalam dimensi. Tindakan ini akan menampilkan error jika dipanggil pada metrik.

Parameter

NamaJenisDeskripsi
aggregationAggregationTypeJenis agregasi yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setDescription(description)

Menetapkan deskripsi Field ini. Deskripsi adalah penjelasan singkat tentang tujuan kolom.

Parameter

NamaJenisDeskripsi
descriptionStringDeskripsi yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setFormula(formula)

Menetapkan formula Field ini. Formula menentukan transformasi data yang dijalankan Data Studio pada waktu kueri.

Parameter

NamaJenisDeskripsi
formulaStringFormula yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setGroup(group)

Menetapkan grup Field ini. Kolom yang dikumpulkan ke dalam grup ditampilkan bersama di UI Data Studio.

Parameter

NamaJenisDeskripsi
groupStringGrup yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setId(id)

Menetapkan ID Field ini. ID bersifat unik untuk setiap kumpulan kolom dan digunakan dalam formula untuk merujuk ke kolom.

Parameter

NamaJenisDeskripsi
idStringID yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setIsHidden(isHidden)

Menetapkan status tersembunyi Field ini. Anda dapat menggunakan kolom tersembunyi dalam formula, tetapi tidak dalam diagram. Anda tidak dapat menyembunyikan kolom yang berisi formula.

Parameter

NamaJenisDeskripsi
isHiddenBooleanStatus tersembunyi yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setIsReaggregatable(isReaggregatable)

Menetapkan status yang diizinkan agregasi ulang untuk Field. Mencoba menetapkan jenis agregasi pada kolom yang tidak dapat diagregasi ulang akan menghasilkan error.

Parameter

NamaJenisDeskripsi
isReaggregatableBooleanStatus yang diizinkan agregasi ulang untuk ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setName(name)

Menetapkan nama Field ini. Nama ditampilkan kepada pengguna untuk membedakan kolom.

Parameter

NamaJenisDeskripsi
nameStringNama yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.


setType(type)

Menetapkan FieldType untuk Field ini.

Parameter

NamaJenisDeskripsi
typeFieldTypeJenis yang akan ditetapkan.

Return

Field — Builder ini untuk membuat rantai.