Visão geral da API Drive Labels

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 compatível com processos empresariais anexando metadados aos arquivos do Drive. Os usos comuns dessa API são:

  • Classifique o conteúdo para seguir uma estratégia de governança da informação: crie um rótulo para identificar conteúdo ou dados confidenciais que exigem tratamento especial. Por exemplo, é possível criar um rótulo com selo (um rótulo com valores de opção codificados por cores) intitulado "Sensibilidade" com os valores "Confidencial", "Confidencial" e "Público".

  • Aplicar políticas 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 organização. Por exemplo, use rótulos para gerenciar uma política de perda de dados (DLP, na sigla em inglês) em que os arquivos com o rótulo "Sensibilidade" definido como "Confidencial" não podem ser baixados para um computador.

  • Selecionar e encontrar arquivos: crie rótulos para aumentar o potencial de pesquisa do conteúdo da empresa, permitindo que as pessoas na organização encontrem itens com base nos rótulos e nos campos. Por exemplo, alguém na sua organização pode usar as opções de pesquisa do Drive para encontrar todos os contratos que aguardam assinatura 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 marcadores para arquivos. Eles são compostos de:

Nome do rótulo
O nome de recurso do rótulo. O ID do rótulo constitui parte do nome do rótulo. Dependendo da solicitação, o nome estará no formato: labels/{id} ou labels/{id}@{revisionId}. Para mais informações, consulte Revisão de rótulo abaixo.
ID do rótulo
Um identificador globalmente exclusivo do rótulo. O ID compõe parte do nome do rótulo, mas, diferentemente do nome, é consistente entre as revisões.

Há dois estilos de rótulos:

Marcador com selo

Um rótulo com um tipo de campo SelectionOptions contendo opções que podem ser codificadas por cores para indicar a importância. Para fazer isso, defina badgeConfig usando o Properties de um Choice.

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 do arquivo. Por exemplo, a opção "Confidencial" para o rótulo com selo "Sensibilidade" pode ser exibida em vermelho. Você só pode ter um marcador com selo por vez.

Marcador padrão

Um rótulo que contém zero ou mais tipos de campo. Um rótulo padrão pode ter um título de rótulo, como "Projeto Moonshot", e indicar todos os arquivos relacionados ao projeto. Um rótulo padrão também pode ter vários campos estruturados. Por exemplo, um rótulo com o título "Contrato" pode conter os campos "Empresa", "Data de vencimento", "Status" e "Signatários". Cada campo é de um tipo específico (texto, data, seleção ou usuário).

Diagrama de rótulos com selo.
Figura 1. Marcador com selo
Diagrama de rótulos padrão.
Figura 2. marcador padrão
Campo

Um componente individual digitado e configurável de um rótulo. Um rótulo pode ter zero ou mais campos associados a ele.

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 o usuário e os campos 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 marcadores de propriedade do administrador, você precisa ser um administrador da conta com o privilégio Gerenciar rótulos.

Os administradores podem compartilhar marcadores de administrador com qualquer usuário para permitir que ele veja e aplique esses marcadores aos itens do Drive. A modificação ou leitura de valores de marcadores 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 marcador, ele precisa ter os níveis de permissão adequados:

    • Item do Google Drive: EDITOR
    • Rótulo: APPLIER

  • Leitura: para ler ou pesquisar os metadados do item do Drive relacionados a um determinado marcador, o usuário precisa ter os níveis de permissão adequados:

    • Item do Google Drive: READER
    • Rótulo: READER
Shared

Usuários que não são administradores podem criar marcadores compartilhados que outras pessoas podem aplicar aos itens do Drive. As equipes podem criar e organizar os próprios rótulos para uso dentro da equipe sem precisar de um administrador.

Taxonomia dos rótulos

Os campos de marcadores configurados atualmente disponíveis para os usuários de apps para arquivos do Drive. Também conhecido como esquema de rótulos.

Exemplos de taxonomias de rótulos:

  • Sensibilidade: vermelho, laranja, amarelo, verde
  • Status: não iniciado, rascunho, em análise ou final
  • Tipo de conteúdo: contrato, documento de design, modelo
  • Departamento: marketing, finanças, recursos humanos, vendas
Ciclo de vida do rótulo

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 de rótulo é incrementada. Para mais informações, consulte Ciclo de vida do rótulo.

Revisão do rótulo

Uma instância do rótulo. Sempre que um rótulo é criado, atualizado, publicado ou descontinuado, a revisão dele é incrementada.

Revisão do 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 de rascunho, sem afetar a revisão publicada. Com a possibilidade de ter rótulos de rascunho, é possível testar as atualizações deles 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 atualmente disponível para os usuários.