Class UserError
Page Summary
A UserError is an error shown to users of the connector.
You can set the text of the error shown to users and a different debug text shown only to admins.
The
throwException()method is used to trigger the exception.
An error that is shown to users of the connector.
constcc=DataStudioApp.createCommunityConnector();cc.newUserError().setText('This is the debug error text.').setDebugText('This text is only shown to admins.').throwException();
Methods
| Method | Return type | Brief description |
|---|---|---|
print | String | Prints the JSON representation of this object. |
set | User | Sets the text of the debug error, which is only shown to admins. |
set | User | Sets the text of the user error. |
throw | void | Triggers this exception to be thrown. |
Detailed documentation
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setDebugText(text)
Sets the text of the debug error, which is only shown to admins.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | The error text. |
Return
User — This object, for chaining.
setText(text)
Sets the text of the user error.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | The error text. |
Return
User — This object, for chaining.
throwException()
Triggers this exception to be thrown.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.