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 create método na labels coleção. Os marcadores podem conter um ou mais Fields.

Você também precisa especificar:

• Um LabelType.

• Um title de marcador usando o property método.

• 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 marcador de administrador padrão com um título especificado e um SelectionOptions Field com duas 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 marcador é criado no UNPUBLISHED_DRAFT State. Ele precisa ser PUBLISHED para uso em arquivos e para ficar visível aos usuários. Para mais informações, consulte Ciclo de vida do marcador.

Limites de marcadores

Os limites a seguir se aplicam ao criar e aplicar marcadores:

• Marcadores padrão: 150
• Campos por marcador: 10
• Marcadores 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	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 do calendário	(Opcional) Date format pode ser definido como "Long: Month DD, YYYY" ou "Short: MM/DD/YY"
TextOptions	Insira texto em uma caixa de texto	O número máximo de caracteres aceitos é 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

A API Labels permite publicar um marcador de rascunho quando ele estiver concluído.

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

• Um recurso de marcador que representa cada marcador. Ele contém um Name e um ID de recurso, que é um identificador globalmente exclusivo do marcador.

• 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 usa o ID para identificar e publicar o marcador 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 PUBLISHED State e o ID de revisão do marcador é incrementado. O marcador fica visível aos usuários e pode ser aplicado a arquivos. Para mais informações, consulte Ciclo de vida do marcador.

Restrições ao publicar marcadores

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

• A publicação de um marcador 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 automatizada conforme necessário.

• Depois de publicado, algumas mudanças não são mais permitidas. Geralmente, isso significa que qualquer mudança que invalide ou acione novas restrições nos metadados atuais relacionados ao marcador é rejeitada. Por exemplo, as seguintes mudanças em um marcador não são permitidas depois que ele é publicado:

  • O marcador é excluído diretamente. Ele precisa ser desativado primeiro 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 nas entradas máximas.