Class UserError
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.
Lỗingười dùng
Lỗi hiển thị cho người dùng của trình kết nối.
const cc = DataStudioApp.createCommunityConnector();
cc.newUserError()
.setText('This is the debug error text.')
.setDebugText('This text is only shown to admins.')
.throwException();
Tài liệu chi tiết
printJson()
In nội dung đại diện JSON của đối tượng này. Lựa chọn này chỉ dùng để gỡ lỗi.
Cầu thủ trả bóng
String
setDebugText(text)
Đặt văn bản của lỗi gỡ lỗi, chỉ quản trị viên mới xem được.
Tham số
| Tên | Loại | Mô tả |
text | String | Văn bản lỗi. |
Cầu thủ trả bóng
UserError – Đối tượng này, để tạo chuỗi.
setText(text)
Đặt văn bản của lỗi người dùng.
Tham số
| Tên | Loại | Mô tả |
text | String | Văn bản lỗi. |
Cầu thủ trả bóng
UserError – Đối tượng này, để tạo chuỗi.
throwException()
Kích hoạt trường hợp ngoại lệ này.
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\u003e\u003ccode\u003eUserError\u003c/code\u003e is a class representing errors displayed to users of a connector in DataStudio.\u003c/p\u003e\n"],["\u003cp\u003eThis class provides methods to set user-facing error messages and debug messages for administrators.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eUserError\u003c/code\u003e includes a \u003ccode\u003ethrowException()\u003c/code\u003e method to trigger the error, halting execution.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003esetText()\u003c/code\u003e and \u003ccode\u003esetDebugText()\u003c/code\u003e facilitate customization of error messages, supporting both user and admin perspectives.\u003c/p\u003e\n"]]],["The `UserError` class allows developers to create and manage errors displayed to users of a data connector. Key actions include setting the user-facing error message using `setText()`, setting a separate admin-only debug message with `setDebugText()`, and triggering the error to be thrown using `throwException()`. The `printJson()` function outputs a JSON representation for debugging. Both `setText` and `setDebugText` can be chained.\n"],null,["# Class UserError\n\nUserError\n\nAn error that is shown to users of the connector.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\n\ncc.newUserError()\n .setText('This is the debug error text.')\n .setDebugText('This text is only shown to admins.')\n .throwException();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------|----------------|------------------------------------------------------------------|\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setDebugText(text)](#setDebugText(String)) | [UserError](#) | Sets the text of the debug error, which is only shown to admins. |\n| [setText(text)](#setText(String)) | [UserError](#) | Sets the text of the user error. |\n| [throwException()](#throwException()) | `void` | Triggers this exception to be thrown. |\n\nDetailed documentation\n----------------------\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `set``Debug``Text(text)`\n\nSets the text of the debug error, which is only shown to admins.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------|\n| `text` | `String` | The error text. |\n\n#### Return\n\n\n[UserError](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Text(text)`\n\nSets the text of the user error.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------|\n| `text` | `String` | The error text. |\n\n#### Return\n\n\n[UserError](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `throw``Exception()`\n\nTriggers this exception to be thrown."]]
