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 kembali, jika tidak, false akan ditampilkan.
getName()StringMenampilkan nama Field ini.
getType()FieldTypeMenampilkan FieldType dari Field ini.
isDefault()BooleanMenampilkan true jika Field ini adalah 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 adalah 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 untuk Field ini.
setIsReaggregatable(isReaggregatable)FieldMenetapkan status yang diizinkan agregasi ulang untuk Field.
setName(name)FieldMenetapkan nama Field ini.
setType(type)FieldMenetapkan FieldType dari Field ini.

Dokumentasi mendetail

getAggregation()

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

Return

AggregationType — AgregasiType 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 oleh Data Studio pada waktu kueri.

Return

String — Formula untuk kolom ini.


getGroup()

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

Return

String — Grup untuk kolom ini.


getId()

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

Return

String — ID untuk kolom ini.


getIsReaggregatable()

Menampilkan true jika kolom ini dapat digabungkan kembali, jika tidak, false akan ditampilkan.

Return

Booleantrue jika kolom ini dapat digabungkan kembali, 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 adalah 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 kolom tersembunyi dalam formula, tetapi tidak dalam diagram. Anda tidak dapat menyembunyikan kolom yang berisi formula.

Return

Booleantrue jika Field ini disembunyikan; false jika tidak.


isMetric()

Menampilkan true jika kolom ini adalah metrik.

Return

Booleantrue jika kolom ini adalah 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 memunculkan error jika dipanggil pada metrik.

Parameter

NameJenisDeskripsi
aggregationAggregationTypeJenis agregasi yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.


setDescription(description)

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

Parameter

NameJenisDeskripsi
descriptionStringDeskripsi yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.


setFormula(formula)

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

Parameter

NameJenisDeskripsi
formulaStringFormula yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.


setGroup(group)

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

Parameter

NameJenisDeskripsi
groupStringGrup yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.


setId(id)

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

Parameter

NameJenisDeskripsi
idStringID yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.


setIsHidden(isHidden)

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

Parameter

NameJenisDeskripsi
isHiddenBooleanStatus tersembunyi yang akan disetel.

Return

Field — Builder ini, untuk rantai.


setIsReaggregatable(isReaggregatable)

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

Parameter

NameJenisDeskripsi
isReaggregatableBooleanStatus izin agregasi ulang yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.


setName(name)

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

Parameter

NameJenisDeskripsi
nameStringNama yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.


setType(type)

Menetapkan FieldType dari Field ini.

Parameter

NameJenisDeskripsi
typeFieldTypeJenis yang akan ditetapkan.

Return

Field — Builder ini, untuk rantai.