Escolher escopos da API Google Drive Labels

Este documento contém informações de autorização e autenticação específicas da API Drive Labels. 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 serão exibidas aos usuários e revisores de apps e registre seu app para publicação posterior.

Escopos da API Google Drive Labels

Para definir o nível de acesso concedido ao app, é preciso 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 as solicitações que seu app faz para trabalhar com os dados do Google Workspace, incluindo os dados da Conta do Google dos usuários.

Quando seu 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, porque eles concedem escopo de acesso por arquivo e restringem o acesso a funcionalidades específicas necessárias para um app.

Os seguintes escopos do OAuth 2.0 podem ser usados para ler, pesquisar e modificar os metadados dos marcadores de itens do Drive:

Escopo Significado
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
Leia, pesquise e modifique metadados de marcadores aplicados a itens do Drive.
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.metadata.readonly
Ler e pesquisar metadados de marcadores aplicados aos itens do Drive autorizados para o app.

Para mais informações, consulte Escopos do OAuth 2.0 da API Drive e Autorização específica da API Drive.

Escopos dos identificadores

Os seguintes escopos OAuth podem ser usados para ver e gerenciar marcadores:

Escopo Significado
https://www.googleapis.com/auth/drive.labels Veja, use e gerencie marcadores do Google Drive.
  • Este escopo permite o acesso do usuário e é necessário para operações de gravação quando use_admin_access não está definido.
  • As operações de gravação com esse escopo são válidas para rótulos com o tipo de rótulo SHARED.
https://www.googleapis.com/auth/drive.labels.readonly ver e usar marcadores do Google Drive.
  • Este escopo permite o acesso do usuário e é necessário para operações de leitura quando use_admin_access não está definido.
https://www.googleapis.com/auth/drive.admin.labels Consultar, editar, criar e excluir todos os marcadores do Drive na sua organização, além de ver as políticas de administração relacionadas a eles.
  • Este escopo permite acesso de administrador e é necessário para operações de gravação quando use_admin_access está definido. Esse escopo também concede acesso de leitura.
  • As operações de gravação com esse escopo são válidas para rótulos com o tipo de rótulo SHARED ou ADMIN.
https://www.googleapis.com/auth/drive.admin.labels.readonly Ver todos os marcadores do Drive e as políticas de administração relacionadas a eles na sua organização.
  • Este escopo permite o acesso de administrador e é obrigatório para operações de leitura quando use_admin_access está definido.

Acesso de administrador

Para gerenciar os rótulos ADMIN, especifique:

  • useAdminAccess é true para usar as credenciais de administrador do usuário.
  • Administradores da conta com o privilégio Gerenciar marcadores.

useAdminAccess

Os administradores precisam definir o parâmetro useAdminAccess para invocar os privilégios de administrador. Com a configuração useAdminAccess, é possível ver e editar qualquer rótulo de propriedade de um cliente. Isso inclui os identificadores ADMIN e SHARED.

Quando useAdminAccess não estiver definido, as solicitações de gravação serão permitidas apenas para rótulos com um SHARED label type e para usuários com o papel EDITOR apropriado para esse rótulo.

Para mais informações, consulte Criar credenciais de acesso.