Class GetAuthTypeResponse
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
GetAuthTypeResponse
ตัวสร้างเพื่อสร้างคำตอบ getAuthType() สำหรับโปรเจ็กต์สคริปต์
function getAuthType() {
const cc = DataStudioApp.createCommunityConnector();
return cc.newAuthTypeResponse()
.setAuthType(cc.AuthType.USER_PASS)
.setHelpUrl('https://www.example.org/connector-auth-help')
.build();
}
เอกสารประกอบโดยละเอียด
build()
ตรวจสอบออบเจ็กต์นี้และแสดงผลในรูปแบบที่ Data Studio ต้องการ
รีเทิร์น
Object — ออบเจ็กต์ GetAuthTypeResponse ที่ตรวจสอบแล้ว
printJson()
พิมพ์การแสดง JSON ของออบเจ็กต์นี้ การดำเนินการนี้มีไว้สำหรับการแก้ไขข้อบกพร่องเท่านั้น
รีเทิร์น
String
setAuthType(authType)
ตั้งค่า AuthType ของเครื่องมือสร้าง
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
authType | AuthType | ประเภทการตรวจสอบสิทธิ์ที่จะตั้งค่า |
รีเทิร์น
GetAuthTypeResponse — ตัวสร้างนี้สําหรับการต่อเชื่อม
setHelpUrl(helpUrl)
ตั้งค่า URL ความช่วยเหลือของเครื่องมือสร้าง
URL ความช่วยเหลือเป็น URL ที่ไม่บังคับซึ่งผู้ใช้เข้าชมเพื่อรับความช่วยเหลือเกี่ยวกับการตั้งค่าการตรวจสอบสิทธิ์ได้ การดำเนินการนี้รองรับเฉพาะ authTypes USER_PASS, KEY และ USER_TOKEN เท่านั้น
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
helpUrl | String | URL ความช่วยเหลือที่จะตั้งค่า |
รีเทิร์น
GetAuthTypeResponse — ตัวสร้างนี้สําหรับการต่อเชื่อม
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-26 UTC
[null,null,["อัปเดตล่าสุด 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."]]
