Class AuthorizationInfo

اطلاعات مجوز

شیء‌ای که بررسی می‌کند آیا کاربر مجوز لازم برای محدوده‌های مورد نیاز اسکریپت را اعطا کرده است یا خیر. این شیء همچنین یک URL مجوز برای کاربران فراهم می‌کند تا این مجوزها را اعطا کنند.

برخی از اجرای اسکریپت‌ها می‌توانند بدون رضایت کاربر برای تمام حوزه‌های مورد نیاز استفاده شده توسط اسکریپت شروع شوند. اطلاعات موجود در این شیء به شما امکان می‌دهد دسترسی به بخش‌هایی از کد را که به حوزه‌های خاصی نیاز دارند کنترل کنید و برای اجراهای بعدی، مجوز آن حوزه‌ها را درخواست کنید.

این شیء توسط Script App.getAuthorizationInfo(authMode) برگردانده می‌شود. تقریباً در همه موارد، اسکریپت‌ها باید Script App.getAuthorizationInfo(ScriptApp.AuthMode.FULL) را فراخوانی کنند، زیرا هیچ حالت مجوزدهی دیگری نیازی به اعطای مجوز توسط کاربران ندارد.

روش‌ها

روش نوع بازگشتی شرح مختصر
get Authorization Status() Authorization Status مقداری را برمی‌گرداند که نشان می‌دهد آیا کاربر برای استفاده از یک یا چند سرویس (برای مثال، Script App.AuthorizationStatus.REQUIRED ) نیاز به تأیید این اسکریپت دارد یا خیر.
get Authorization Url() String|null URL مجوزی را که می‌تواند برای اعطای دسترسی به اسکریپت استفاده شود، دریافت می‌کند.
get Authorized Scopes() String[]|null لیستی از محدوده‌های مجاز برای اسکریپت را دریافت می‌کند.

مستندات دقیق

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|null — یک 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[]|null — فهرست محدوده‌های مجاز.