Topluluk bağlayıcısı için bir Field
grubu içerir. Bu alan grubu, Data Studio'da hangi boyut ve metriklerin kullanılabileceğini tanımlar.
var cc = DataStudioApp.createCommunityConnector(); var fields = cc.getFields(); var types = cc.FieldType; var field1 = fields.newDimension() // Set other properties as needed. .setId('field1_id');
Yöntemler
Yöntem | Dö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) | Fields | Field kategorisine ids içinde bir kimliğe sahip olan yeni Fields nesnesini döndürür. |
getDefaultDimension() | Field | Alan grubu için kullanılacak varsayılan boyutu döndürür. |
getDefaultMetric() | Field | Alan grubu için kullanılacak varsayılan metriği döndürür. |
getFieldById(fieldId) | Field | Belirli bir kimliğe sahip alan veya bu Fields nesnesinde bu kimliğe sahip alan yoksa null sonucunu döndürür. |
newDimension() | Field | Yeni bir boyut (Field ) döndürür. |
newMetric() | Field | Yeni bir metrik (Field ) döndürür. |
setDefaultDimension(fieldId) | void | Alan grubu için kullanılacak varsayılan boyutu ayarlar. |
setDefaultMetric(fieldId) | void | Alan 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.
var fields = //reference to fields object. fields.newDimension().setId('field1_id'); fields.newDimension().setId('field2_id'); fields.newDimension().setId('field3_id'); // Logging the ID of each field: fields .asArray() .map(function(field) { Logger.log(field.getId()); });
Return
build()
Bu nesneyi doğrular ve Data Studio'nun ihtiyaç duyduğu biçimde döndürür.
Return
Object[]
: Nesne listesi olarak gösterilen doğrulanmış alan verileri.
Dekoratif yastıklar
Error
: Geçerli bir nesne oluşturulamıyorsa.
forIds(ids)
Field
kategorisine ids
içinde bir kimliğe sahip olan yeni Fields
nesnesini döndürür.
var fields = //reference to fields object. 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. var subsetFields = fields.forIds(['field1_id', 'field3_id']);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
ids | String[] | Korunması gereken alanların kimlikleri. |
Return
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 belirlenmemişse 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. 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
sonucunu döndürür.
var fields = //reference to fields object. var field1 = fields.newDimension().setId('field1_id'); // byId is the same as field1. var byId = fields.getFieldById('field1_id'); // byId2 is null. var byId2 = fields.getFieldById('not present id');
Parametreler
Ad | Tür | Açıklama |
---|---|---|
fieldId | String | Alınacak alanın kimliği. |
Return
Field
: Belirtilen kimliğe sahip Field
veya bu Fields
nesnesinde böyle bir alan yoksa null
.
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
Ad | Tür | Açıklama |
---|---|---|
fieldId | String | Varsayılan boyut olarak kullanılacak alanın kimliği. Bu kimlik, alan grubunda mevcut olmalı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
Ad | Tür | Açıklama |
---|---|---|
fieldId | String | Varsayılan metrik olarak kullanılacak alanın kimliği. Bu kimlik, alan grubunda mevcut olmalıdır. |