Este documento contém informações de autorização e autenticação específicas da API. Antes de ler este documento, leia as informações gerais de autenticação e autorização em Desenvolver no Google Workspace.
De quais escopos o app precisa?
Quando o app é instalado, o usuário precisa validar os escopos usados pelo app. Geralmente, é necessário escolher o escopo mais restrito possível e evitar a solicitação de escopos não exigidos pelo app. Os usuários concedem mais acesso a escopos limitados e claramente descritos.
Quando possível, recomendamos o uso de escopos não confidenciais, porque ele concede escopo de acesso por arquivo e restringe o acesso a funcionalidades específicas necessárias para um app.
Escopos do Google Drive
A API Drive é compatível com os seguintes escopos:
| Código do escopo | Descrição | Uso |
|---|---|---|
https://www.googleapis.com/auth/drive.appdata |
Ver e gerenciar os dados de configuração do próprio app no Google Drive. | Recomendado Não sensível |
https://www.googleapis.com/auth/drive.install |
Permitir que os apps sejam exibidos como opção no menu "Abrir com" ou "Novo" | Recomendado Não sensível |
https://www.googleapis.com/auth/drive.file |
Ver e gerenciar arquivos e pastas do Google Drive que você abre ou cria com um aplicativo. | Recomendado Não sensível |
https://www.googleapis.com/auth/auth/drive.apps.readonly |
Veja os apps autorizados a acessar seu Drive. | Sensível |
https://www.googleapis.com/auth/drive |
Ver e gerenciar todos os seus arquivos do Drive. | Restrito |
https://www.googleapis.com/auth/drive.metadata |
Ver e gerenciar metadados de arquivos no seu Google Drive. | Restrito |
https://www.googleapis.com/auth/drive.metadata.readonly |
Ver metadados de arquivos no seu Google Drive. | Restrito |
https://www.googleapis.com/auth/drive.readonly |
Ver e fazer o download de todos os seus arquivos do Drive. | Restrito |
https://www.googleapis.com/auth/drive.scripts |
Modifique o comportamento dos scripts do Google Apps Script. | Restrito |
A coluna "Uso" na tabela acima indica a sensibilidade de cada escopo, de acordo com as seguintes definições:
Recomendado / não confidencial: esses escopos oferecem 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 Etapas de preparação para a verificação.
Recomendados / sensíveis: esses escopos oferecem acesso a dados específicos do usuário do Google que são autorizados pelo usuário para seu app. É necessário passar por outra verificação de apps. Para ver informações sobre esse requisito, consulte Etapas para apps que solicitam escopos confidenciais
Restrito: esses escopos oferecem 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 Serviços da API do Google: Política de dados do usuário e Requisitos adicionais para escopos de API específicos. Se você armazenar dados de escopo restrito em servidores (ou transmissão), vai precisar passar por uma avaliação de segurança.
Se o app exigir acesso a qualquer outra API do Google, também será possível 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.
Verificação do OAuth
O uso de determinados escopos do OAuth pode exigir que seu app prossiga com o processo de verificação do OAuth do Google. Leia as Perguntas frequentes sobre a verificação da API OAuth para determinar quando seu app deve passar pelo processo e que tipo de verificação é necessária. Consulte também os Termos de Serviço Adicionais do Google Drive.
Quando usar um escopo restrito
No Drive, somente os seguintes tipos de aplicativo podem acessar escopos restritos:
- Apps da Web e específicos da plataforma que oferecem sincronização local ou backup automático dos arquivos do Drive dos usuários.
- Aplicativos educacionais e de produtividade em que a interface do usuário possa envolver a interação com arquivos do Drive (ou os metadados ou permissões deles). Os aplicativos de produtividade incluem gerenciamento de tarefas, anotações, comunicações em grupo de trabalho e aplicativos de colaboração em sala de aula.
- Aplicativos de relatórios e segurança que fornecem insights sobre o usuário ou o cliente sobre como os arquivos são compartilhados ou acessados.
Para continuar usando escopos restritos, prepare seu app para a verificação de escopo restrito.
Migrar um app existente de escopos restritos
Se você desenvolveu um app do Drive usando qualquer um dos escopos restritos, recomendamos migrar seu app para usar um escopo não confidencial, porque ele oferece escopo de acesso por arquivo e restringe o acesso a funcionalidades específicas necessárias para um app. Muitos apps trabalham com acesso por arquivo sem qualquer mudança. Se você estiver usando o seletor de arquivos, recomendamos mudar para a API Google Picker, que é totalmente compatível com diferentes escopos.
Salvar tokens de atualização
Salve tokens de atualização em armazenamento seguro de longo prazo e continue a usá-los, desde que permaneçam válidos.