Criar e publicar um marcador

Este documento descreve como criar e publicar rótulos usando a API Google Drive Labels.

Criar um marcador

Para criar um rótulo, use o método create no recurso labels. Os rótulos podem conter um ou mais objetos Field (opcional).

Você também precisa especificar:

O exemplo de código a seguir mostra como usar o método create para criar um rótulo padrão de administrador com um título especificado e um SelectionOptions Field com dois objetos Choice.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Substitua:

  • TITLE: o título do rótulo.
  • DISPLAY_NAME: o nome de exibição do campo.
  • CHOICE_1: a primeira opção no campo SelectionOptions.
  • CHOICE_2: a segunda opção no campo SelectionOptions.

O rótulo é criado no State do UNPUBLISHED_DRAFT. O marcador precisa ser PUBLISHED para ficar visível aos usuários e ser usado em arquivos. Para mais informações, consulte Ciclo de vida do rótulo.

Limites de rótulos

Os limites a seguir se aplicam ao criar e adicionar rótulos:

  • Marcadores padrão: 150
  • Campos por rótulo: 10

Como trabalhar com campos em marcadores

A tabela a seguir descreve os tipos de campos que podem ser adicionados a um rótulo, como os usuários interagem com eles e as considerações e limites de formato:

Field Type O que os usuários podem fazer Considerações sobre formato e limites
SelectionOptions Selecione uma ou mais opções em uma lista O número máximo de opções para um campo é 200
O número máximo de seleções para um arquivo é 10, conforme configurado em ListOptions
IntegerOptions Insira um valor numérico Apenas números inteiros são aceitos
DateOptions Selecione uma data (Opcional) O DateFormat pode ser definido como "Longo: DD do mês, AAAA" ou "Curto: DD/MM/AA"
TextOptions Digitar em uma caixa de texto O número máximo de caracteres permitido é 100
UserOptions Selecione um ou mais usuários nos contatos do Google Workspace. O número máximo de entradas de usuário para um arquivo é 10, conforme configurado em ListOptions.

Publicar um marcador

Com a API Drive Labels, é possível publicar um marcador de rascunho quando ele estiver pronto. O rótulo fica visível para os usuários e pode ser aplicado aos arquivos.

Para publicar um marcador, use o método publish no recurso labels e especifique:

  • Um recurso labels que representa todos os rótulos. Ele contém um name e um id, que é um identificador globalmente exclusivo do rótulo.

  • O parâmetro de consulta useAdminAccess é definido como true para usar as credenciais de administrador do usuário. Antes de permitir o acesso, o servidor verifica se o usuário tem os privilégios de administrador Gerenciar rótulos de classificação necessários.

O exemplo de código a seguir mostra como usar o id do rótulo para identificar e publicar o rótulo correto.

Python

service.labels().publish(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Substitua ID pelo ID do rótulo a ser publicado.

Depois que o rótulo é publicado, ele passa para o estado PUBLISHED State e o ID de revisão do rótulo é incrementado. O marcador fica visível para os usuários e pode ser aplicado aos arquivos. Para mais informações, consulte Ciclo de vida do rótulo.

Restrições ao publicar rótulos

Ao se preparar para publicar rótulos, observe estas restrições:

  • Depois de publicado, um marcador não pode voltar ao estado de rascunho original. Para mais informações, consulte Ciclo de vida do rótulo.

  • A publicação de um rótulo cria uma revisão recém-publicada. Todas as revisões de rascunho anteriores são excluídas. As revisões publicadas anteriormente são mantidas, mas estão sujeitas a exclusão automática conforme necessário.

  • Depois da publicação, algumas mudanças não são mais permitidas. Em geral, isso significa que qualquer mudança que invalide ou acione novas restrições nos metadados relacionados ao rótulo será rejeitada. Por exemplo, as seguintes mudanças em um rótulo não são permitidas depois que ele é publicado:

    • O rótulo é excluído diretamente. Ele precisa ser desativado primeiro e depois excluído.
    • O Field.FieldType foi alterado.
    • As atualizações nas opções de validação de Field rejeitam algo que foi aceito anteriormente.
    • Uma redução no número máximo de entradas.