Bir topluluk bağlayıcısı için bir dizi Field
içerir. Bu alan grubu, Data Studio'da hangi boyut 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öntem | Dönüş türü | Kısa açıklama |
---|---|---|
as | Field[] | Bu nesnenin bir 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. |
for | Fields | ids içinde kimliği olan Field 'lere göre filtrelenen yeni bir Fields nesnesi döndürür. |
get | Field | Alan grubu için kullanılacak varsayılan boyutu döndürür. |
get | Field | Alan grubu için kullanılacak varsayılan metriği döndürür. |
get | Field | Belirli bir kimliğe sahip bir alanı döndürür veya bu Fields nesnesinde bu kimliğe sahip bir alan yoksa null değerini döndürür. |
new | Field | Yeni bir boyut Field döndürür. |
new | Field | Yeni bir metrik Field döndürür. |
set | void | Alan grubu için kullanılacak varsayılan boyutu ayarlar. |
set | void | Alan grubu için kullanılacak varsayılan metriği ayarlar. |
Ayrıntılı dokümanlar
as Array()
Bu nesnenin bir 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
build()
Bu nesneyi doğrular ve Data Studio'nun ihtiyaç duyduğu biçimde döndürür.
Return
Object[]
: Nesne listesi olarak temsil edilen doğrulanmış alan verileri.
Atışlar
Error
: Geçerli bir nesne oluşturulamazsa.
for Ids(ids)
ids
içinde kimliği olan Field
'lere göre filtrelenen 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
Ad | Tür | Açıklama |
---|---|---|
ids | String[] | Korunması gereken alanların kimlikleri. |
Return
get Default Dimension()
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 boyuttur veya varsayılan boyut ayarlanmadıysa null
değerini alır.
get Default Metric()
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
.
get Field By Id(fieldId)
Belirli bir kimliğe sahip bir alanı döndürür veya bu Fields
nesnesinde bu kimliğe sahip bir 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
Ad | Tür | Açıklama |
---|---|---|
field | String | Alınacak alanın kimliği. |
Return
Field
: Belirtilen kimliğe sahip Field
veya bu Fields
nesnesinde böyle bir alan yoksa null
.
set Default Dimension(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 |
---|---|---|
field | String | Varsayılan boyut olarak kullanılacak alanın kimliği. Bu kimlik, alan grubunda bulunmalıdır. |
set Default Metric(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 |
---|---|---|
field | String | Varsayılan metrik olarak kullanılacak alanın kimliği. Bu kimlik, alan grubunda bulunmalıdır. |