Visão geral da API Drive Labels

Os rótulos 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 ao anexar metadados aos seus arquivos do Drive. Os usos comuns dessa API são:

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

  • Aplicar 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 organização. Por exemplo, use rótulos para gerenciar uma política de perda de dados (DLP) em que não é possível fazer o download de um arquivo com o rótulo "Confidencial" definido como "Confidencial".

  • Selecionar e encontrar arquivos: crie marcadores para aumentar a possibilidade de pesquisa do conteúdo da sua empresa. Assim, as pessoas na sua organização poderão encontrar itens com base nos marcadores 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 estejam aguardando a assinatura até uma data específica.

Veja abaixo uma lista de termos comuns usados na API Drive Labels:

Etiqueta

Metadados estruturados armazenados em um arquivo do Drive. Os usuários do Drive podem atribuir marcadores e definir valores de campo de marcador nos arquivos. Os marcadores 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 tem o formato: labels/{id} ou labels/{id}@{revisionId}. Para mais informações, consulte Revisão do rótulo abaixo.
ID do rótulo
Um identificador exclusivo global 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 rótulo com um tipo de campo SelectionOptions que contém opções que podem ser codificados por cores para indicar a importância. Isso é feito ao configurar badgeConfig com o Properties de um Choice.

O Drive mostra a cor da opção escolhida para cada arquivo para que os usuários compreendam claramente o status, a classificação e assim por diante. Por exemplo, a opção "Ultrassecreto" para o selo com selo "Sensibilidade" pode ser exibida em vermelho. Você só pode ter uma etiqueta com selo.

Rótulo 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 "Project 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 conclusão", "Status" e "Signatários". Cada campo é de um tipo específico (texto, data, seleção ou usuário).

Diagrama do rótulo com selo.
Figura 1. Marcador com selo
Diagrama de rótulo padrão.
Figura 2. Rótulo padrão
Campo

Um componente de tipo individual 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. Ao configurar o campo com ListOptions, é possível definir os campos de usuário e 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 identificadores:

Administrador

Para criar e editar rótulos 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 itens aos itens do Drive. A modificação ou leitura dos valores de marcadores nos itens do Drive exige as seguintes permissões:

  • Modificação: para modificar os metadados de itens do Drive relacionados a um determinado rótulo, o usuário precisa ter os níveis de permissão adequados:

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

  • Leitura: para que um usuário leia ou pesquise os metadados do item do Drive relacionados a um determinado rótulo, o usuário precisa ter os níveis de permissão adequados:

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

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 seus próprios rótulos para uso dentro da equipe sem exigir um administrador.

taxonomia de rótulos

Os campos de marcador configurados atualmente disponíveis para usuários dos aplicativos Drive para arquivos. Também conhecido como esquema de identificador.

Exemplos de taxonomias:

  • Sensibilidade: vermelho, laranja, amarelo e 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 e 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 do rótulo é incrementada. Para mais informações, consulte Ciclo de vida dos rótulos.

Revisão do rótulo

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 rascunho de revisão, sem afetar a revisão publicada. A possibilidade de ter rótulos de rascunho permite testar as atualizações de rótulos antes da publicação.
Revisão publicada
O número de 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.