Class AuthorizationInfo

AutorizaçãoInformações

Um objeto que verifica se o usuário concedeu autorização para os escopos necessários do script. O objeto também fornece um URL de autorização para que os usuários concedam essas permissões.

Algumas execuções de script podem começar sem o consentimento do usuário para todos os escopos necessários usados pelo script. As informações neste objeto permitem controlar o acesso a seções de código que exigem determinados escopos e solicitar a autorização desses escopos para execuções subsequentes.

Esse objeto é retornado por ScriptApp.getAuthorizationInfo(authMode). Em quase todos os casos, os scripts precisam chamar ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL), já que nenhum outro modo de autorização exige que os usuários concedam autorização.

Métodos

MétodoTipo de retornoBreve descrição
getAuthorizationStatus()AuthorizationStatusRecebe um valor que indica se o usuário precisa autorizar esse script para usar um ou mais serviços (por exemplo, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringRecebe o URL de autorização que pode ser usado para conceder acesso ao script.
getAuthorizedScopes()String[]Recebe uma lista de escopos autorizados para o script.

Documentação detalhada

getAuthorizationStatus()

Recebe um valor que indica se o usuário precisa autorizar esse script para usar um ou mais serviços (por exemplo, ScriptApp.AuthorizationStatus.REQUIRED).

// Log the authorization status (REQUIRED or NOT_REQUIRED).
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationStatus());

Retornar

AuthorizationStatus: o status da autorização


getAuthorizationUrl()

Recebe o URL de autorização que pode ser usado para conceder acesso ao script. Esse método retorna null se nenhuma autorização for necessária. A página no URL será fechada automaticamente se for acessada e o script não exigir nenhuma autorização.

// Log the URL used to grant access to the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationUrl());

Retornar

String: um URL que pode ser usado para autorizar o script.


getAuthorizedScopes()

Recebe uma lista de escopos autorizados para o script. Se as informações de autorização forem solicitadas para uma lista especificada de escopos, ele vai retornar os escopos autorizados da 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());

Retornar

String[]: a lista de escopos autorizados.