Class Field

Alanla ilgili verileri içerir. Özellikleri, alanın Data Studio'da nasıl kullanılacağını belirler.

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

const field1 = fields.newDimension()
                   .setId('field1_id')
                   .setName('Field 1 ID')
                   .setDescription('The first field.')
                   .setType(cc.FieldType.YEAR_MONTH)
                   .setGroup('DATETIME');

Yöntemler

Yöntem	Dönüş türü	Kısa açıklama
`getAggregation()`	`AggregationType`	Bu `Field` öğesinin `AggregationType` değerini döndürür.
`getDescription()`	`String`	Bu `Field` öğesinin açıklamasını döndürür.
`getFormula()`	`String`	Bu `Field` öğesinin formülünü döndürür.
`getGroup()`	`String`	Bu `Field` öğesinin grubunu döndürür.
`getId()`	`String`	Bu `Field` öğesinin kimliğini döndürür.
`getIsReaggregatable()`	`Boolean`	Bu alan yeniden toplu hale getirilebiliyorsa `true`, aksi takdirde `false` değerini döndürür.
`getName()`	`String`	Bu `Field` öğesinin adını döndürür.
`getType()`	`FieldType`	Bu `Field` öğesinin `FieldType` değerini döndürür.
`isDefault()`	`Boolean`	Bu `Field` varsayılan metrik veya boyutsa `true` değerini döndürür.
`isDimension()`	`Boolean`	Bu alan bir boyutsa `true` değerini döndürür.
`isHidden()`	`Boolean`	Bu `Field` gizlenmişse `true` değerini döndürür.
`isMetric()`	`Boolean`	Bu alan bir metriksa `true` değerini döndürür.
`setAggregation(aggregation)`	`Field`	Bu `Field` öğesinin toplama türünü ayarlar.
`setDescription(description)`	`Field`	Bu `Field` öğesinin açıklamasını ayarlar.
`setFormula(formula)`	`Field`	Bu `Field` öğesinin formülünü ayarlar.
`setGroup(group)`	`Field`	Bu `Field` öğesinin grubunu ayarlar.
`setId(id)`	`Field`	Bu `Field` öğesinin kimliğini ayarlar.
`setIsHidden(isHidden)`	`Field`	Bu `Field` öğesinin gizli durumunu ayarlar.
`setIsReaggregatable(isReaggregatable)`	`Field`	`Field` için yeniden toplama izni verilen durumu ayarlar.
`setName(name)`	`Field`	Bu `Field` öğesinin adını ayarlar.
`setType(type)`	`Field`	Bu `Field` öğesinin `FieldType` değerini ayarlar.

Ayrıntılı belgeler

`getAggregation()`

Bu Field öğesinin AggregationType değerini döndürür. AggregationType, Data Studio'nun benzer verileri boyutlarda nasıl birleştireceğini belirler.

Return

AggregationType: Bu alanın aggregationType'ı.

`getDescription()`

Bu Field öğesinin açıklamasını döndürür. Açıklamalar, bir alanın amacının kısa açıklamalarıdır.

Return

String: Bu alanın açıklaması.

`getFormula()`

Bu Field öğesinin formülünü döndürür. Formüller, Data Studio'nun sorgu sırasında çalıştırdığı bir veri dönüşümünü tanımlar.

Return

String: Bu alanın formülü.

`getGroup()`

Bu Field öğesinin grubunu döndürür. Bir grupta toplanan alanlar, Data Studio kullanıcı arayüzünde birlikte gösterilir.

Return

String: Bu alanın grubu.

`getId()`

Bu Field öğesinin kimliğini döndürür. Kimlikler, alan kümeleri için benzersizdir ve alanlara başvurmak üzere formüllerde kullanılır.

Return

String: Bu alanın kimliği.

`getIsReaggregatable()`

Bu alan yeniden toplu hale getirilebiliyorsa true, aksi takdirde false değerini döndürür.

Return

Boolean — Bu alan yeniden toplu hale getirilebiliyorsa true, aksi takdirde false.

`getName()`

Bu Field öğesinin adını döndürür. Alanları ayırt etmek için kullanıcılara adlar gösterilir.

Return

String: Bu alanın adı.

`getType()`

Bu Field öğesinin FieldType değerini döndürür.

Return

FieldType: Bu alanın türü.

`isDefault()`

Bu Field varsayılan metrik veya boyutsa true değerini döndürür.

Return

Boolean: Bu Field varsayılan metrik veya boyutsa true, aksi takdirde false.

`isDimension()`

Bu alan bir boyutsa true değerini döndürür.

Return

Boolean: Bu alan bir boyutsa true değerini, aksi takdirde false değerini döndürür.

`isHidden()`

Bu Field gizlenmişse true değerini döndürür. Formüllerde gizli alanları kullanabilirsiniz ancak grafiklerde kullanamazsınız. Formül içeren alanları gizleyemezsiniz.

Return

Boolean — Bu Field gizliyse true, aksi takdirde false.

`isMetric()`

Bu alan bir metriksa true değerini döndürür.

Return

Boolean: Bu alan bir metriktirse true, aksi takdirde false değerini döndürür.

`setAggregation(aggregation)`

Bu Field öğesinin toplama türünü ayarlar. AggregationType, Data Studio'nun benzer verileri boyutlarda nasıl birleştireceğini belirler. Bu işlev, bir metrikte çağrılırsa hata verir.