Labels suchen

Ihre Organisation kann mehrere Labels haben, wobei Labels mehrere Felder umfassen. In der Labels API ist die Sammlung labels verfügbar, 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, wobei jede für eine bestimmte Aufgabe vorgesehen ist:

Bereich Lesen
Einzelnes Label nach Ressourcenname labels.get
Alle Labels labels.list

Label nach Ressourcenname abrufen

Verwenden Sie die Methode labels.get, um ein einzelnes Label anhand seines Ressourcennamens abzurufen.

Ein Label-Ressourcenname ist erforderlich und kann folgendermaßen strukturiert werden:

  • labels/{id} oder labels/{id}@latest: Die neueste Labelversion wird abgerufen.
  • labels/{id}@published: Ruft die aktuell veröffentlichte Labelversion ab.
  • labels/{id}@{revisionId}: Ruft das Label unter der angegebenen Überarbeitungs-ID ab.

Außerdem müssen Sie Folgendes angeben:

  • LabelView ist LABEL_VIEW_FULL, um die Ressourcenansicht für Labelantworten festzulegen. 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

Verwenden Sie die Methode labels.list, um eine Liste der Labels abzurufen.

Außerdem müssen Sie Folgendes angeben:

  • Ein customer, auf das diese Listenanfrage beschränkt werden soll. Wenn customer nicht festgelegt ist, werden alle Labels innerhalb des aktuellen Kunden zurückgegeben.

  • LabelView ist LABEL_VIEW_FULL, um die Ressourcenansicht für Labelantworten festzulegen. LABEL_VIEW_FULL gibt alle möglichen Felder zurück.

In diesem Beispiel wird die Labelliste mit CUSTOMER abgerufen.

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