Class AuthorizationInfo

معلوماتالتفويض

عنصر يتحقّق مما إذا كان المستخدم قد منح إذنًا بالنطاقات المطلوبة للبرنامج النصي. يوفّر العنصر أيضًا عنوان URL للتفويض يمكن للمستخدمين من خلاله منح هذه الأذونات.

يمكن أن تبدأ بعض عمليات تنفيذ النصوص البرمجية بدون موافقة المستخدم على جميع النطاقات المطلوبة التي يستخدمها النص البرمجي. تتيح لك المعلومات الواردة في هذا العنصر التحكّم في الوصول إلى أقسام الرمز التي تتطلّب نطاقات معيّنة وطلب تفويض هذه النطاقات لعمليات التنفيذ اللاحقة.

يتم عرض هذا العنصر من خلال ScriptApp.getAuthorizationInfo(authMode). في جميع الحالات تقريبًا، يجب أن تطلب النصوص البرمجية ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL)، لأنّ أي وضع تفويض آخر لا يتطلّب أن يمنح المستخدمون التفويض.

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
getAuthorizationStatus()AuthorizationStatusيحصل على قيمة تشير إلى ما إذا كان المستخدم بحاجة إلى منح الإذن لهذا النص البرمجي لاستخدام خدمة واحدة أو أكثر (على سبيل المثال، ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()String|nullتعرض هذه الدالة عنوان URL للتفويض يمكن استخدامه لمنح إذن الوصول إلى النص البرمجي.
getAuthorizedScopes()String[]|nullتعرض هذه الدالة قائمة بالنطاقات المصرّح بها للنص البرمجي.

مستندات تفصيلية

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|null: عنوان 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[]|null بقائمة النطاقات المسموح بها.