Escolher escopos da API Google Drive

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

Configurar OAuth 2.0 para autorização

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

Escopos da API do Drive

Para definir o nível de acesso concedido ao app, você precisa 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: dos usuários Dados da Conta do Google.

Quando o app é instalado, o usuário precisa validar os escopos utilizados pelo app. Geralmente, você deve escolher o escopo mais restrito possível e evite solicitar escopos que não são necessários para seu aplicativo. Mais usuários conceder acesso prontamente a escopos limitados e claramente descritos.

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

A API Drive é compatível com os seguintes escopos:

Código do escopo Descrição Uso
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.appfolder		 Visualize e gerencie os dados de configuração do próprio aplicativo em seu Google Drive. Recomendado
Não confidencial
https://www.googleapis.com/auth/drive.install Permitir que apps apareçam como uma opção na seção "Abrir com" ou em "Novo", . Recomendado
Não confidencial
https://www.googleapis.com/auth/drive.file Crie novos arquivos do Drive ou modifique arquivos existentes que você abra com um app ou que o usuário compartilhe com um app usando a API Google Picker ou o seletor de arquivos do app. Recomendado
Não confidencial
https://www.googleapis.com/auth/drive.apps.readonly Visualize os aplicativos autorizados a acessar seu Google Drive. Sensível
https://www.googleapis.com/auth/drive Visualize e gerencie 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 Drive; Restrito
https://www.googleapis.com/auth/drive.activity Veja e adicione itens ao registro de atividades dos arquivos no seu Drive. Restrito
https://www.googleapis.com/auth/drive.activity.readonly Veja o registro de atividades dos arquivos no seu Drive. Restrito
https://www.googleapis.com/auth/drive.meet.readonly Acessar os arquivos do Drive criados ou editados pelo Google Meet. Restrito
https://www.googleapis.com/auth/drive.metadata Veja e gerencie metadados de arquivos em seu Google Drive. Restrito
https://www.googleapis.com/auth/drive.metadata.readonly Veja metadados de arquivos no seu Drive. Restrito
https://www.googleapis.com/auth/drive.scripts Modificar seus scripts do Google Apps Script do seu modelo. 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 e exige apenas uma verificação básica de apps. Para informações sobre esse requisito, consulte Verificação .

  • Recomendado / confidencial: esses escopos dão acesso a recursos Dados do usuário autorizados pelo usuário para seu app. É necessário que você vá com a verificação adicional de apps. Para informações sobre esse requisito, consulte Escopo sensível e restrito Requisitos.

  • Restrito: esses escopos dão amplo acesso aos dados do usuário do Google. exigem que você passe por um processo de verificação de escopo restrito. Para informações sobre esse requisito, consulte Dados do usuário dos serviços de API do Google política e requisitos adicionais para APIs específicas Escopos. Se você armazenar ou transmitir dados de escopo restrito em servidores, será preciso passar por uma avaliação de segurança.

Caso seu app exija acesso a outras APIs do Google, adicione esses escopos . Para mais informações sobre os escopos da API do Google, consulte 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 o app prossiga pelo OAuth Central de Ajuda de verificação de apps. Leia as Perguntas frequentes sobre o app OAuth para determinar quando seu app deve passar pela verificação e que tipo de e a verificação é obrigatória. Consulte também os Termos de Serviço.

Quando usar um escopo restrito

No Drive, apenas os tipos de app a seguir podem acessar escopos restritos:

  1. Apps específicos da plataforma e da Web que fornecem sincronização local ou backup automático de usuários Arquivos do Google Drive.
  2. Aplicativos educacionais e de produtividade cuja interface do usuário pode envolver com arquivos do Drive (ou com metadados ou ). Os aplicativos de produtividade incluem gerenciamento de tarefas, comunicação em grupo de trabalho e aplicativos de colaboração em sala de aula.
  3. Aplicativos de relatórios e segurança que fornecem insights do usuário ou do cliente sobre como os arquivos são compartilhados ou acessados.

Para continuar usando escopos restritos, prepare seu app para escopo de verificação.

Migrar um app atual de escopos restritos

Se você tiver desenvolvido um aplicativo do Google Drive usando os , recomendamos migrar seu aplicativo para usar um escopo não confidencial, concede escopo de acesso por arquivo e restringe o acesso a recursos específicos necessários para de um app. Muitos apps funcionam com acesso por arquivo sem nenhuma alteração. Se você usa seu próprio seletor de arquivos, recomendamos mudar para a API Google Picker, que completa oferece suporte a diferentes escopos.

Benefícios do escopo drive.file do OAuth

O uso do escopo drive.file do OAuth e da API Google Picker otimiza a experiência do usuário e segurança para seu app.

O escopo do OAuth drive.file permite que os usuários escolham quais arquivos querem compartilhar. com seu app. Isso dá a eles mais controle e a confiança de que o acesso aos arquivos deles é limitado e mais seguro. Por outro lado, exigir ampla o acesso a todos os arquivos do Drive pode desencorajar a interação dos usuários com seu app. Confira alguns motivos para usar drive.file escopo:

  • Usabilidade: o escopo drive.file funciona com todas as APIs Drive Recursos REST, o que significa que é possível usá-los da mesma forma que escopos OAuth mais amplos.

  • Recursos: a API Google Picker fornece uma interface similar à Interface do Drive. Isso inclui várias visualizações que mostram visualizações e miniaturas dos arquivos do Drive e uma janela modal inline para que os usuários nunca saem do app principal.

  • Conveniência: os apps podem aplicar filtros em determinadas páginas do Google Drive. tipos de arquivo (como Documentos, Planilhas e Fotos do Google) quando usando um filtro no Google Picker arquivos.

Além disso, como drive.file não é sensível, ele permite uma interface o processo de verificação.

Salvar tokens de atualização

Salve tokens de atualização em um armazenamento seguro e de longo prazo e continue a usá-los como desde que permaneçam válidas.