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 el método create en la colección labels. Las etiquetas pueden contener, de manera opcional, uno o más Fields.

También debes especificar lo siguiente:

  • Un LabelType.

  • Una etiqueta title a través del método property

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

En este ejemplo, se crea una etiqueta de administrador estándar con un título especificado y un objeto SelectionOptions Field con 2 objetos 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 usar en archivos y ser visible para los usuarios. Para obtener más información, consulta Ciclo de vida de las etiquetas.

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

Cómo trabajar 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, según se configuró en ListOptions.
IntegerOptions Ingresa un valor numérico Solo se admiten números enteros.
DateOptions Selecciona una fecha del calendario (Opcional) Date format se puede establecer en “Larga: mes DD, AAAA” o “Corta: MM/DD/AA”.
TextOptions Ingresa texto en un cuadro de texto Se admite una cantidad máxima de 100 caracteres.
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 de 10, según la configuración en ListOptions.

Publica una etiqueta

La API de Labels te permite publicar una etiqueta en borrador una vez que esté completa.

Para publicar una etiqueta, usa el método publish y especifica lo siguiente:

  • Es un recurso Label que representa cada etiqueta. Contiene un recurso 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 servidor verifica que el usuario sea administrador con el privilegio "Administrar etiquetas" 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 se incrementa el ID de revisión de la etiqueta. Luego, la etiqueta estará visible para los usuarios y se podrá aplicar a los archivos. Para obtener más información, consulta Ciclo de vida de las etiquetas.

Restricciones al publicar etiquetas

  • Una vez que se publica, una etiqueta no puede volver a su estado de borrador original. Para obtener más información, consulta Ciclo de vida de las etiquetas.

  • Cuando publicas una etiqueta, se crea una revisión recién publicada. Se borran todas las revisiones anteriores del borrador. Se conservan las revisiones publicadas anteriormente, pero están sujetas a eliminación automática según sea necesario.

  • Una vez que se publican, ya no se permiten algunos cambios. En general, esto significa que se rechaza cualquier cambio que invalide o active nuevas restricciones en los metadatos existentes relacionados con el sello discográfico. Por ejemplo, no se permiten los siguientes cambios en una etiqueta después de que se publica:

    • La etiqueta se borra directamente. (Primero se debe inhabilitar y, luego, borrar).
    • Se cambió el Field.FieldType.
    • Las actualizaciones de las opciones de validación de campos rechazan algo que antes se aceptaba.
    • Se redujo la cantidad máxima de entradas.