Class GetAuthTypeResponse
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
GetAuthTypeResponse
Builder untuk membuat respons getAuthType()
untuk project skrip Anda.
function getAuthType() {
const cc = DataStudioApp.createCommunityConnector();
return cc.newAuthTypeResponse()
.setAuthType(cc.AuthType.USER_PASS)
.setHelpUrl('https://www.example.org/connector-auth-help')
.build();
}
Dokumentasi mendetail
build()
Memvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
Pulang pergi
Object
— Objek GetAuthTypeResponse
yang divalidasi.
printJson()
Mencetak representasi JSON objek ini. Ini hanya untuk proses debug.
Pulang pergi
String
setAuthType(authType)
Menetapkan AuthType
builder.
Parameter
Nama | Jenis | Deskripsi |
authType | AuthType | Jenis autentikasi yang akan ditetapkan. |
Pulang pergi
GetAuthTypeResponse
— Builder ini, untuk pembuatan rantai.
setHelpUrl(helpUrl)
Menetapkan URL bantuan builder.
URL bantuan adalah URL opsional yang dapat dikunjungi pengguna untuk mendapatkan bantuan terkait penyiapan autentikasi. Hal ini
hanya didukung untuk authTypes USER_PASS
, KEY
, dan USER_TOKEN
.
Parameter
Nama | Jenis | Deskripsi |
helpUrl | String | URL bantuan yang akan ditetapkan. |
Pulang pergi
GetAuthTypeResponse
— Builder ini, untuk pembuatan rantai.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-26 UTC.
[null,null,["Terakhir diperbarui pada 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."]]