Class Field

Alan

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

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

Yöntemler

YöntemDönüş türüKısa açıklama
getAggregation()AggregationTypeBu Field öğesinin AggregationType değerini döndürür.
getDescription()StringField öğesinin açıklamasını döndürür.
getFormula()StringBu Field formülünü döndürür.
getGroup()StringBu Field grubunu döndürür.
getId()StringBu Field öğesinin kimliğini döndürür.
getIsReaggregatable()BooleanBu alan yeniden toplanabilirse true değerini, aksi takdirde false değerini döndürür.
getName()StringBu Field öğesinin adını döndürür.
getType()FieldTypeBu Field öğesinin FieldType değerini döndürür.
isDefault()BooleanBu Field varsayılan metrik veya boyutsa true değerini döndürür.
isDimension()BooleanBu alan bir boyutsa true değerini döndürür.
isHidden()BooleanBu Field gizliyse true değerini döndürür.
isMetric()BooleanBu alan bir metrikse true değerini döndürür.
setAggregation(aggregation)FieldBu Field türünün toplama türünü ayarlar.
setDescription(description)FieldBu Field öğesinin açıklamasını ayarlar.
setFormula(formula)FieldBu Field formülünü ayarlar.
setGroup(group)FieldBu Field grubunu ayarlar.
setId(id)FieldBu Field öğesinin kimliğini ayarlar.
setIsHidden(isHidden)FieldBu Field öğesinin gizli durumunu ayarlar.
setIsReaggregatable(isReaggregatable)FieldField için yeniden toplamaya izin verildi durumunu ayarlar.
setName(name)FieldBu Field öğesinin adını ayarlar.
setType(type)FieldBu Field öğesinin FieldType değerini ayarlar.

Ayrıntılı belgeler

getAggregation()

Bu Field öğesinin AggregationType değerini döndürür. AggregationType belirler Data Studio'nun benzer verileri boyutlarda birleştirme şekli.

Return

AggregationType: Bu alan için AggregateType.


getDescription()

Field öğesinin açıklamasını döndürür. Açıklamalar bir alanın özüne ilişkin kısa açıklamalardır amaçlanıyor.

Return

String — Bu alana ait açıklama.


getFormula()

Bu Field formülünü döndürür. Formüller, Veri İşlenmesine İlişkin Değişiklik'in Studio, sorgu anında çalışır.

Return

String — Bu alanın formülü.


getGroup()

Bu Field grubunu döndürür. Grupta toplanan alanlar birlikte sunulur Studio kullanıcı arayüzünde gösterilir.

Return

String — Bu alana ait grup.


getId()

Bu Field öğesinin kimliğini döndürür. Kimlikler, her bir alan grubu için benzersizdir ve formüllerde kullanılır kullanabilirsiniz.

Return

String — Bu alanın kimliği.


getIsReaggregatable()

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

Return

Boolean — Bu alan yeniden toplanabilirse true, aksi takdirde false.


getName()

Bu Field öğesinin adını döndürür. Adlar, alanları ayırt etmesi için kullanıcıya 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; false aksi takdirde.


isDimension()

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

Return

Bu alan bir boyutsa Booleantrue; aksi takdirde false değerini döndürür.


isHidden()

Bu Field gizliyse true değerini döndürür. Formüllerde gizli alanları kullanabilir, ancak grafiklerde değil. Formül içeren alanları gizleyemezsiniz.

Return

Boolean — Bu Field gizliyse true; Aksi takdirde false.


isMetric()

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

Return

Bu alan bir metrikse Booleantrue; aksi takdirde false değerini döndürür.


setAggregation(aggregation)

Bu Field türünün toplama türünü ayarlar. AggregationType, verilerin nasıl Studio, benzer verileri boyutlarda birleştirir. Bu mesaj bir metrikte çağrılırsa hata verir.

Parametreler

AdTürAçıklama
aggregationAggregationTypeAyarlanacak toplama türü.

Return

Field — Zincirleme için bu oluşturucu.


setDescription(description)

Bu Field öğesinin açıklamasını ayarlar. Açıklamalar bir alanın özüne ilişkin kısa açıklamalardır amaçlanıyor.

Parametreler

AdTürAçıklama
descriptionStringAyarlanacak açıklama.

Return

Field — Zincirleme için bu oluşturucu.


setFormula(formula)

Bu Field formülünü ayarlar. Formüller, Data Studio'nun sorgu anında çalışır.

Parametreler

AdTürAçıklama
formulaStringAyarlanacak formül.

Return

Field — Zincirleme için bu oluşturucu.


setGroup(group)

Bu Field grubunu ayarlar. Grupta toplanan alanlar birlikte gösterilir Data Studio kullanıcı arayüzünde.

Parametreler

AdTürAçıklama
groupStringAyarlanacak grup.

Return

Field — Zincirleme için bu oluşturucu.


setId(id)

Bu Field öğesinin kimliğini ayarlar. Kimlikler, her bir alan grubu için benzersizdir ve formüllerde şu amaçlarla kullanılır: alanlara bakın.

Parametreler

AdTürAçıklama
idStringAyarlanacak kimlik.

Return

Field — Zincirleme için bu oluşturucu.


setIsHidden(isHidden)

Bu Field öğesinin gizli durumunu ayarlar. Gizli alanları formüllerde kullanabilirsiniz, ancak formüllerde kullanamazsınız oluşturabilirsiniz. Formül içeren alanları gizleyemezsiniz.

Parametreler

AdTürAçıklama
isHiddenBooleanAyarlanacak gizli durum.

Return

Field — Zincirleme için bu oluşturucu.


setIsReaggregatable(isReaggregatable)

Field için yeniden toplamaya izin verildi durumunu ayarlar. Toplama ayarlamaya çalışılıyor yeniden toplanamayan bir alana yazmanız durumunda hata oluşur.

Parametreler

AdTürAçıklama
isReaggregatableBooleanAyarlanacak yeniden toplamaya izin verildi durumu.

Return

Field — Zincirleme için bu oluşturucu.


setName(name)

Bu Field öğesinin adını ayarlar. Adlar, alanları ayırt etmesi için kullanıcıya gösterilir.

Parametreler

AdTürAçıklama
nameStringAyarlanacak ad.

Return

Field — Zincirleme için bu oluşturucu.


setType(type)

Bu Field öğesinin FieldType değerini ayarlar.

Parametreler

AdTürAçıklama
typeFieldTypeAyarlanacak tür.

Return

Field — Zincirleme için bu oluşturucu.