Class Fields

Alanlar

Topluluk bağlayıcısı için bir dizi Field içerir. Bu alan grubu, Data Studio'da hangi boyutların ve metriklerin kullanılabileceğini tanımlar.

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

const field1 = fields
                   .newDimension()
                   // Set other properties as needed.
                   .setId('field1_id');

Yöntemler

YöntemDönüş türüKısa açıklama
asArray()Field[]Bu nesnenin görünümünü dizi olarak döndürür.
build()Object[]Bu nesneyi doğrular ve Data Studio'nun ihtiyaç duyduğu biçimde döndürür.
forIds(ids)Fieldsids içinde kimliği olan Field'ler için filtrelenmiş yeni bir Fields nesnesi döndürür.
getDefaultDimension()FieldAlan grubu için kullanılacak varsayılan boyutu döndürür.
getDefaultMetric()FieldAlan grubu için kullanılacak varsayılan metriği döndürür.
getFieldById(fieldId)FieldBelirli bir kimliğe sahip alanı veya bu Fields nesnesinde bu kimliğe sahip alan yoksa null değerini döndürür.
newDimension()FieldYeni bir boyut Field döndürür.
newMetric()FieldYeni bir metrik Field döndürür.
setDefaultDimension(fieldId)voidAlan grubu için kullanılacak varsayılan boyutu ayarlar.
setDefaultMetric(fieldId)voidAlan grubu için kullanılacak varsayılan metriği ayarlar.

Ayrıntılı belgeler

asArray()

Bu nesnenin görünümünü dizi olarak döndürür.

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields.asArray().map((field) => {
  Logger.log(field.getId());
});

Return

Field[]: Field nesneleri dizisi.


build()

Bu nesneyi doğrular ve Data Studio'nun ihtiyaç duyduğu biçimde döndürür.

Return

Object[] — Doğrulanmış alan verileri, nesne listesi olarak gösterilir.

Verdiği hatalar

Error: Geçerli bir nesne oluşturulamıyorsa.


forIds(ids)

ids içinde kimliği olan Field'ler için filtrelenmiş yeni bir Fields nesnesi döndürür.

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

Parametreler

AdTürAçıklama
idsString[]Tutulması gereken alanların kimlikleri.

Return

Fields: Yeni bir Fields nesnesi.


getDefaultDimension()

Alan grubu için kullanılacak varsayılan boyutu döndürür. Yeni bir görselleştirme oluşturulduğunda varsayılan boyut otomatik olarak seçilir.

Return

Field: Varsayılan boyut olarak ayarlanan boyut veya varsayılan boyut ayarlanmamışsa null.


getDefaultMetric()

Alan grubu için kullanılacak varsayılan metriği döndürür. Yeni bir görselleştirme oluşturulduğunda varsayılan metrik otomatik olarak seçilir.

Return

Field: Varsayılan metrik olarak ayarlanan metrik veya varsayılan metrik ayarlanmamışsa null.


getFieldById(fieldId)

Belirli bir kimliğe sahip alanı veya bu Fields nesnesinde bu kimliğe sahip alan yoksa null değerini döndürür.

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
const byId = fields.getFieldById('field1_id');

// byId2 is null.
const byId2 = fields.getFieldById('not present id');

Parametreler

AdTürAçıklama
fieldIdStringAlınacak alanın kimliği.

Return

Field: Belirtilen kimliğe sahip Field veya bu Fields nesnesinde böyle bir alan yoksa null.


newDimension()

Yeni bir boyut Field döndürür.

Return

Field — Yeni bir boyut Field.


newMetric()

Yeni bir metrik Field döndürür.

Return

Field — Yeni bir metrik Field.


setDefaultDimension(fieldId)

Alan grubu için kullanılacak varsayılan boyutu ayarlar. Yeni bir görselleştirme oluşturulduğunda varsayılan boyut otomatik olarak seçilir.

Parametreler

AdTürAçıklama
fieldIdStringVarsayılan boyut olarak kullanılacak alanın kimliği. Bu kimlik, alanlar kümesinde bulunmalıdır.

setDefaultMetric(fieldId)

Alan grubu için kullanılacak varsayılan metriği ayarlar. Yeni bir görselleştirme oluşturulduğunda varsayılan metrik otomatik olarak seçilir.

Parametreler

AdTürAçıklama
fieldIdStringVarsayılan metrik olarak kullanılacak alanın kimliği. Bu kimlik, alan grubunda bulunmalıdır.