Criar e publicar um rótulo

Nesta página, descrevemos como criar e publicar um marcador.

Criar um marcador

Para criar um marcador, use o método create na labels. Os marcadores podem podem conter uma ou mais Fields

Você também deve especificar:

• Uma LabelType.

• Use um rótulo title pela property.

• useAdminAccess está true para usar as credenciais de administrador do usuário. A verifica se o usuário é um administrador com a opção "Gerenciar marcadores" privilégio antes de permitir o acesso.

Este exemplo cria um marcador de administrador padrão com um título especificado e outro SelectionOptions Field com 2 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 UNPUBLISHED_DRAFT State. Precisa ser PUBLISHED. para uso em arquivos e para ficar visível aos usuários. Para mais informações, consulte Rótulo de desenvolvimento de software.

Limites de marcadores

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

• Marcadores padrão: 150
• Campos por marcador: 10
• Marcadores aplicados pelo usuário por arquivo: 5

Como trabalhar com campos em rótulos

Field Type	O que os usuários podem fazer	Considerações e limites de formato
SelectionOptions	Selecione uma ou mais opções em uma lista	O número máximo de opções aceitas é 200 O número máximo de seleções para um arquivo é 10, conforme configurado em ListOptions
IntegerOptions	Insira um valor numérico	Somente números inteiros são aceitos
DateOptions	Selecione uma data	(Opcional) Date format pode ser definido como "Longo: DD do mês, AAAA" ou "Curto: DD/MM/AA"
TextOptions	Insira o texto 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 depois que ele for concluído.

Para publicar um marcador, use o publish e especifique:

• um recurso de rótulo; que representa cada rótulo. Ele contém os recursos Name e ID, que é um identificador globalmente exclusivo do rótulo.

• useAdminAccess está true para usar as credenciais de administrador do usuário. A verifica se o usuário é um administrador com a opção "Gerenciar marcadores" privilégio antes de permitir o acesso.

Este exemplo usa 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 é movido para a PUBLISHED State e a revisão do rótulo ID foi incrementado. O marcador fica visível para os usuários e pode ser aplicado a . Para mais informações, consulte Rótulo de desenvolvimento de software.

Restrições ao publicar rótulos

• Depois de publicado, o 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. Todo o rascunho anterior e revisões serão excluídas. As revisões publicadas anteriormente são mantidas, sujeitos à exclusão automática, conforme necessário.

• Depois de publicadas, algumas mudanças não são mais permitidas. Geralmente, isso significa qualquer mudança que invalide ou acione novas restrições em metadados relacionados ao rótulo são rejeitados. Por exemplo, o seguinte não são permitidas alterações em um marcador depois que ele é publicado:

  • O marcador é excluído diretamente. (Ela deve ser desativada primeiro, deleted.)
  • O Field.FieldType mudou.
  • As atualizações nas opções de validação de campo rejeitam um aspecto anterior aceita.
  • Redução no número máximo de entradas.