Buscar etiquetas

Tu organización puede tener varias etiquetas, y estas pueden tener varios campos. La API de Google Drive Labels proporciona el labels recurso para permitir la lectura de etiquetas.

En este documento, se describe cómo buscar y recuperar etiquetas con la API de Drive Labels.

Métodos

El recurso labels proporciona los siguientes métodos para leer valores de etiquetas, cada uno con una tarea específica en mente:

Obtén una etiqueta por nombre de recurso

Para obtener una sola etiqueta por su nombre de recurso, usa el get método en el labels recurso.

Se requiere un recurso de etiqueta name y se puede estructurar de la siguiente manera:

• labels/{id} o labels/{id}@latest: Obtiene la revisión de etiqueta más reciente.
• labels/{id}@published: Obtiene la revisión de etiqueta publicada actual.
• labels/{id}@{revisionId}: Obtiene la etiqueta en el ID de revisión especificado.

Debes especificar un LabelView objeto como LABEL_VIEW_FULL para establecer una vista de recursos que se aplique a las respuestas de etiquetas. LABEL_VIEW_FULL muestra todos los campos posibles.

En la siguiente muestra de código, se indica cómo usar el name de la etiqueta para obtener una sola etiqueta por su nombre de recurso:

# Label name, with or without revision:
#
# Revision specified:
# labels/LABEL_ID@published
# labels/LABEL_ID@latest
# labels/LABEL_ID@1
#
# No revision specified, returns latest revision:
# labels/LABEL_ID
name = 'labels/NAME@published'

# Label view controls level of data in response
view = 'LABEL_VIEW_FULL'

label = service.labels().get(
    name=name,
    view=view
).execute()

// Label name, with or without revision:
//
// Revision specified:
// labels/LABEL_ID@published
// labels/LABEL_ID@latest
// labels/LABEL_ID@1
//
// No revision specified, returns latest revision:
// labels/LABEL_ID
const name = 'labels/NAME@published';

// Label view controls level of data in response
const view = 'LABEL_VIEW_FULL';

service.labels.get({
  name: name,
  view: view
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Reemplaza NAME por el nombre de la etiqueta.

Muestra todas las etiquetas

Para obtener una lista de etiquetas, usa el list método en el labels recurso.

También debes especificar lo siguiente:

• Un parámetro de consulta customer para definir el alcance de esta solicitud de lista. Si no se establece customer, se muestran todas las etiquetas del cliente actual.

• Un objeto LabelView como LABEL_VIEW_FULL para establecer una vista de recursos que se aplique a las respuestas de etiquetas. LABEL_VIEW_FULL muestra todos los campos posibles.

En la siguiente muestra de código, se indica cómo usar el parámetro de consulta customer para obtener una lista de etiquetas:

response = service.labels().list(
    customer='customers/CUSTOMER',
    view='LABEL_VIEW_FULL'
).execute()

const params = {
  customer: 'customers/CUSTOMER',
  view: 'LABEL_VIEW_FULL'
};

service.labels.list(params, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  const labels = res.data.labels;
  if (labels) {
    labels.forEach((label) => {
      const name = label.name;
      const title = label.properties.title;
      console.log(`${name}\t${title}`);
    });
  } else {
    console.log('No Labels');
  }
});

Reemplaza CUSTOMER por el nombre del cliente.