Criar e publicar um rótulo

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

Criar um marcador

Para criar um rótulo, use o método create na coleção labels. Como opção, os rótulos podem conter um ou mais Fields.

Também é necessário especificar:

• Uma LabelType.

• Um rótulo title pelo 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 rótulos" antes de permitir o acesso.

Neste exemplo, criamos um rótulo de administrador padrão 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 UNPUBLISHED_DRAFT State. Ele precisa ser PUBLISHED para uso em arquivos e visível para os usuários. Para mais informações, consulte Ciclo de vida do rótulo.

Limites de rótulo

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	Selecionar 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	Só é possível usar números inteiros
DateOptions	Selecione uma data	(Opcional) O Date format pode ser definido como "Longo: DD/MM/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 no ListOptions.

Publicar um marcador

Com a API Labels, é possível publicar um marcador de rascunho assim que ele é concluído.

Para publicar um rótulo, use o método publish e especifique:

• Um recurso Rótulo que representa cada rótulo. 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 rótulos" antes de permitir o acesso.

Neste exemplo, o ID é usado 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 rótulo é publicado, ele é movido para o PUBLISHED State, e o ID de revisão do rótulo é incrementado. O rótulo 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 publicada, uma etiqueta não pode retornar ao estado de rascunho original. Para mais informações, consulte Ciclo de vida do rótulo.

• Publicar um marcador cria uma revisão recém-publicada. Todas as revisões de rascunho anterior são excluídas. As revisões publicadas anteriormente são mantidas, mas estão sujeitas a exclusão automática conforme necessário.

• Após a publicação, algumas mudanças não serão mais permitidas. Geralmente, isso significa que qualquer alteração que invalide ou acione novas restrições sobre metadados existentes relacionados ao rótulo será rejeitada. Por exemplo, as seguintes mudanças em um rótulo não são permitidas após a publicação dele:

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