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 do OAuth e escolha escopos para definir quais informações são mostradas aos usuários e revisores de apps, além de registrar seu app para poder publicá-lo mais tarde.

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, o tipo de dados que ele acessa e o nível de acesso. Os escopos são 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. Em geral, escolha o escopo mais restrito possível e evite solicitar escopos que o app não exige. Os usuários concedem acesso mais facilmente 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 para um app.

A API Docs oferece suporte aos seguintes escopos:

Código do escopo Descrição Uso
https://www.googleapis.com/auth/documents Ver, editar, criar e excluir todos os documentos do Google Docs. Sensível
https://www.googleapis.com/auth/documents.readonly Ver todos os documentos do Google Docs. Sensível
https://www.googleapis.com/auth/drive.file Ver, editar, criar e excluir apenas os arquivos específicos do Google Drive que você usa com esse app. Recomendado
Não sensível
https://www.googleapis.com/auth/drive Ver, editar, criar e excluir todos os arquivos do Google Drive. Restrito
https://www.googleapis.com/auth/drive.readonly Ver e fazer o download de todos os 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 sensível: esses escopos fornecem o menor escopo de acesso de autorização e exigem apenas a verificação de apps básica. Para mais informações sobre esse requisito, consulte Enviar o 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 mais informações sobre esse requisito, consulte Requisitos de escopo sensível e restrito.

  • Restrito: esses escopos fornecem acesso amplo aos dados do usuário do Google e exigem que você passe por um processo de verificação de escopo restrito. Para mais informações sobre esse requisito, consulte Política de dados do usuário dos serviços da API do Google e Requisitos adicionais dos 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 precisar de acesso a outras APIs do Google, você também poderá 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.