Tu organización puede tener varias etiquetas, y estas pueden tener varios campos.
La API de Labels proporciona la
labels
para habilitar la
lectura de etiquetas.
En esta página, se describe cómo buscar y recuperar etiquetas.
Métodos
La colección labels
proporciona lo siguiente:
siguientes métodos para leer los valores de las etiquetas, cada uno con una tarea específica en mente:
Rango | Lectura |
---|---|
Etiqueta única por nombre de recurso | labels.get |
Todas las etiquetas | labels.list |
Obtener etiqueta por nombre de recurso
Para obtener una sola etiqueta por su nombre de recurso, usa la
labels.get
.
El nombre del recurso de etiqueta es obligatorio y se puede estructurar de la siguiente manera:
labels/{id}
olabels/{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
esLABEL_VIEW_FULL
para configurar la vista de recursos aplicada a las respuestas de etiquetas.LABEL_VIEW_FULL
muestra 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);
});
Enumerar todas las etiquetas
Para obtener una lista de etiquetas, usa el
labels.list
.
También debes especificar lo siguiente:
Un
customer
para determinar el alcance a la solicitud de lista. Si no establecescustomer
, todas las etiquetas dentro de la actual y se devuelvan los clientes.LabelView
esLABEL_VIEW_FULL
para configurar la vista de recursos aplicada a las respuestas de etiquetas.LABEL_VIEW_FULL
muestra 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');
}
});