Ihre Organisation kann mehrere Labels haben, wobei Labels mehrere Felder enthalten können.
Die Labels API bietet die Sammlung labels
, damit Labels gelesen werden können.
Auf dieser Seite wird beschrieben, wie Sie Labels suchen und abrufen.
Methoden
Die Sammlung labels
bietet die folgenden Methoden zum Lesen von Labelwerten für jeweils eine bestimmte Aufgabe:
Bereich | Leseliste |
---|---|
Einzelnes Label nach Ressourcenname | labels.get |
Alle Labels | labels.list |
Label nach Ressourcenname abrufen
Mit der Methode labels.get
können Sie ein einzelnes Label anhand seines Ressourcennamens abrufen.
Der Name einer Labelressource ist erforderlich und kann so strukturiert werden:
labels/{id}
oderlabels/{id}@latest
: Ruft die neueste Labelüberarbeitung ab.labels/{id}@published
: Die aktuell veröffentlichte Labelversion wird abgerufen.labels/{id}@{revisionId}
: Das Label wird unter der angegebenen Versions-ID abgerufen.
Außerdem müssen Sie Folgendes angeben:
LabelView
istLABEL_VIEW_FULL
, um die Ressourcenansicht festzulegen, die auf Labelantworten angewendet wird.LABEL_VIEW_FULL
gibt alle möglichen Felder zurück.
In diesem Beispiel wird Name
verwendet, um ein einzelnes Label anhand seines Ressourcennamens abzurufen.
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);
});
Alle Labels auflisten
Mit der Methode labels.list
können Sie eine Liste der Labels abrufen.
Außerdem müssen Sie Folgendes angeben:
Ein
customer
, auf den die Listenanfrage beschränkt werden soll. Wenncustomer
nicht konfiguriert ist, werden alle Labels des aktuellen Kunden zurückgegeben.LabelView
istLABEL_VIEW_FULL
, um die Ressourcenansicht festzulegen, die auf Labelantworten angewendet wird.LABEL_VIEW_FULL
gibt alle möglichen Felder zurück.
In diesem Beispiel wird CUSTOMER
verwendet, um die Labelliste abzurufen.
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');
}
});