Criar e publicar um rótulo

Nesta página, descrevemos como criar e publicar um rótulo.

Criar um marcador

Para criar um rótulo, use o método create na coleção labels. Os rótulos podem conter um ou mais Fields (opcional).

Você também precisa especificar:

• Uma LabelType.

• Um rótulo title usando o método property.

• useAdminAccess é true para usar as credenciais de administrador do usuário. O servidor verifica se o usuário é um administrador com o privilégio "Gerenciar marcadores" antes de permitir o acesso.

Este exemplo cria um rótulo padrão de administrador com um título especificado e um SelectionOptions Field com dois Choices.

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

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

O rótulo é criado no State do UNPUBLISHED_DRAFT. Ele precisa ser PUBLISHED para uso em arquivos e ficar visível para os usuários. 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
• Rótulos aplicados pelo usuário por arquivo: 5

Como trabalhar com campos em marcadores

Field Type	O que os usuários podem fazer	Considerações sobre formato e limites
SelectionOptions	Selecionar 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	Selecionar uma data na agenda	(Opcional) Date format 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 Labels, é possível publicar um marcador de rascunho quando ele estiver pronto.

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

• Um recurso de rótulo que representa todos os rótulos. Ele contém um recurso Name e ID, que é um identificador globalmente exclusivo do rótulo.

• useAdminAccess é true para usar as credenciais de administrador do usuário. O servidor verifica se o usuário é um administrador com o privilégio "Gerenciar marcadores" antes de permitir o acesso.

Neste exemplo, usamos o ID para identificar e publicar o rótulo correto.

Python

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

Node.js

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

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

Restrições ao publicar rótulos

• 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.

• Publicar 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 à exclusão automática conforme necessário.

• Depois de publicado, não é mais possível fazer algumas mudanças. 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 e depois excluído.
  • O Field.FieldType é alterado.
  • As atualizações nas opções de validação de campo rejeitam algo que foi aceito anteriormente.
  • Uma redução no número máximo de entradas.