Crea y publica un sello discográfico

En este documento, se describe cómo crear y publicar etiquetas con la API de Google Drive Labels.

Cómo crear una etiqueta

Para crear una etiqueta, usa el create método en el labels recurso. De manera opcional, las etiquetas pueden contener uno o más Field objetos.

También debes especificar lo siguiente:

  • Un LabelType objeto.

  • Un title de etiqueta a través del Properties objeto.

  • El parámetro de consulta useAdminAccess se establece en true para usar las credenciales de administrador del usuario. Antes de permitir el acceso, el servidor verifica que el usuario tenga los privilegios de administrador de Manage Classification Labels necesarios.

En el siguiente ejemplo de código, se muestra cómo usar el método create para crear una etiqueta de administrador estándar con un título especificado y un SelectionOptions Field con dos Choice objetos.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Reemplaza lo siguiente:

  • TITLE: El título de la etiqueta.
  • DISPLAY_NAME: El nombre visible del campo.
  • CHOICE_1: La primera opción en el campo SelectionOptions.
  • CHOICE_2: La segunda opción en el SelectionOptions campo.

La etiqueta se crea en el State UNPUBLISHED_DRAFT. La etiqueta debe ser PUBLISHED para que los usuarios la vean y la usen en los archivos. 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

Trabaja con campos en etiquetas

En la siguiente tabla, se describen los tipos de campos que puedes agregar a una etiqueta, cómo interactúan los usuarios con ellos y sus consideraciones y límites de formato:

Field Type Qué pueden hacer los usuarios Consideraciones y límites de formato
SelectionOptions Selecciona 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 configura en ListOptions
IntegerOptions Ingresa un valor numérico. Solo se admiten números enteros.
DateOptions Selecciona una fecha del calendario. (Opcional) El DateFormat se puede establecer en "Largo: Mes DD, AAAA" o "Corto: MM/DD/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 se configura en ListOptions

Publica una etiqueta

La API de Drive Labels te permite publicar una etiqueta de borrador una vez que esté completa. Luego, la etiqueta será visible para los usuarios y se podrá aplicar a los archivos.

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

  • Un recurso labels que representa cada etiqueta. Contiene un recurso name y un id, que es un identificador único global para la etiqueta.

  • El parámetro de consulta useAdminAccess se establece en true para usar las credenciales de administrador del usuario. Antes de permitir el acceso, el servidor verifica que el usuario tenga los privilegios de administrador de Manage Classification Labels necesarios.

En el siguiente ejemplo de código, se muestra cómo usar el id de la etiqueta para identificar y publicar la etiqueta correcta.

Python

service.labels().publish(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Reemplaza ID por el ID de la etiqueta que deseas publicar.

Una vez que se publica la etiqueta, esta se mueve al PUBLISHED State y se incrementa el ID de revisión de la etiqueta. Luego, la etiqueta será 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 cuando se publican etiquetas

Cuando te prepares para publicar etiquetas, ten en cuenta estas restricciones:

  • Una vez publicada, 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 se publica una etiqueta, se crea una revisión recién publicada. Se borran todas las revisiones de borrador anteriores. Las revisiones publicadas anteriormente se conservan, pero están sujetas a eliminación automática según sea necesario.

  • Una vez publicada, ya no se permiten algunos cambios. Por lo general, esto significa que se rechaza cualquier cambio que invalide o active nuevas restricciones en los metadatos existentes relacionados con la etiqueta. 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 cambia el Field.FieldType.
    • Las actualizaciones de las opciones de validación de Field rechazan algo que se aceptó anteriormente.
    • Una reducción en las entradas máximas.