Escopos de autorização

Os usuários precisam autorizar projetos de script que acessam os dados deles ou agem em nome deles. Quando um usuário executa um script que requer autorização para a primeira momento, a interface apresenta um prompt para iniciar o fluxo de autorização.

Durante esse fluxo, a interface informa ao usuário o que o script precisa de permissão o que fazer. Por exemplo, um script pode querer permissão para ler o mensagens de e-mail ou criar eventos na agenda. O projeto de script define essas permissões individuais como escopos do OAuth.

Na maioria dos scripts, o Apps Script detecta automaticamente quais escopos necessários para você. você pode ver os escopos usados por um script a qualquer momento. Também é possível definir escopos explicitamente no seu manifesto usando strings de URL. Ambiente escopos às vezes é explicitamente necessário para certos aplicativos, complementos, já que os aplicativos publicados devem sempre use os escopos mais estreitos possíveis.

Durante o fluxo de autorização, o Apps Script apresenta descrições dos escopos necessários para o usuário. Por exemplo, se seu script precisar de acesso somente leitura às planilhas, o manifesto poderá ter o escopo https://www.googleapis.com/auth/spreadsheets.readonly: Durante o fluxo de autorização, um script com esse escopo solicita que o usuário permita esta aplicativo para "Visualizar suas Planilhas do Google".

Alguns escopos incluem outros. Por exemplo, quando autorizado, o escopo https://www.googleapis.com/auth/spreadsheets permite acesso de leitura e gravação a planilhas.

Como visualizar escopos

Para ver os escopos de que seu projeto de script exige atualmente, faça o seguintes:

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

Definir escopos explícitos

O Apps Script determina automaticamente quais escopos um script precisa lendo o código em busca de chamadas de função que as exijam. Para a maioria dos scripts, é suficiente e economiza tempo, mas, para complementos publicados, apps do Google Chat e chamadas para a API Google Chat, você precisa se exercitar mais controle direto dos escopos.

Às vezes, o Apps Script atribui automaticamente escopos muito permissivos aos projetos. Isso pode significar que seu script está pedindo ao usuário mais do que o necessário, o que é ruim prática. Para scripts publicados, você deve substituir escopos amplos por um um conjunto mais limitado que cubra as necessidades do script e nada mais.

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

  1. Abra o projeto de script.
  2. À esquerda, clique em Configurações do projeto .
  3. Selecione a caixa de seleção Mostrar arquivo de manifesto "appsscript.json" no editor.
  4. À esquerda, clique em Editor .
  5. À esquerda, clique no arquivo appsscript.json.
  6. Localize o campo de nível superior com a etiqueta oauthScopes. Se ele não estiver presente, adicione-o.
  7. O campo 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. Exemplo: 
          {
        ...
        "oauthScopes": [
          "https://www.googleapis.com/auth/spreadsheets.readonly",
          "https://www.googleapis.com/auth/userinfo.email"
        ],
       ...
      }
  8. Na parte superior, clique em Salvar .

Verificação do OAuth

Alguns escopos do OAuth são sensíveis porque permitem o acesso aos dados do usuário do Google. Se o projeto de script usar escopos que permitem o acesso aos dados do usuário, o projeto deve passar Verificação do cliente OAuth antes de publicá-lo publicamente como um aplicativo da web ou complemento. Para mais informações, consulte estes guias:

Escopos restritos

Além dos escopos confidenciais, alguns são classificados como restrito e estão sujeitos a regras adicionais que ajudam a proteger os dados do usuário. Se você pretende publicar um app da Web ou complemento que usa um ou mais escopos restritos, o app precisa obedecer a todas as restrições especificadas antes da publicação.

Consulte a lista completa de escopos restritos antes de tentar publicar. Caso seu app use algum deles, você precisa obedecer às regras com o Consulte a seção Outros requisitos para escopos específicos da API antes da publicação.