با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
فیلدها
شامل مجموعه ای از Field برای یک اتصال دهنده جامعه است. این مجموعه از فیلدها مشخص می کند که کدام ابعاد و معیارها را می توان در Data Studio استفاده کرد.
constcc=DataStudioApp.createCommunityConnector();constfields=cc.getFields();constfield1=fields.newDimension()// Set other properties as needed..setId('field1_id');
متریک پیش‌فرض را برای استفاده برای مجموعه فیلدها تنظیم می‌کند.
مستندات دقیق
as Array()
نمای این شیء را به صورت آرایه برمی گرداند.
constfields=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());});
یک شی Fields جدید فیلتر شده به Field s را با شناسه در ids برمی گرداند.
constfields=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.constsubsetFields=fields.forIds(['field1_id','field3_id']);
بعد پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند. بعد پیش‌فرض زمانی که تصویرسازی جدیدی ساخته می‌شود، به‌طور خودکار انتخاب می‌شود.
بازگشت
Field - بعد که به عنوان بعد پیش‌فرض تنظیم می‌شود یا اگر بعد پیش‌فرض تنظیم نشده باشد، null .
get Default Metric()
متریک پیش‌فرض مورد استفاده برای مجموعه فیلدها را برمی‌گرداند. هنگامی که تصویرسازی جدید ساخته می شود، معیار پیش فرض به طور خودکار انتخاب می شود.
بازگشت
Field - معیاری که به عنوان متریک پیش‌فرض تنظیم می‌شود، یا اگر متریک پیش‌فرض تنظیم نشده باشد، null .
get Field By Id(fieldId)
فیلدی را با یک شناسه داده شده برمی‌گرداند، یا اگر فیلدی با آن شناسه در شیء Fields وجود نداشته باشد null .
constfields=DataStudioApp.createCommunityConnector().getFields();constfield1=fields.newDimension().setId('field1_id');// byId is the same as field1.constbyId=fields.getFieldById('field1_id');// byId2 is null.constbyId2=fields.getFieldById('not present id');
پارامترها
نام
تایپ کنید
توضیحات
field Id
String
شناسه فیلد برای گرفتن.
بازگشت
Field - Field با شناسه داده شده، یا اگر چنین فیلدی در این شیء Fields وجود نداشته باشد، null .
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\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,["Fields\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\nMethods\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`as``Array()` \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\nReturn\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()` \nValidates this object and returns it in the format needed by Data Studio.\n\nReturn\n\n\n`Object[]` --- The validated field data, represented as a list of objects.\n\nThrows\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)` \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\nParameters\n\n| Name | Type | Description |\n|-------|------------|----------------------------------------|\n| `ids` | `String[]` | The IDs of fields that should be kept. |\n\nReturn\n\n\n[Fields](#) --- A new [Fields](#) object.\n\n*** ** * ** ***\n\n`get``Default``Dimension()` \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\nReturn\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()` \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\nReturn\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)` \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\nParameters\n\n| Name | Type | Description |\n|-------------|----------|-----------------------------|\n| `field``Id` | `String` | The ID of the field to get. |\n\nReturn\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()` \nReturns a new dimension [Field](/apps-script/reference/data-studio/field).\n\nReturn\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()` \nReturns a new metric [Field](/apps-script/reference/data-studio/field).\n\nReturn\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)` \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\nParameters\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)` \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\nParameters\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. |"]]
