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()
تُجري هذه الدالة عملية التحقّق من صحة هذا العنصر وتُعيده بالتنسيق المطلوب في "مركز بيانات Google".
الإرجاع
Object: عنصر GetAuthTypeResponse الذي تم التحقّق منه
printJson()
تُطبع تمثيل JSON لهذا الكائن. يُستخدم هذا الخيار لتصحيح الأخطاء فقط.
الإرجاع
String
setHelpUrl(helpUrl)
لضبط عنوان URL الخاص بمساعدة أداة الإنشاء
عنوان URL الخاص بالمساعدة هو عنوان URL اختياري يمكن للمستخدم الانتقال إليه للحصول على مساعدة بشأن إعداد المصادقة. لا يتوفر
هذا الخيار إلا لأنواع المصادقة USER_PASS وKEY وUSER_TOKEN.
المعلمات
| الاسم | النوع | الوصف |
helpUrl | String | عنوان URL للمساعدة المطلوب ضبطه |
الإرجاع
GetAuthTypeResponse: هذا المُنشئ، لتسلسل العناصر.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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."]]
