Class Fields
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Alanlar
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');
Ayrıntılı dokümanlar
asArray()
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
Field[]
: Field
nesneleri dizisi.
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.
forIds(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
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 boyuttur veya varsayılan boyut ayarlanmadıysa null
değerini alır.
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 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 |
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 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
Ad | Tür | Açıklama |
fieldId | String | Varsayılan metrik olarak kullanılacak alanın kimliği. Bu kimlik, alan grubunda bulunmalıdır. |
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-26 UTC.
[null,null,["Son güncelleme tarihi: 2025-07-26 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eFields\u003c/code\u003e object in Apps Script allows you to define the dimensions and metrics available to your Data Studio Community Connector.\u003c/p\u003e\n"],["\u003cp\u003eYou can manipulate and manage these fields using methods provided by the \u003ccode\u003eFields\u003c/code\u003e object, such as creating new fields, setting defaults, and retrieving fields by ID.\u003c/p\u003e\n"],["\u003cp\u003eUsing \u003ccode\u003ebuild()\u003c/code\u003e, you can obtain the validated field data as a list of objects suitable for use in Data Studio.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003egetDefaultDimension()\u003c/code\u003e and \u003ccode\u003esetDefaultDimension()\u003c/code\u003e allow you to control which dimension and metric are automatically selected when creating visualizations in Data Studio.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eforIds()\u003c/code\u003e enables you to filter and work with a subset of fields based on their IDs.\u003c/p\u003e\n"]]],["The core content defines `Fields` for Data Studio community connectors, specifying usable dimensions and metrics. Key actions include creating new dimensions/metrics with `newDimension()` and `newMetric()`, setting defaults via `setDefaultDimension()` and `setDefaultMetric()`, and retrieving fields by ID with `getFieldById()`. `forIds()` filters fields based on IDs, `asArray()` returns fields as an array, and `build()` validates and formats the fields. It includes the `getDefaultDimension` and `getDefaultMetric` which return the default dimension and metric.\n"],null,["# Class Fields\n\nFields\n\nContains a set of [Field](/apps-script/reference/data-studio/field)s for a community connector. This set of fields define which\ndimensions and metrics can be used in Data Studio.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst fields = cc.getFields();\n\nconst field1 = fields\n .newDimension()\n // Set other properties as needed.\n .setId('field1_id');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|--------------------------------------------------------------|-----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|\n| [asArray()](#asArray()) | [Field[]](/apps-script/reference/data-studio/field) | Returns a view of this object as an array. |\n| [build()](#build()) | `Object[]` | Validates this object and returns it in the format needed by Data Studio. |\n| [forIds(ids)](#forIds(String)) | [Fields](#) | Returns a new [Fields](#) object filtered to [Field](/apps-script/reference/data-studio/field)s with an ID in `ids`. |\n| [getDefaultDimension()](#getDefaultDimension()) | [Field](/apps-script/reference/data-studio/field) | Returns the default dimension to be used for the set of fields. |\n| [getDefaultMetric()](#getDefaultMetric()) | [Field](/apps-script/reference/data-studio/field) | Returns the default metric to be used for the set of fields. |\n| [getFieldById(fieldId)](#getFieldById(String)) | [Field](/apps-script/reference/data-studio/field) | Returns a field with a given ID, or `null` if no field with that ID is in this [Fields](#) object. |\n| [newDimension()](#newDimension()) | [Field](/apps-script/reference/data-studio/field) | Returns a new dimension [Field](/apps-script/reference/data-studio/field). |\n| [newMetric()](#newMetric()) | [Field](/apps-script/reference/data-studio/field) | Returns a new metric [Field](/apps-script/reference/data-studio/field). |\n| [setDefaultDimension(fieldId)](#setDefaultDimension(String)) | `void` | Sets the default dimension to be used for the set of fields. |\n| [setDefaultMetric(fieldId)](#setDefaultMetric(String)) | `void` | Sets the default metric to be used for the set of fields. |\n\nDetailed documentation\n----------------------\n\n### `as``Array()`\n\nReturns a view of this object as an array.\n\n```javascript\nconst fields = DataStudioApp.createCommunityConnector().getFields();\nfields.newDimension().setId('field1_id');\nfields.newDimension().setId('field2_id');\nfields.newDimension().setId('field3_id');\n\n// Logging the ID of each field:\nfields.asArray().map((field) =\u003e {\n Logger.log(field.getId());\n});\n```\n\n#### Return\n\n\n[Field[]](/apps-script/reference/data-studio/field) --- An array of [Field](/apps-script/reference/data-studio/field) objects.\n\n*** ** * ** ***\n\n### `build()`\n\nValidates this object and returns it in the format needed by Data Studio.\n\n#### Return\n\n\n`Object[]` --- The validated field data, represented as a list of objects.\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if a valid object cannot be constructed.\n\n*** ** * ** ***\n\n### `for``Ids(ids)`\n\nReturns a new [Fields](#) object filtered to [Field](/apps-script/reference/data-studio/field)s with an ID in `ids`.\n\n```javascript\nconst fields = DataStudioApp.createCommunityConnector().getFields();\nfields.newDimension().setId('field1_id');\nfields.newDimension().setId('field2_id');\nfields.newDimension().setId('field3_id');\n\n// subsetFields is a Fields object that only contains field1 and field2.\nconst subsetFields = fields.forIds(['field1_id', 'field3_id']);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|------------|----------------------------------------|\n| `ids` | `String[]` | The IDs of fields that should be kept. |\n\n#### Return\n\n\n[Fields](#) --- A new [Fields](#) object.\n\n*** ** * ** ***\n\n### `get``Default``Dimension()`\n\nReturns the default dimension to be used for the set of fields. The default dimension is\nselected automatically when a new visualization is made.\n\n#### Return\n\n\n[Field](/apps-script/reference/data-studio/field) --- The dimension that is set as the default dimension, or `null` if no default\ndimension was set.\n\n*** ** * ** ***\n\n### `get``Default``Metric()`\n\nReturns the default metric to be used for the set of fields. The default metric is selected\nautomatically when a new visualization is made.\n\n#### Return\n\n\n[Field](/apps-script/reference/data-studio/field) --- The metric that is set as the default metric, or `null` if no default metric was\nset.\n\n*** ** * ** ***\n\n### `get``Field``By``Id(fieldId)`\n\nReturns a field with a given ID, or `null` if no field with that ID is in this [Fields](#) object.\n\n```javascript\nconst fields = DataStudioApp.createCommunityConnector().getFields();\nconst field1 = fields.newDimension().setId('field1_id');\n\n// byId is the same as field1.\nconst byId = fields.getFieldById('field1_id');\n\n// byId2 is null.\nconst byId2 = fields.getFieldById('not present id');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|----------|-----------------------------|\n| `field``Id` | `String` | The ID of the field to get. |\n\n#### Return\n\n\n[Field](/apps-script/reference/data-studio/field) --- The [Field](/apps-script/reference/data-studio/field) with the given ID, or `null` if no such field is contained\nwithin this [Fields](#) object.\n\n*** ** * ** ***\n\n### `new``Dimension()`\n\nReturns a new dimension [Field](/apps-script/reference/data-studio/field).\n\n#### Return\n\n\n[Field](/apps-script/reference/data-studio/field) --- A new dimension [Field](/apps-script/reference/data-studio/field).\n\n*** ** * ** ***\n\n### `new``Metric()`\n\nReturns a new metric [Field](/apps-script/reference/data-studio/field).\n\n#### Return\n\n\n[Field](/apps-script/reference/data-studio/field) --- A new metric [Field](/apps-script/reference/data-studio/field).\n\n*** ** * ** ***\n\n### `set``Default``Dimension(fieldId)`\n\nSets the default dimension to be used for the set of fields. The default dimension is selected\nautomatically when a new visualization is made.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|----------|----------------------------------------------------------------------------------------------------|\n| `field``Id` | `String` | The ID of the field to use as the default dimension. This ID must be present in the set of fields. |\n\n*** ** * ** ***\n\n### `set``Default``Metric(fieldId)`\n\nSets the default metric to be used for the set of fields. The default metric is selected\nautomatically when a new visualization is made.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|----------|-------------------------------------------------------------------------------------------------|\n| `field``Id` | `String` | The ID of the field to use as the default metric. This ID must be present in the set of fields. |"]]