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()StringBu Field öğesinin açıklamasını döndürür.
getFormula()StringBu Field formülünü döndürür.
getGroup()StringBu Field öğesinin grubunu döndürür.
getId()StringBu Field öğesinin kimliğini döndürür.
getIsReaggregatable()BooleanBu alan yeniden toplanabilirse true, 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 öğesinin toplama türünü ayarlar.
setDescription(description)FieldBu Field öğesinin açıklamasını ayarlar.
setFormula(formula)FieldBu Field öğesinin formülünü ayarlar.
setGroup(group)FieldBu Field öğesinin grubunu belirler.
setId(id)FieldBu Field öğesinin kimliğini belirler.
setIsHidden(isHidden)FieldBu Field öğesinin gizli durumunu ayarlar.
setIsReaggregatable(isReaggregatable)FieldField için yeniden toplama izni durumunu ayarlar.
setName(name)FieldBu Field öğesinin adını belirler.
setType(type)FieldBu Field öğesinin FieldType özelliğini ayarlar.

Ayrıntılı belgeler

getAggregation()

Bu Field öğesinin AggregationType değerini döndürür. AggregationType, Data Studio'nun benzer verileri nasıl boyutlarda birleştirdiğ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ıyla ilgili kısa açıklamalardır.

Return

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


getFormula()

Bu Field formülünü döndürür. Formüller, Data Studio'nun sorgu anı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 sunulur.

Return

String: Bu alanın grubu.


getId()

Bu Field öğesinin kimliğini döndürür. Kimlikler her alan grubu için benzersizdir ve alanlara başvuruda bulunmak için formüllerde kullanılır.

Return

String: Bu alanın kimliği.


getIsReaggregatable()

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

Return

Boolean — Bu alan yeniden birleştirilebiliyorsa true, aksi takdirde false.


getName()

Bu Field öğesinin adını döndürür. Alanları ayırt etmek için kullanıcıya 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

Bu Field varsayılan metrik veya boyutsa Booleantrue; aksi takdirde false.


isDimension()

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

Return

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


isHidden()

Bu Field gizliyse true değerini döndürür. Gizli alanları formüllerde kullanabilirsiniz, ancak grafiklerde kullanamazsınız. Formül içeren alanları gizleyemezsiniz.

Return

Boolean — Bu Field gizliyse true; gizliyse false.


isMetric()

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

Return

Boolean — Bu alan bir metrikse 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 politika, 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 amacıyla ilgili kısa açıklamalardır.

Parametreler

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

Return

Field — Zincirleme için bu oluşturucu.


setFormula(formula)

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

Parametreler

AdTürAçıklama
formulaStringAyarlanacak formül.

Return

Field — Zincirleme için bu oluşturucu.


setGroup(group)

Bu Field öğesinin grubunu belirler. Bir grupta toplanan alanlar, Data Studio kullanıcı arayüzünde birlikte sunulur.

Parametreler

AdTürAçıklama
groupStringAyarlanacak grup.

Return

Field — Zincirleme için bu oluşturucu.


setId(id)

Bu Field öğesinin kimliğini belirler. Kimlikler her alan grubu için benzersizdir ve alanlara atıfta bulunmak için formüllerde kullanılır.

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 grafiklerde kullanamazsınız. 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 toplama izni durumunu ayarlar. Yeniden toplanamayan bir alanda toplama türü ayarlamaya çalışmak hatayla sonuçlanır.

Parametreler

AdTürAçıklama
isReaggregatableBooleanAyarlanmasına izin verilen yeniden toplama durumu.

Return

Field — Zincirleme için bu oluşturucu.


setName(name)

Bu Field öğesinin adını belirler. Alanları ayırt etmek için kullanıcıya adlar gösterilir.

Parametreler

AdTürAçıklama
nameStringAyarlanacak ad.

Return

Field — Zincirleme için bu oluşturucu.


setType(type)

Bu Field öğesinin FieldType özelliğini ayarlar.

Parametreler

AdTürAçıklama
typeFieldTypeAyarlanacak tür.

Return

Field — Zincirleme için bu oluşturucu.