Escopos

Os usuários precisam autorizar complementos e outros aplicativos que acessem os dados ou agir em nome deles. Quando um usuário executa um complemento pela primeira vez, o interface do usuário do complemento mostra um prompt de autorização para iniciar o fluxo de autorização.

Durante esse fluxo, o prompt informa ao usuário o que o aplicativo quer permissão para fazer. Por exemplo, um complemento pode querer permissão para ler um enviar e-mails para um usuário ou criar eventos na agenda. O script do complemento define essas permissões individuais como escopos do OAuth.

Você declara escopos no seu manifesto usando strings de URL. Durante o fluxo de autorização, o Apps Script apresenta uma uma descrição legível do escopo para o usuário. Por exemplo, seu complemento do Google Workspace pode usar o erro "Ler a mensagem atual" , que é escrito no manifesto como https://www.googleapis.com/auth/gmail.addons.current.message.readonly: Durante fluxo de autorização, um complemento com esse escopo solicita que o usuário permita o complemento para: Acessar suas mensagens de e-mail quando o complemento estiver em execução.

Como visualizar escopos

Para ver os escopos de que seu projeto de script exige no momento, faça o seguinte:

1. Abra o projeto de script.
2. À esquerda, clique em Visão geral. info_outline
3. Confira os escopos em "Escopos do OAuth do projeto".

Também é possível conferir os escopos atuais do projeto de script no manifesto do projeto, no tipo oauthScopes campo, mas apenas se você tiver definido esses escopos explicitamente.

Definir escopos explícitos

O Apps Script verifica automaticamente quais escopos um script precisa verificar o código dele para chamadas de função que precisam delas. Para a maioria dos scripts, isso é suficientes e economiza tempo. No entanto, para complementos publicados, recomendamos controle mais direto dos escopos.

Por exemplo, o Apps Script pode dar a um projeto de script de complemento a opção mais permissiva escopo https://mail.google.com por padrão. Quando um usuário autoriza um script com esse escopo, ele recebe acesso total à conta do Gmail do Compute Engine. Para complementos publicados, é obrigatório substituir este escopo por um um conjunto limitado que atenda às necessidades dos complementos e nada mais.

Para definir explicitamente os escopos usados pelo projeto de script, edite o arquivo de manifesto. O campo do manifesto oauthScopes é uma matriz. de todos os escopos usados pelo complemento. Para definir os escopos do seu projeto, faça o seguinte:

1. Veja os escopos usados atualmente pelo complemento. Determine o que mudanças precisam ser feitas, como o uso de um escopo mais restrito.
2. Abra o arquivo de manifesto do complemento.
3. Localize o campo de nível superior rotulado como oauthScopes. Se ele não estiver presente, em que você pode adicioná-lo.

4. O oauthScopes especifica uma matriz de strings. Para definir os escopos seu projeto usa, substitua o conteúdo dessa matriz pelos escopos que você que quer que ele use. Por exemplo, em um complemento do Google Workspace que estende o Gmail, você pode ter o seguinte:

   {
     ...
     "oauthScopes": [
       "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
       "https://www.googleapis.com/auth/userinfo.email"
     ],
     ...
   }
   

5. Salve as mudanças no arquivo de manifesto.

Verificação do OAuth

O uso de determinados escopos OAuth sensíveis pode exigir que o complemento seja aprovado Verificação do cliente OAuth antes de publicá-lo. Para mais informações, consulte estes guias:

• Verificação do cliente OAuth para o Apps Script
• Apps não verificados
• Perguntas frequentes sobre a verificação do OAuth
• Serviço de APIs do Google: política de dados do usuário

Escopos restritos

Alguns escopos são restritos e estão sujeitos a regras adicionais que ajudam proteger os dados do usuário. Se você pretende publicar um Complemento do Gmail ou Editor que usa um ou mais escopos restritos, o complemento deve obedecer a todos os antes da publicação.

Consulte a lista completa de escopos restritos antes de tentar publicar. Se o complemento usar qualquer uma delas, você precisará obedecer com o Outros requisitos para escopos específicos da API antes da publicação.

Escopos da agenda

Confira abaixo escopos usados com frequência para complementos do Google Workspace que ampliam o Google Agenda.

Escopos do Drive

Confira abaixo escopos usados com frequência para complementos do Google Workspace que ampliam o Google Drive.

Escopos dos complementos do Gmail

Há alguns escopos que foram criados especificamente para Complementos do Google Workspace para proteger o Gmail dos usuários dados. Você deve adicionar esses escopos explicitamente ao manifesto do complemento, entre outros código do complemento necessário.

Confira abaixo escopos usados com frequência para complementos do Google Workspace que ampliam o Gmail. aqueles com o rótulo Obrigatório devem ser adicionados Manifesto de complemento do Google Workspace caso seu complemento seja estendido Gmail

Substitua o escopo https://mail.google.com, que é muito amplo, nos seus com um conjunto mais estreito de escopos que permitem as interações necessidades e nada mais.

Tokens de acesso

Para proteger os dados do usuário, os escopos do Gmail usados Concessão exclusiva de complementos do Google Workspace acesso temporário aos dados do usuário. Para ativar o acesso temporário, você deve chamar o método função GmailApp.setCurrentMessageAccessToken(accessToken) usando um token de acesso como argumento. Você deve obter um token de acesso de um objeto de evento de ação.

Veja a seguir um exemplo de configuração de um token de acesso para permitir o acesso a os metadados de uma mensagem. O único escopo necessário para este exemplo é https://www.googleapis.com/auth/gmail.addons.current.message.metadata:

function readSender(e) {
  var accessToken = e.gmail.accessToken;
  var messageId = e.gmail.messageId;

  // The following function enables short-lived access to the current
  // message in Gmail. Access to other Gmail messages or data isn't
  // permitted.
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  return mailMessage.getFrom();
}

Escopos do editor

Confira abaixo escopos usados com frequência para complementos do Google Workspace que ampliam os recursos do Documentos, Planilhas, e Apresentações.

Outros escopos

Seu complemento pode exigir escopos adicionais se usar outros serviços do Apps Script. Na maioria dos casos, você pode deixar que o Apps Script detecte esses escopos e atualize os manifesto do aplicativo automaticamente. Ao editar a lista de escopo do manifesto, não remova escopos, a menos que os substitua por uma alternativa mais apropriada, como um escopo mais restrito.

Como referência, aqui está uma lista de escopos do Apps Script usados com frequência em com complementos do Google Workspace: