Os marcadores são metadados que você define para ajudar os usuários a organizar, encontrar e aplicar políticas aos arquivos no Google Drive. A API Drive Labels é uma API RESTful que oferece suporte a processos de negócios anexando metadados aos seus arquivos do Drive. Os usos comuns para essa API são:
Classifique o conteúdo de acordo com uma estratégia de governança da informação: crie um marcador para identificar conteúdo ou dados sensíveis que exigem tratamento especial. Por exemplo, você pode criar um marcador com selo (um marcador com valores de opção codificados por cores) com o título "Sensibilidade" e os valores "Top Secret", "Confidencial" e "Público".
Aplicar a política a itens no Drive: crie marcadores para gerenciar o conteúdo do Drive durante todo o ciclo de vida e garantir que ele siga as práticas de manutenção de registros da sua organização. Por exemplo, use marcadores para gerenciar uma política de prevenção contra perda de dados (DLP, na sigla em inglês), em que arquivos com um marcador de "Sensibilidade" definido como "Top Secret" não podem ser transferidos para um computador.
Selecionar e encontrar arquivos: crie marcadores para aumentar a capacidade de pesquisa do conteúdo da empresa, permitindo que as pessoas na sua organização encontrem itens com base em marcadores e campos. Por exemplo, alguém na sua organização pode usar as opções de pesquisa do Drive para encontrar todos os contratos que precisam ser assinados até uma data específica.
Confira abaixo uma lista de termos comuns usados na API Drive Labels:
- Rótulo
Metadados estruturados colocados em um arquivo do Drive. Os usuários do Drive podem atribuir marcadores e definir valores de campo de marcador para arquivos. Os rótulos são compostos por:
- Nome do rótulo
- : o nome do recurso do rótulo. O ID do rótulo faz parte do
nome do rótulo. Dependendo da solicitação, o nome está no formato:
labels/{id}
oulabels/{id}@{revisionId}
. Para mais informações, consulte Revisão de rótulos abaixo. - ID do rótulo
- Um identificador globalmente exclusivo para o rótulo. O ID faz parte do nome do rótulo, mas, ao contrário do nome, é consistente entre as revisões.
Há dois estilos de rótulos:
- Marcador com selo
Um marcador com um tipo de campo
SelectionOptions
que contém opções que podem ser codificadas por cores para indicar importância. Isso é feito definindobadgeConfig
peloProperties
de umChoice
.O Drive mostra a cor da opção escolhida para cada arquivo para que os usuários entendam claramente o status, a classificação e assim por diante. Por exemplo, a opção "Top Secret" para o marcador de selo "Sensibilidade" pode aparecer em vermelho. Você só pode ter um rótulo com selo por vez.
- Rótulo padrão
Um identificador que contém zero ou mais tipos de campo. Um rótulo padrão pode ter um título, como "Projeto Moonshot", e indicar todos os arquivos relacionados ao projeto. Um marcador padrão também pode ter vários campos estruturados. Por exemplo, um marcador com o título "Contrato" pode conter os campos "Empresa", "Data de conclusão", "Status" e "Assinantes". Cada campo é de um tipo específico (texto, data, seleção ou usuário).
- Campo
Um componente individual de um rótulo, tipado e configurável. Um marcador pode ter zero ou mais campos associados.
- Tipo de campo
- O tipo de dados do valor associado ao campo. Configurável como
texto, número inteiro, data, usuário ou seleção. Se você configurar o campo com
ListOptions
, poderá definir os campos de usuário e de seleção com vários valores. O tipo escolhido afeta os valores válidos aplicáveis aos itens do Drive e as opções de consulta de pesquisa disponíveis.
- Escolha
Uma das várias opções que um usuário pode escolher em um campo
SelectionOptions
.- Tipo de rótulo
Todos os rótulos incluem um
LabelType
. Há dois tipos de rótulos:- Administrador
Para criar e editar rótulos de administradores, você precisa ser um administrador de conta com o privilégio Gerenciar rótulos.
Os administradores podem compartilhar marcadores de administrador com qualquer usuário para conceder a ele a capacidade de visualizar e aplicar os marcadores aos itens do Drive. A modificação ou leitura de valores de rótulo em itens do Drive requer as seguintes permissões:
Modificação: para que um usuário modifique os metadados do item do Drive relacionados a um determinado rótulo, ele precisa ter os níveis de permissão adequados:
- Item do Drive:
EDITOR
- Rótulo:
APPLIER
- Item do Drive:
Leitura: para que um usuário leia ou pesquise os metadados do item do Drive relacionados a um determinado rótulo, ele precisa ter os níveis de permissão adequados:
- Item do Drive:
READER
- Rótulo:
READER
- Item do Drive:
Usuários que não são administradores podem criar marcadores compartilhados que outras pessoas podem aplicar a itens do Drive. As equipes podem criar e organizar os próprios rótulos para uso na equipe sem precisar de um administrador.
- Taxonomia de rótulos
Os campos de rótulo configurados atualmente disponíveis para os usuários aplicarem aos arquivos do Drive. Também conhecido como esquema de rótulo.
Exemplos de taxonomias de rótulos:
- Sensibilidade: vermelho, laranja, amarelo, verde
- Status: "Não iniciado", "Rascunho", "Em análise", "Final"
- Tipo de conteúdo: contrato, documento de design, modelo
- Departamento: marketing, finanças, recursos humanos, vendas
- Ciclo de vida do marcador
Os rótulos passam por um ciclo de vida em que são criados, publicados, atualizados e assim por diante. À medida que um rótulo passa pelo ciclo de vida, a revisão do rótulo é incrementada. Para mais informações, consulte Ciclo de vida do rótulo.
- Revisão de rótulos
Uma instância do rótulo. Sempre que um rótulo é criado, atualizado, publicado ou descontinuado, a revisão do rótulo é incrementada.
- Revisão de rascunho
- O número da revisão da instância de rascunho atual do rótulo. É possível fazer várias atualizações em um rótulo, cada uma incrementando o número de revisão do rascunho, sem afetar a revisão publicada. A capacidade de ter rascunhos de rótulos permite testar as atualizações antes da publicação.
- Revisão publicada
- O número da revisão da versão publicada de um rótulo. O rótulo publicado é a instância do rótulo disponível para os usuários.
Temas relacionados
Para saber mais sobre o desenvolvimento com as APIs do Google Workspace, incluindo o processamento de autenticação e autorização, consulte Começar a usar o Google Workspace como desenvolvedor.
Para saber como configurar e executar um app simples da API Labels, tente o guia de início rápido do Python.