Escolher escopos da API Google Docs

Este documento contém informações de autorização e autenticação específicas da API Google Docs. 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

Configure a tela de permissão OAuth e escolha escopos para definir quais informações são mostradas aos usuários e revisores de apps e registre seu app para poder publicá-lo depois.

Escopos da API Docs

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

Quando o app é instalado, o usuário precisa validar os escopos usados pelo app. Em geral, escolha o escopo mais restrito possível e evite solicitar escopos que não são necessários para o app. Os usuários concedem acesso mais rápido a escopos limitados e claramente descritos.

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

A API Docs oferece suporte aos seguintes escopos:

Código do escopo Descrição Uso
https://www.googleapis.com/auth/documents Consultar, editar, criar e excluir todos os seus arquivos do Documentos Google. Sensível
https://www.googleapis.com/auth/documents.readonly Veja todos os seus arquivos do Documentos Google. Sensível
https://www.googleapis.com/auth/drive.file Acessar, editar, criar e excluir apenas os arquivos do Google Drive que você usa com este app. Recomendado
Não confidencial
https://www.googleapis.com/auth/drive Consultar, editar, criar e excluir todos os seus arquivos do Google Drive. Restrito
https://www.googleapis.com/auth/drive.readonly Ver e fazer o download de todos os seus arquivos do Google Drive. Restrito

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

  • Não confidencial: esses escopos fornecem o menor escopo de acesso de autorização e exigem apenas uma verificação básica de apps. Para mais informações sobre esse requisito, consulte Como enviar seu app para verificação.

  • Sensíveis: esses escopos dão acesso a dados específicos do usuário do Google autorizados pelo usuário para seu app. Isso exige que você passe por uma verificação adicional do aplicativo. Para informações sobre esse requisito, consulte Requisitos de escopo sensível e restrito.

  • Restrito: esses escopos fornecem amplo acesso aos dados do 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 passar por uma avaliação de segurança.

Se o app exigir acesso a outras APIs do Google, você também pode adicionar esses escopos. Para mais informações sobre os escopos da API 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.