Cómo crear y publicar una etiqueta

En esta página, se describe cómo crear y publicar una etiqueta.

Cómo crear una etiqueta

Para crear una etiqueta, usa create en la labels colección. Las etiquetas pueden contienen, de manera opcional, uno o más Fields

También debes especificar lo siguiente:

• Un LabelType.

• Una etiqueta title a través de la property.

• useAdminAccess es true para usar las credenciales de administrador del usuario. El el servidor verifica que el usuario sea un administrador mediante el botón "Administrar etiquetas" privilegio antes de permitir el acceso.

En este ejemplo, se crea una etiqueta de administrador estándar con un título específico y una SelectionOptions Field con 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);
});

La etiqueta se crea en UNPUBLISHED_DRAFT. State Debe ser PUBLISHED para usarse en archivos y ser visible para los usuarios. Para obtener más información, consulta Etiqueta ciclo de vida.

Límites de etiquetas

Se aplican los siguientes límites cuando se crean y aplican etiquetas:

• Etiquetas estándar: 150
• Campos por etiqueta: 10
• Etiquetas aplicadas por el usuario por archivo: 5

Trabaja con campos en etiquetas

Field Type	Qué pueden hacer los usuarios	Consideraciones y límites de formato
SelectionOptions	Seleccionar una o más opciones de una lista	La cantidad máxima de opciones admitidas es 200 La cantidad máxima de selecciones para un archivo es 10 como se configuró en ListOptions
IntegerOptions	Ingresa un valor numérico	Solo se admiten números enteros
DateOptions	Selecciona una fecha de calendario	(Opcional) Date format se puede configurar como “Largo: DD/mes AAAA” o “Corto: DD/MM/AA”
TextOptions	Ingresa texto en un cuadro de texto	La cantidad máxima de caracteres admitida es 100
UserOptions	Selecciona uno o más usuarios de los contactos de Google Workspace.	La cantidad máxima de entradas de usuario para un archivo es 10 como se configuró en ListOptions

Publicar una etiqueta

La API de Labels te permite publicar un borrador de etiqueta una vez que se completa.

Para publicar una etiqueta, usa publish y especifica lo siguiente:

• Un recurso de etiqueta que representa cada etiqueta. Contiene los recursos Name y ID, que es un identificador único a nivel global para la etiqueta.

• useAdminAccess es true para usar las credenciales de administrador del usuario. El el servidor verifica que el usuario sea un administrador mediante el botón "Administrar etiquetas" privilegio antes de permitir el acceso.

En este ejemplo, se usa ID para identificar y publicar la etiqueta correcta.

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);
});

Una vez que se publica la etiqueta, esta se mueve a PUBLISHED State y la revisión de la etiqueta Se incrementa el ID. De esta forma, la etiqueta queda visible para los usuarios y se puede aplicar archivos. Para obtener más información, consulta Etiqueta ciclo de vida.

Restricciones de la publicación de etiquetas

• Una vez publicada, una etiqueta no puede volver a su estado de borrador original. Para ver más consulta Ciclo de vida de las etiquetas.

• Cuando publicas una etiqueta, se crea una revisión publicada recientemente. Todos los borradores anteriores se borran las revisiones. Las revisiones publicadas anteriormente se conservan, sujetos a eliminación automática según sea necesario.

• Una vez publicados, ya no se permiten algunos cambios. Por lo general, esto significa cualquier cambio que invalide o active restricciones nuevas en se rechazan los metadatos relacionados con la etiqueta. Por ejemplo, los siguientes Una vez que se publica una etiqueta, no se permiten cambios en ella:

  • La etiqueta se borra directamente. (Primero se debe inhabilitar y, luego, deleted.)
  • Se cambió Field.FieldType.
  • Las actualizaciones de las opciones de validación del campo rechazan una acción que se realizó anteriormente aceptada.
  • Una reducción en la cantidad máxima de entradas