Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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 dessa API são:
Classificar conteúdo para seguir uma estratégia de governança da informação: crie um
marcador para identificar conteúdo sensível ou dados que exijam tratamento especial.
Por exemplo, você pode criar um marcador com selo (um marcador com valores de opção codificados por cores) chamado "Sensibilidade" com os valores "Ultrassecreto", "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 sua organização. Por exemplo, use marcadores para gerenciar uma política de prevenção contra perda de dados (DLP) em que arquivos com um marcador "Sensibilidade" definido como "Ultrassecreto" não podem ser baixados para um computador.
Selecionar e encontrar arquivos: crie marcadores para aumentar a capacidade de pesquisa do conteúdo da sua empresa. Assim, as pessoas na organização podem encontrar 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:
Metadados estruturados colocados em um arquivo do Drive.
Os usuários do Drive podem atribuir marcadores e definir valores de campo para arquivos. Os rótulos são compostos por:
Nome do rótulo
O nome do recurso do rótulo. O ID do marcador faz parte do
nome do marcador. Dependendo da solicitação, o nome está no formato:
labels/{id} ou labels/{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, ele é 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 definindo
badgeConfig
pelo
Properties de um
Choice.
O Drive mostra a cor da opção escolhida para cada arquivo. Assim, os usuários entendem claramente o status, a classificação e outras informações.
Por exemplo, a opção "Confidencial" do marcador com selo "Sensibilidade"
pode aparecer em vermelho. Só é possível ter um marcador com selo por vez.
Marcador padrão
Um rótulo que contém zero ou mais tipos de campo. Um marcador 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 "Signatários". Cada campo é de um tipo específico (texto, data, seleção ou usuário).
Um componente individual tipado e definível de um rótulo. Um marcador 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 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.
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 marcadores.
Os administradores podem compartilhar marcadores de administrador com qualquer usuário para conceder a ele a capacidade de visualizar e aplicar esses marcadores a itens do Drive. Para modificar ou ler valores de rótulos em itens do Drive, são necessárias 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
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
Shared
Os usuários que não são administradores podem criar marcadores compartilhados para que outras pessoas apliquem
a itens do Drive. As equipes podem criar e organizar seus próprios rótulos para uso
interno sem precisar de um administrador.
Taxonomia de rótulos
Os campos de marcador 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 marcador:
Sensibilidade: vermelho, laranja, amarelo, verde
Status: não iniciado, rascunho, em análise, final
Tipo de conteúdo: contrato, documento de design, modelo
Os marcadores 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
da revisão do rascunho, sem afetar a revisão publicada. Com os
marcadores de rascunho, você pode testar as atualizações antes de publicar.
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.
[null,null,["Última atualização 2025-08-29 UTC."],[],[],null,["# Drive Labels API overview\n\n*Labels* are metadata that you define to help users organize, find, and apply\npolicy to files in Google Drive. The Drive Labels API is a RESTful API that\nsupports business processes by attaching metadata to your Drive\nfiles. Common uses for this API are:\n\n- **Classify content to follow an information governance strategy**---Create a\n label to identify sensitive content or data that requires special handling.\n For example, you might create a badged label (a label with color-coded\n option values) titled \"Sensitivity\" with the values of \"Top Secret,\"\n \"Confidential,\" and \"Public.\"\n\n- **Apply policy to items in Drive**---Create labels to manage\n Drive content throughout its lifecycle and ensure it adheres\n to your organization's record keeping practices. For example, use labels to\n manage a data loss policy (DLP) whereby files with a \"Sensitivity\" label set\n to \"Top Secret\" can't be downloaded to a computer.\n\n- **Curate and find files**---Create labels to increase searchability of your\n company's content by letting people in your organization find items based on\n labels and their fields. For example, someone in your organization could use\n Drive search options to find all contracts awaiting signature\n by a specific date.\n\nBelow is a list of common terms used in the Drive Labels API:\n\n[*Label*](/workspace/drive/labels/reference/rest/v2/labels#resource:-label)\n\n: Structured metadata placed on a Drive file.\n Drive users can assign labels and set label field values for\n files. Labels are composed of:\n\n *Label name*\n : The resource name of the label. The *label ID* makes up part of the\n Label name. Depending on the request, the name is in the form of either:\n `labels/{id}` or `labels/{id}@{revisionId}`. For more information, see\n [Label revision](#revision) below.\n\n *Label ID*\n : A globally unique identifier for the label. The ID makes up part of the\n label name, but unlike the name, it's consistent between revisions.\n\n There are 2 styles of labels:\n\n *Badged label*\n\n : A label with a\n [`SelectionOptions`](/workspace/drive/labels/reference/rest/v2/labels#selectionoptions)\n field type containing *choices* that can be color-coded to indicate\n importance. This is done by setting\n [`badgeConfig`](/workspace/drive/labels/reference/rest/v2/labels#BadgeConfig)\n through the\n [`Properties`](/workspace/drive/labels/reference/rest/v2/labels#properties_1) of a\n [`Choice`](/workspace/drive/labels/reference/rest/v2/labels#choice).\n\n Drive displays the color of the chosen option for each file so users\n clearly understand the status, classification, and so on, of the file.\n For example, the \"Top Secret\" option for the \"Sensitivity\" badged label\n might display in red. You can only have one badged label at a time.\n\n *Standard label*\n\n : A label containing zero or more *field type*s. A standard label might\n have a label title, such as \"Project Moonshot,\" and indicate all files\n related to the project. A standard label might also have several\n structured fields. For example, a label with the title \"Contract\" might\n contain the fields for \"Company,\" \"Due Date,\" \"Status,\" and\n \"Signatories.\" Each field is of a specific type (text, date,\n selection, or user).\n\n|----------------------------|------------------------------|\n| **Figure 1.** Badged label | **Figure 2.** Standard label |\n\n[*Field*](/workspace/drive/labels/reference/rest/v2/labels#field)\n\n: An individual typed, settable component of a label. A label can have zero or\n more fields associated with it.\n\n *Field type*\n : The data type of the value associated with the *field* . Configurable as\n text, integer, date, user, or selection. If you configure the field with\n `ListOptions`, you can set the user and selection fields with multiple\n values. The type chosen impacts both the valid values applicable to\n Drive items and the search query options available.\n\n[*Choice*](/workspace/drive/labels/reference/rest/v2/labels#choice)\n\n: One of several options a user can choose from within a `SelectionOptions`\n field.\n\n[*Label type*](/workspace/drive/labels/reference/rest/v2/labels#labeltype)\n\n: All labels include a `LabelType`. There are 2 types of labels:\n\n *Admin*\n\n : To create and edit admin-owned labels, you must be an account\n administrator with the\n [Manage Labels](https://support.google.com/a/answer/1219251#drive_and_docs)\n privilege.\n\n Admins can share admin labels with any user to grant that user the\n ability to view and apply them to Drive items. Modifying or reading\n label values on Drive items requires the following permissions:\n\n - Modifying---For a user to modify the Drive item metadata related to a\n given label, the user must have the appropriate permission levels:\n\n - Drive item: `EDITOR`\n - Label: `APPLIER`\n - Reading---For a user to read or search for the Drive item metadata\n related to a given label, the user must have the appropriate\n permission levels:\n\n - Drive item: `READER`\n - Label: `READER`\n\n *Shared*\n\n : Non-administrator users can create shared labels that others can apply\n to Drive items. Teams can create and organize their own labels for use\n within the team without requiring an administrator.\n\n | **Note:** Shared labels are only available in a closed beta that isn't currently accepting new customers.\n\n*Label taxonomy*\n\n: The currently configured label fields available to users for application to\n Drive files. Also known as the label schema.\n\n Example label taxonomies:\n\n - Sensitivity---Red, Orange, Yellow, Green\n - Status---Not Started, Draft, In Review, Final\n - Content type---Contract, Design Doc, Mockup\n - Department---Marketing, Finance, Human Resources, Sales\n\n[*Label lifecycle*](/workspace/drive/labels/reference/rest/v2/labels#lifecycle)\n\n: Labels go through a lifecycle where they're created, published, updated, and\n so on. As a label makes it through the lifecycle, its *label revision* is\n incremented. For more information, see [Label lifecycle](/workspace/drive/labels/guides/label-lifecycle).\n\n*Label revision*\n\n: An instance of the label. Anytime a label is created, updated, published, or\n deprecated, the label revision increments.\n\n *Draft revision*\n : The revision number of the current draft instance of the label. You can\n make several updates to a label, each incrementing its draft revision\n number, without affecting the published revision. The ability to have\n draft labels lets you test label updates before publishing.\n\n *Published revision*\n : The revision number of the published version of a label. The published\n label is the instance of the label currently available to users.\n\nRelated topics\n--------------\n\n- To learn about developing with Google Workspace APIs, including handling\n authentication and authorization, refer to [Get started as a\n Google Workspace\n developer](/workspace/guides/getstarted-overview).\n\n- To learn how to configure and run a simple Labels API app, try the\n [Python quickstart](/workspace/drive/labels/quickstart/python)."]]
