Class GetAuthTypeResponse
Stay organized with collections
Save and categorize content based on your preferences.
GetAuthTypeResponse
Builder to create a getAuthType() response for your script project.
function getAuthType() {
const cc = DataStudioApp.createCommunityConnector();
return cc.newAuthTypeResponse()
.setAuthType(cc.AuthType.USER_PASS)
.setHelpUrl('https://www.example.org/connector-auth-help')
.build();
}
Detailed documentation
build()
Validates this object and returns it in the format needed by Data Studio.
Return
Object — The validated GetAuthTypeResponse object.
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setHelpUrl(helpUrl)
Sets the help URL of the builder.
The help URL is an optional URL the user can visit to get help on setting up auth. This is
only supported for USER_PASS, KEY, and USER_TOKEN
authTypes.
Parameters
| Name | Type | Description |
helpUrl | String | The help URL to set. |
Return
GetAuthTypeResponse — This builder, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eGetAuthTypeResponse\u003c/code\u003e enables defining the authentication method for your Data Studio connector script.\u003c/p\u003e\n"],["\u003cp\u003eIt allows you to specify the authentication type, such as \u003ccode\u003eUSER_PASS\u003c/code\u003e, and provide a help URL for users.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetAuthTypeResponse\u003c/code\u003e offers methods like \u003ccode\u003esetAuthType\u003c/code\u003e, \u003ccode\u003esetHelpUrl\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e, and \u003ccode\u003eprintJson\u003c/code\u003e to configure and finalize the authentication response.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild\u003c/code\u003e method returns the validated object in the required format for Data Studio.\u003c/p\u003e\n"]]],[],null,["# Class GetAuthTypeResponse\n\nGetAuthTypeResponse\n\nBuilder to create a `get``Auth``Type()` response for your script project.\n\n```javascript\nfunction getAuthType() {\n const cc = DataStudioApp.createCommunityConnector();\n\n return cc.newAuthTypeResponse()\n .setAuthType(cc.AuthType.USER_PASS)\n .setHelpUrl('https://www.example.org/connector-auth-help')\n .build();\n}\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------|--------------------------|-----------------------------------------------------------------------------------|\n| [build()](#build()) | `Object` | Validates this object and returns it in the format needed by Data Studio. |\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setAuthType(authType)](#setAuthType(AuthType)) | [GetAuthTypeResponse](#) | Sets the [AuthType](/apps-script/reference/data-studio/auth-type) of the builder. |\n| [setHelpUrl(helpUrl)](#setHelpUrl(String)) | [GetAuthTypeResponse](#) | Sets the help URL of the builder. |\n\nDetailed documentation\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 [GetAuthTypeResponse](#) object.\n\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``Auth``Type(authType)`\n\nSets the [AuthType](/apps-script/reference/data-studio/auth-type) of the builder.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------------------------------------------------------|---------------------------------|\n| `auth``Type` | [AuthType](/apps-script/reference/data-studio/auth-type) | The authentication type to set. |\n\n#### Return\n\n\n[GetAuthTypeResponse](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Help``Url(helpUrl)`\n\nSets the help URL of the builder.\n\nThe help URL is an optional URL the user can visit to get help on setting up auth. This is\nonly supported for `USER_PASS`, `KEY`, and `USER_TOKEN`\nauthTypes.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|----------|----------------------|\n| `help``Url` | `String` | The help URL to set. |\n\n#### Return\n\n\n[GetAuthTypeResponse](#) --- This builder, for chaining."]]
