Class AuthorizationInfo
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Información de autorización
Un objeto que verifica si el usuario otorgó la autorización para los permisos necesarios de la secuencia de comandos. El objeto también proporciona una URL de autorización para que los usuarios otorguen esos permisos.
Algunas ejecuciones de secuencias de comandos pueden comenzar sin el consentimiento del usuario para todos los permisos necesarios que usa la secuencia de comandos. La información de este objeto te permite controlar el acceso a secciones de código que requieren ciertos permisos y solicitar la autorización de esos permisos para ejecuciones posteriores.
ScriptApp.getAuthorizationInfo(authMode)
muestra este objeto. En casi todos los casos, las secuencias de comandos deben llamar a ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL)
, ya que ningún otro modo de autorización requiere que los usuarios otorguen autorización.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
getAuthorizationStatus() | AuthorizationStatus | Obtiene un valor que indica si el usuario debe autorizar esta secuencia de comandos para usar uno o más servicios (por ejemplo, ScriptApp.AuthorizationStatus.REQUIRED ). |
getAuthorizationUrl() | String | Obtiene la URL de autorización que se puede usar para otorgar acceso a la secuencia de comandos. |
getAuthorizedScopes() | String[] | Obtiene una lista de los permisos autorizados para la secuencia de comandos. |
Documentación detallada
getAuthorizationStatus()
Obtiene un valor que indica si el usuario debe autorizar esta secuencia de comandos para usar uno o más servicios (por ejemplo, ScriptApp.AuthorizationStatus.REQUIRED
).
// Log the authorization status (REQUIRED or NOT_REQUIRED).
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationStatus());
Volver
AuthorizationStatus
: Es el estado de autorización.
getAuthorizationUrl()
Obtiene la URL de autorización que se puede usar para otorgar acceso a la secuencia de comandos. Este método muestra null
si no se requiere autorización. La página de la URL se cerrará automáticamente si se accede a ella y la secuencia de comandos no requiere ninguna autorización.
// Log the URL used to grant access to the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationUrl());
Volver
String
: Es una URL que se puede usar para autorizar la secuencia de comandos.
getAuthorizedScopes()
Obtiene una lista de los permisos autorizados para la secuencia de comandos. Si se solicita información de autorización para una lista de permisos especificada, muestra los permisos autorizados de la lista especificada.
// 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());
Volver
String[]
: Es la lista de alcances autorizados.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003eAuthorizationInfo is an object used to determine if a user needs to authorize a script to use services and provides the authorization dialog URL.\u003c/p\u003e\n"],["\u003cp\u003eThis object is primarily used in add-ons with installable triggers to manage user access or prompt for authorization.\u003c/p\u003e\n"],["\u003cp\u003eIt offers two methods: \u003ccode\u003egetAuthorizationStatus()\u003c/code\u003e to check if authorization is required, and \u003ccode\u003egetAuthorizationUrl()\u003c/code\u003e to obtain the authorization URL.\u003c/p\u003e\n"],["\u003cp\u003eScripts should generally use \u003ccode\u003eScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL)\u003c/code\u003e for comprehensive authorization checks.\u003c/p\u003e\n"]]],[],null,["# Class AuthorizationInfo\n\nAuthorizationInfo\n\nAn object that checks if the user has granted authorization for the required scopes of the\nscript. The object also provides an authorization URL for users to grant those permissions.\n\nSome script executions can start without a user's consent to all required scopes used by the\nscript. The information in this object lets you control access to sections of code that require\ncertain scopes and request authorization of those scopes for subsequent executions.\n\nThis object is returned by [ScriptApp.getAuthorizationInfo(authMode)](/apps-script/reference/script/script-app#getAuthorizationInfo(AuthMode)). In almost\nall cases, scripts should call `Script``App.getAuthorizationInfo(ScriptApp.AuthMode.FULL)`,\nsince no other authorization mode requires that users grant authorization. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getAuthorizationStatus()](#getAuthorizationStatus()) | [AuthorizationStatus](/apps-script/reference/script/authorization-status) | Gets a value that indicates whether the user needs to authorize this script to use one or more services (for example, `Script``App.AuthorizationStatus.REQUIRED`). |\n| [getAuthorizationUrl()](#getAuthorizationUrl()) | `String` | Gets the authorization URL that can be used to grant access to the script. |\n| [getAuthorizedScopes()](#getAuthorizedScopes()) | `String[]` | Gets a list of authorized scopes for the script. |\n\nDetailed documentation\n----------------------\n\n### `get``Authorization``Status()`\n\nGets a value that indicates whether the user needs to authorize this script to use one or more\nservices (for example, `Script``App.AuthorizationStatus.REQUIRED`).\n\n```javascript\n// Log the authorization status (REQUIRED or NOT_REQUIRED).\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);\nLogger.log(authInfo.getAuthorizationStatus());\n```\n\n#### Return\n\n\n[AuthorizationStatus](/apps-script/reference/script/authorization-status) --- the authorization status\n\n*** ** * ** ***\n\n### `get``Authorization``Url()`\n\nGets the authorization URL that can be used to grant access to the script. This method returns\n`null` if no authorization is required. The page at the URL will close automatically if\nit is accessed and the script does not require any authorization.\n\n```javascript\n// Log the URL used to grant access to the script.\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);\nLogger.log(authInfo.getAuthorizationUrl());\n```\n\n#### Return\n\n\n`String` --- a URL that can be used to authorize the script\n\n*** ** * ** ***\n\n### `get``Authorized``Scopes()`\n\nGets a list of authorized scopes for the script. If authorization information is requested for\na specified list of scopes, returns the authorized scopes from the specified list.\n\n```javascript\n// Logs which scopes in the specified list have been authorized for the script.\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [\n 'https: //www.googleapis.com/auth/documents',\n 'https: //www.googleapis.com/auth/spreadsheets',\n]);\nLogger.log(authInfo.getAuthorizedScopes());\n```\n\n#### Return\n\n\n`String[]` --- The list of authorized scopes."]]