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[]: قائمة النطاقات المعتمَدة