Class AuthorizationInfo
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
معلومات التفويض
عنصر يتحقّق مما إذا كان المستخدم قد منح الإذن بالنطاقات المطلوبة للملف
البرمجي. يقدّم العنصر أيضًا عنوان URL لمنح الأذونات للمستخدمين.
يمكن أن تبدأ بعض عمليات تنفيذ النصوص البرمجية بدون موافقة المستخدم على جميع النطاقات المطلوبة التي يستخدمها
النص البرمجي. تتيح لك المعلومات الواردة في هذا العنصر التحكّم في الوصول إلى أقسام من الرمز البرمجي التي تتطلّب
نطاقات معيّنة وطلب تفويض هذه النطاقات للتنفيذات اللاحقة.
تم إرجاع هذا العنصر من قِبل ScriptApp.getAuthorizationInfo(authMode). في كل الحالات تقريبًا، يجب أن تستدعي النصوص البرمجية ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL)،
لأنّه لا يوجد وضع تفويض آخر يتطلب من المستخدمين منح التفويض.
الطُرق
| الطريقة | نوع القيمة التي يتم عرضها | وصف قصير |
getAuthorizationStatus() | AuthorizationStatus | تحصل على قيمة تشير إلى ما إذا كان المستخدم بحاجة إلى تفويض هذا النص البرمجي لاستخدام خدمة واحدة أو أكثر (على سبيل المثال، ScriptApp.AuthorizationStatus.REQUIRED). |
getAuthorizationUrl() | String | تحصل على عنوان URL للتفويض الذي يمكن استخدامه لمنح إذن الوصول إلى النص البرمجي. |
getAuthorizedScopes() | String[] | تحصل على قائمة بالنطاقات المعتمَدة للنص البرمجي. |
مستندات تفصيلية
getAuthorizationStatus()
تحصل على قيمة تشير إلى ما إذا كان المستخدم بحاجة إلى تفويض هذا النص البرمجي لاستخدام خدمة واحدة أو أكثر (على سبيل المثال، ScriptApp.AuthorizationStatus.REQUIRED).
// Log the authorization status (REQUIRED or NOT_REQUIRED).
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationStatus());
الإرجاع
AuthorizationStatus - حالة التفويض
getAuthorizationUrl()
تحصل على عنوان URL للتفويض الذي يمكن استخدامه لمنح إذن الوصول إلى النص البرمجي. تعرض هذه الطريقة القيمة
null إذا لم يكن التفويض مطلوبًا. سيتم إغلاق الصفحة على عنوان URL تلقائيًا في حال
الوصول إليها وعدم طلب النص البرمجي لأي تفويض.
// Log the URL used to grant access to the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationUrl());
الإرجاع
String: عنوان URL يمكن استخدامه لتفويض النص البرمجي
getAuthorizedScopes()
تحصل على قائمة بالنطاقات المعتمَدة للنص البرمجي. في حال طلب معلومات التفويض ل
قائمة محدّدة من النطاقات، يتم عرض النطاقات المفوَّضة من القائمة المحدّدة.
// Logs which scopes in the specified list have been authorized for the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [
'https: //www.googleapis.com/auth/documents',
'https: //www.googleapis.com/auth/spreadsheets',
]);
Logger.log(authInfo.getAuthorizedScopes());
الإرجاع
String[]: قائمة النطاقات المعتمَدة
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eAuthorizationInfo is an object used to determine if a user needs to authorize a script to use services and provides the authorization dialog URL.\u003c/p\u003e\n"],["\u003cp\u003eThis object is primarily used in add-ons with installable triggers to manage user access or prompt for authorization.\u003c/p\u003e\n"],["\u003cp\u003eIt offers two methods: \u003ccode\u003egetAuthorizationStatus()\u003c/code\u003e to check if authorization is required, and \u003ccode\u003egetAuthorizationUrl()\u003c/code\u003e to obtain the authorization URL.\u003c/p\u003e\n"],["\u003cp\u003eScripts should generally use \u003ccode\u003eScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL)\u003c/code\u003e for comprehensive authorization checks.\u003c/p\u003e\n"]]],[],null,["# Class AuthorizationInfo\n\nAuthorizationInfo\n\nAn object that checks if the user has granted authorization for the required scopes of the\nscript. The object also provides an authorization URL for users to grant those permissions.\n\nSome script executions can start without a user's consent to all required scopes used by the\nscript. The information in this object lets you control access to sections of code that require\ncertain scopes and request authorization of those scopes for subsequent executions.\n\nThis object is returned by [ScriptApp.getAuthorizationInfo(authMode)](/apps-script/reference/script/script-app#getAuthorizationInfo(AuthMode)). In almost\nall cases, scripts should call `Script``App.getAuthorizationInfo(ScriptApp.AuthMode.FULL)`,\nsince no other authorization mode requires that users grant authorization. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getAuthorizationStatus()](#getAuthorizationStatus()) | [AuthorizationStatus](/apps-script/reference/script/authorization-status) | Gets a value that indicates whether the user needs to authorize this script to use one or more services (for example, `Script``App.AuthorizationStatus.REQUIRED`). |\n| [getAuthorizationUrl()](#getAuthorizationUrl()) | `String` | Gets the authorization URL that can be used to grant access to the script. |\n| [getAuthorizedScopes()](#getAuthorizedScopes()) | `String[]` | Gets a list of authorized scopes for the script. |\n\nDetailed documentation\n----------------------\n\n### `get``Authorization``Status()`\n\nGets a value that indicates whether the user needs to authorize this script to use one or more\nservices (for example, `Script``App.AuthorizationStatus.REQUIRED`).\n\n```javascript\n// Log the authorization status (REQUIRED or NOT_REQUIRED).\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);\nLogger.log(authInfo.getAuthorizationStatus());\n```\n\n#### Return\n\n\n[AuthorizationStatus](/apps-script/reference/script/authorization-status) --- the authorization status\n\n*** ** * ** ***\n\n### `get``Authorization``Url()`\n\nGets the authorization URL that can be used to grant access to the script. This method returns\n`null` if no authorization is required. The page at the URL will close automatically if\nit is accessed and the script does not require any authorization.\n\n```javascript\n// Log the URL used to grant access to the script.\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);\nLogger.log(authInfo.getAuthorizationUrl());\n```\n\n#### Return\n\n\n`String` --- a URL that can be used to authorize the script\n\n*** ** * ** ***\n\n### `get``Authorized``Scopes()`\n\nGets a list of authorized scopes for the script. If authorization information is requested for\na specified list of scopes, returns the authorized scopes from the specified list.\n\n```javascript\n// Logs which scopes in the specified list have been authorized for the script.\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [\n 'https: //www.googleapis.com/auth/documents',\n 'https: //www.googleapis.com/auth/spreadsheets',\n]);\nLogger.log(authInfo.getAuthorizedScopes());\n```\n\n#### Return\n\n\n`String[]` --- The list of authorized scopes."]]
