Actualiza una etiqueta

Puedes actualizar una sola etiqueta aplicando un conjunto de solicitudes de actualización que generen una nueva revisión de borrador. Por ejemplo, puedes actualizar una propiedad existente de la etiqueta (la descripción de la etiqueta) o agregar un nuevo Field a la etiqueta.

La actualización de etiquetas actúa como una actualización por lotes, ya que el método toma una lista de objetos Request de actualización. Realiza actualizaciones según el mismo orden especificado en la solicitud por lotes. Las actualizaciones en la actualización por lotes se aplican de forma atómica. Es decir, si alguna solicitud del lote no se realiza correctamente, toda la actualización falla y no se aplica ninguno de los cambios (que podrían ser dependientes). La etiqueta no se modifica.

Si la actualización se realiza correctamente, se debe publicar la revisión del borrador resultante antes de que los cambios se puedan usar con cualquier elemento de Drive.

Actualiza objetos de etiquetas

Una etiqueta incluye muchos otros tipos de objetos que se pueden actualizar, como los siguientes:

• Propiedades de la etiqueta
• Campos y tipos de campos
• Opciones de selección y propiedades de las opciones de selección

Estos son algunos de los muchos objetos que controlan la apariencia y el funcionamiento de una etiqueta.

Categorías de operación

Las siguientes operaciones admitidas por el método labels.delta se pueden agrupar en las siguientes categorías generales:

Categoría	Descripción
Crear	Agregar objetos
Actualiza	Actualiza ciertas propiedades de un objeto.
Habilitar	Habilita objetos.
Inhabilitar	Inhabilita objetos.
Borrar	Quita objetos.

Estas categorías se usan en la siguiente sección para describir el comportamiento de operaciones específicas.

Solicitudes de actualización

El método labels.delta funciona tomando uno o más objetos Request, cada uno de los cuales especifica un solo tipo de solicitud para realizar. Hay muchos tipos diferentes de solicitudes. A continuación, se presenta un desglose de los tipos de solicitudes, agrupados en diferentes categorías.

Tipo de solicitud
Propiedades de la etiqueta	Actualiza UpdateLabelPropertiesRequest
Campo	Crear CreateFieldRequest Actualiza UpdateFieldPropertiesRequest UpdateFieldTypeRequest Habilitar EnableFieldRequest Inhabilitar DisableFieldRequest Borrar DeleteFieldRequest
Opción de selección	Crear CreateSelectionChoiceRequest Actualiza UpdateSelectionChoicePropertiesRequest Habilitar EnableSelectionChoiceRequest Inhabilitar DisableSelectionChoiceRequest Borrar DeleteSelectionChoiceRequest

Máscaras de campo

Muchas de las solicitudes de tipo "Actualizar" y "Inhabilitar" requieren un FieldMask. Es una lista de campos delimitada por comas que deseas actualizar y dejar los demás campos sin cambios. La máscara es obligatoria para garantizar que solo se actualicen los campos que deseas editar. Debes especificar al menos un campo.

Una máscara de campo de * se trata como un comodín y es una abreviatura para especificar cada campo en un mensaje. La sintaxis de comodín puede producir resultados no deseados, ya que un campo podría volver a su estado predeterminado si no especificas un valor para él en la solicitud de actualización. En el caso de las aplicaciones de producción, siempre enumera los campos específicos que se actualizan en las máscaras de campo y evita usar comodines de *.

Ejemplo

Para actualizar una etiqueta, usa el método delta en la colección labels.

También debes especificar lo siguiente:

• useAdminAccess es true para usar las credenciales de administrador del usuario. El servidor verifica que el usuario sea administrador de la etiqueta antes de permitir el acceso.

• Un Request que especifica las actualizaciones aplicables a la etiqueta.

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

• Uno o más Field

• 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.

• LabelView es LABEL_VIEW_FULL para establecer la vista de recursos que se aplica a las respuestas de etiquetas. LABEL_VIEW_FULL devuelve todos los campos posibles.

En este ejemplo, se usa ID para actualizar la etiqueta correcta.

Python

body = {
'use_admin_access': True,
'requests': [{
  'update_label': {
    'properties': {
      'title': 'TITLE'
    },
    'update_mask': {
      'paths': ['title']
    }
  },
}, {
  'create_field': {
    'field': {
      'properties': {
        'display_name': 'DISPLAY_NAME'
      },
      'text_options': {}
    }
  }
}],
'view': 'LABEL_VIEW_FULL'
}
response = service.labels().delta(
  body=body,
  name='labels/ID').execute()

Node.js

var body = {
  'use_admin_access': true,
  'requests': [{
    'update_label': {
      'properties': {
        'title': 'TITLE'
      },
      'update_mask': {
        'paths': ['title']
      }
    },
  }, {
    'create_field': {
      'field': {
        'properties': {
          'display_name': 'DISPLAY_NAME'
        },
        'text_options': {}
      }
    }
  }],
  'view': 'LABEL_VIEW_FULL'
};
service.labels.delta({
  'resource': body,
  'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Se actualiza la etiqueta, el campo o la opción, se incrementa el ID de revisión de la etiqueta y se almacena la etiqueta en una base de datos como etiqueta de borrador. La etiqueta tiene el State de PUBLISHED con hasUnpublishedChanges=true, lo que significa que hay cambios en borrador, pero no están disponibles para los usuarios. La etiqueta actualizada debe ser PUBLISHED antes de que los usuarios puedan ver los cambios. Para obtener más información, consulta Ciclo de vida de las etiquetas.