Class Fields
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Trường
Chứa một tập hợp Field cho trình kết nối cộng đồng. Tập hợp các trường này xác định những phương diện và chỉ số có thể sử dụng trong Data Studio.
const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();
const field1 = fields
.newDimension()
// Set other properties as needed.
.setId('field1_id');
Tài liệu chi tiết
asArray()
Trả về chế độ xem của đối tượng này dưới dạng một mảng.
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());
});
Cầu thủ trả bóng
Field[] – Một mảng gồm các đối tượng Field.
build()
Xác thực đối tượng này và trả về đối tượng đó ở định dạng mà Data Studio cần.
Cầu thủ trả bóng
Object[] – Dữ liệu trường đã xác thực, được biểu thị dưới dạng danh sách đối tượng.
Gửi
Error – nếu không thể tạo một đối tượng hợp lệ.
forIds(ids)
Trả về một đối tượng Fields mới được lọc thành Field có mã nhận dạng trong ids.
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']);
Tham số
| Tên | Loại | Mô tả |
ids | String[] | Mã nhận dạng của các trường cần giữ lại. |
Cầu thủ trả bóng
Fields – Một đối tượng Fields mới.
getDefaultDimension()
Trả về phương diện mặc định sẽ được sử dụng cho tập hợp các trường. Phương diện mặc định được chọn tự động khi tạo một hình ảnh trực quan mới.
Cầu thủ trả bóng
Field – Phương diện được đặt làm phương diện mặc định hoặc null nếu không có phương diện mặc định nào được đặt.
getDefaultMetric()
Trả về chỉ số mặc định sẽ được sử dụng cho tập hợp các trường. Chỉ số mặc định được chọn tự động khi bạn tạo một hình ảnh trực quan mới.
Cầu thủ trả bóng
Field – Chỉ số được đặt làm chỉ số mặc định hoặc null nếu không có chỉ số mặc định nào được đặt.
getFieldById(fieldId)
Trả về một trường có mã nhận dạng nhất định hoặc null nếu không có trường nào có mã nhận dạng đó trong đối tượng Fields này.
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');
Tham số
| Tên | Loại | Mô tả |
fieldId | String | Mã nhận dạng của trường cần lấy. |
Cầu thủ trả bóng
Field – Field có mã nhận dạng đã cho hoặc null nếu không có trường nào như vậy trong đối tượng Fields này.
newDimension()
Trả về một phương diện mới Field.
Cầu thủ trả bóng
Field – Một phương diện mới Field.
newMetric()
Trả về một chỉ số mới Field.
Cầu thủ trả bóng
Field – Một chỉ số mới Field.
setDefaultDimension(fieldId)
Đặt phương diện mặc định sẽ được sử dụng cho tập hợp các trường. Phương diện mặc định được chọn tự động khi tạo một hình ảnh trực quan mới.
Tham số
| Tên | Loại | Mô tả |
fieldId | String | Mã của trường sẽ dùng làm phương diện mặc định. Mã này phải có trong tập hợp các trường. |
setDefaultMetric(fieldId)
Đặt chỉ số mặc định sẽ được sử dụng cho tập hợp các trường. Chỉ số mặc định được chọn tự động khi bạn tạo một hình ảnh trực quan mới.
Tham số
| Tên | Loại | Mô tả |
fieldId | String | Mã của trường sẽ dùng làm chỉ số mặc định. Mã này phải có trong tập hợp các trường. |
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-26 UTC.
[null,null,["Cập nhật lần gần đây nhất: 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. |"]]
