Class GetAuthTypeResponse
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
ObténlarespuestadeType de autenticación
Es un compilador para crear una respuesta getAuthType() para tu proyecto de secuencia de comandos.
function getAuthType() {
const cc = DataStudioApp.createCommunityConnector();
return cc.newAuthTypeResponse()
.setAuthType(cc.AuthType.USER_PASS)
.setHelpUrl('https://www.example.org/connector-auth-help')
.build();
}
Documentación detallada
build()
Valida este objeto y lo muestra en el formato que necesita Data Studio.
Volver
Object: Es el objeto GetAuthTypeResponse validado.
printJson()
Imprime la representación JSON de este objeto. Esto es solo para depuración.
Volver
String
setAuthType(authType)
Establece el AuthType del compilador.
Parámetros
| Nombre | Tipo | Descripción |
authType | AuthType | Es el tipo de autenticación que se establecerá. |
Volver
GetAuthTypeResponse: Este compilador, para encadenar.
setHelpUrl(helpUrl)
Establece la URL de ayuda del compilador.
La URL de ayuda es una URL opcional que el usuario puede visitar para obtener ayuda con la configuración de la autenticación. Esto solo es compatible con los authTypes USER_PASS, KEY y USER_TOKEN.
Parámetros
| Nombre | Tipo | Descripción |
helpUrl | String | Es la URL de ayuda que se debe establecer. |
Volver
GetAuthTypeResponse: Este compilador, para encadenar.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (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."]]
