Cómo crear y publicar una etiqueta

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

Crea una etiqueta

Para crear una etiqueta, usa el método create en la colección labels. De manera opcional, las etiquetas pueden contener 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 un 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 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 el UNPUBLISHED_DRAFT State. Debe ser PUBLISHED para poder usarse 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

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, según se configuró en ListOptions
IntegerOptions	Ingresa un valor numérico	Solo se admiten números enteros
DateOptions	Seleccionar una fecha del calendario	(Opcional) Date format se puede configurar como “Long: Month DD, YYYY” o “Short: 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, según la configuración en ListOptions

Publicar una etiqueta

La API de Labels te permite publicar el borrador de una etiqueta una vez que esté completo.

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

• Un recurso de etiqueta 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 un 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 State PUBLISHED y se incrementa el ID de revisión de la etiqueta. La etiqueta es visible para los usuarios y se puede aplicar a los archivos. Para obtener más información, consulta Ciclo de vida de las etiquetas.

Restricciones para la publicación de etiquetas

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

• Cuando se publica una etiqueta, se crea una revisión recién publicada. Se borrarán todas las revisiones en borrador anteriores. Las revisiones publicadas con anterioridad se conservan, pero están sujetas a eliminación automática según sea necesario.

• Una vez publicados, ya no se permiten algunos cambios. Por lo general, esto significa que se rechaza cualquier cambio que invalide o active restricciones nuevas sobre los metadatos existentes relacionados con la etiqueta. Por ejemplo, no se permiten los siguientes cambios en una etiqueta después de publicarla:

  • Se borrará la etiqueta directamente. (primero debe inhabilitarse y, luego, borrarse).
  • Se cambió el Field.FieldType.
  • Las actualizaciones de las opciones de validación de campos rechazan algo que se aceptó anteriormente.
  • Reducción de la cantidad máxima de entradas