شی ای که بررسی می کند آیا کاربر مجوز برای محدوده های مورد نیاز اسکریپت را اعطا کرده است یا خیر. شی همچنین یک URL مجوز برای کاربران فراهم می کند تا آن مجوزها را اعطا کنند.
اجرای برخی از اسکریپت ها می تواند بدون رضایت کاربر برای همه حوزه های مورد نیاز مورد استفاده اسکریپت شروع شود. اطلاعات موجود در این شی به شما امکان میدهد دسترسی به بخشهایی از کد را که به محدودههای خاصی نیاز دارند کنترل کنید و برای اجرای بعدی درخواست مجوز برای آن دامنهها کنید.
این شی توسط Script App.getAuthorizationInfo(authMode)
برگردانده می شود. تقریباً در همه موارد، اسکریپتها باید Script App.getAuthorizationInfo(ScriptApp.AuthMode.FULL)
فراخوانی کنند، زیرا هیچ حالت مجوز دیگری نیازی به اعطای مجوز توسط کاربران ندارد.
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
get Authorization Status() | Authorization Status | مقداری دریافت میکند که نشان میدهد آیا کاربر باید برای استفاده از یک یا چند سرویس به این اسکریپت مجوز دهد (مثلاً Script App.AuthorizationStatus.REQUIRED ). |
get Authorization Url() | String | URL مجوزی را دریافت می کند که می تواند برای اعطای دسترسی به اسکریپت استفاده شود. |
get Authorized Scopes() | String[] | لیستی از محدوده های مجاز برای اسکریپت را دریافت می کند. |
مستندات دقیق
get Authorization Status()
مقداری دریافت میکند که نشان میدهد آیا کاربر باید برای استفاده از یک یا چند سرویس به این اسکریپت مجوز دهد (مثلاً Script App.AuthorizationStatus.REQUIRED
).
// Log the authorization status (REQUIRED or NOT_REQUIRED). const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL); Logger.log(authInfo.getAuthorizationStatus());
بازگشت
Authorization Status
- وضعیت مجوز
get Authorization Url()
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 که می تواند برای مجوز دادن به اسکریپت استفاده شود
get Authorized Scopes()
لیستی از محدوده های مجاز برای اسکریپت را دریافت می کند. اگر اطلاعات مجوز برای یک لیست مشخص از محدوده ها درخواست شود، محدوده های مجاز را از لیست مشخص شده برمی گرداند.
// 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[]
- فهرست محدوده های مجاز.