Class Field

Alan

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öntemDönüş türüKısa açıklama
getAggregation()AggregationTypeBu Field için AggregationType değerini döndürür.
getDescription()StringBu Field öğesinin açıklamasını döndürür.
getFormula()StringBu Field öğesinin formülünü döndürür.
getGroup()StringBu Field öğesinin grubunu döndürür.
getId()StringBu Field özelliğinin kimliğini döndürür.
getIsReaggregatable()BooleanBu alan yeniden toplanabiliyorsa true, aksi takdirde false değerini döndürür.
getName()StringBu Field öğesinin adını döndürür.
getType()FieldTypeBu Field için 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ü belirler.
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 özelliğinin kimliğini ayarlar.
setIsHidden(isHidden)FieldBu Field öğesinin gizli durumunu ayarlar.
setIsReaggregatable(isReaggregatable)FieldBir Field için yeniden toplamaya izin verilen durumu belirler.
setName(name)FieldBu Field öğesinin adını belirler.
setType(type)FieldBu Field öğesinin FieldType değerini ayarlar.

Ayrıntılı dokümanlar

getAggregation()

Bu Field için 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 değeri.


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ıracağı 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 özelliğinin kimliğini döndürür. Kimlikler, alan grubu başına benzersizdir ve alanlara referans vermek için formüllerde kullanılır.

Return

String: Bu alanın kimliği.


getIsReaggregatable()

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

Return

Boolean: Bu alan yeniden toplanabiliyorsa true, aksi takdirde false değerini alır.


getName()

Bu Field öğesinin adını döndürür. Adlar, alanları ayırt etmek için kullanıcıya gösterilir.

Return

String: Bu alanın adı.


getType()

Bu Field için 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 gizliyse true değerini döndürür. Gizli alanları formlarda kullanabilirsiniz ancak grafiklerde kullanamazsınız. Formül içeren alanları gizlemeniz mümkün değildir.

Return

Boolean: Bu Field gizliyse true, aksi takdirde false değerini alır.


isMetric()

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

Return

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


setAggregation(aggregation)

Bu Field öğesinin toplama türünü belirler. AggregationType, Data Studio'nun benzer verileri boyutlarda nasıl birleştireceğini belirler. Bu işlev, bir metrik üzerinde ç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ının kısa açıklamalarıdı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 sırasında yürüttüğü 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 özelliğinin kimliğini ayarlar. Kimlikler, alan grubu başına benzersizdir ve alanlara referans vermek için formlarda 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ı grafiklerde değil, formüllerde kullanabilirsiniz. Formül içeren alanları gizlemeniz mümkün değildir.

Parametreler

AdTürAçıklama
isHiddenBooleanAyarlanacak gizli durum.

Return

Field: Zincirleme için bu oluşturucu.


setIsReaggregatable(isReaggregatable)

Bir Field için yeniden toplamaya izin verilen durumu belirler. Yeniden toplanamayan bir alanda toplama türü ayarlamaya çalışmak hatayla sonuçlanır.

Parametreler

AdTürAçıklama
isReaggregatableBooleanAyarlanacak yeniden toplama izni verilen durum.

Return

Field: Zincirleme için bu oluşturucu.


setName(name)

Bu Field öğesinin adını belirler. Adlar, alanları ayırt etmek 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.