Объект, который проверяет, предоставил ли пользователь авторизацию для необходимых областей действия скрипта. Объект также предоставляет пользователям 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[]
— Список разрешенных областей.