Escolher escopos da API Google Sheets

Este documento contém informações de autorização e autenticação específicas da API Google Sheets. Antes de ler este documento, leia as informações gerais de autenticação e autorização do Google Workspace em Saiba mais sobre autenticação e autorização.

Configurar o OAuth 2.0 para autorização

Configurar a tela de consentimento do OAuth e escolher escopos para definir quais informações são exibidas para usuários e revisores de apps e registrar seu app para poder publicá-lo mais tarde.

Escopos da API Sheets

Para definir o nível de acesso concedido ao app, é necessário identificar e declarar os escopos de autorização. Um escopo de autorização é uma string de URI OAuth 2.0 que contém o nome do app do Google Workspace, o tipo de dados que ele acessa e o nível de acesso. Os escopos são as solicitações do app para trabalhar com dados do Google Workspace, incluindo dados da Conta do Google dos usuários.

Quando o app é instalado, o usuário precisa validar os escopos usados por ele. Geralmente, escolha o escopo mais focado possível e evite solicitar escopos que o app não exige. Os usuários concedem acesso mais fácil a escopos limitados e claramente descritos.

Quando possível, recomendamos o uso de escopos não sensíveis, porque eles concedem escopo de acesso por arquivo e restringem o acesso a recursos específicos necessários por um app.

A API Sheets oferece suporte aos seguintes escopos:

Código do escopo Descrição Uso
https://www.googleapis.com/auth/spreadsheets Acessar, editar, criar e excluir todas as suas planilhas das Planilhas Google. Sensível
https://www.googleapis.com/auth/spreadsheets.readonly Confira todas as suas planilhas do Planilhas Google. Sensível
https://www.googleapis.com/auth/drive.file Ver, editar, criar e excluir somente os arquivos do Google Drive que você usa com este app. Recomendado
Não sensível
https://www.googleapis.com/auth/drive Acessar, editar, criar e excluir todos os seus arquivos do Google Drive. Restrito
https://www.googleapis.com/auth/drive.readonly Acessar e fazer o download de todos os seus arquivos do Google Drive. Restrito

A coluna "Usage" na tabela indica a sensibilidade de cada escopo, de acordo com as seguintes definições:

  • Não sensível: esses escopos fornecem o menor escopo de acesso de autorização e exigem apenas a verificação básica do app. Para saber mais sobre esse requisito, consulte Enviar seu app para verificação.

  • Sensível: esses escopos fornecem acesso a dados específicos do usuário do Google autorizados pelo usuário para o app. É necessário passar por uma verificação adicional do app. Para informações sobre esse requisito, consulte Requisitos de escopo sensível e restrito.

  • Restrito: esses escopos oferecem amplo acesso aos dados de usuário do Google e exigem que você passe por um processo de verificação de escopo restrito. Para informações sobre esse requisito, consulte a Política de dados do usuário dos serviços de API do Google e os Requisitos adicionais para escopos específicos da API. Se você armazenar dados de escopo restrito em servidores (ou transmitir), será necessário fazer uma avaliação de segurança.

Se o app exigir acesso a outras APIs do Google, você também poderá adicionar esses escopos. Para mais informações sobre os escopos das APIs do Google, consulte Como usar o OAuth 2.0 para acessar as APIs do Google.

Para mais informações sobre escopos específicos do OAuth 2.0, consulte Escopos do OAuth 2.0 para APIs do Google.