Buscar etiquetas

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

En esta página, se describe cómo buscar y recuperar etiquetas.

Métodos

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

Rango Lectura
Una sola etiqueta por nombre de recurso labels.get
Todas las etiquetas labels.list

Obtén la etiqueta por nombre de recurso

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

Se requiere un nombre de recurso de etiqueta 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 la etiqueta publicada actual.
  • labels/{id}@{revisionId}: Obtiene la etiqueta en el ID de revisión especificado.

También debes especificar lo siguiente:

  • 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 Name para obtener una sola etiqueta por su nombre de recurso.

Python

# 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()

Node.js

# 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'

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

Enumera todas las etiquetas

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

También debes especificar lo siguiente:

  • Es un customer para definir el alcance de esta solicitud de lista. Si no se establece customer, se devuelven todas las etiquetas del cliente actual.

  • 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 CUSTOMER para recuperar la lista de etiquetas.

Python

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

Node.js

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');
  }
});