Labels suchen

Ihre Organisation kann mehrere Labels haben, die wiederum mehrere Felder enthalten. Die Labels API stellt die labels Sammlung zur Verfügung, mit der die Labels gelesen werden können.

Auf dieser Seite wird beschrieben, wie Sie nach Labels suchen und sie abrufen.

Methoden

Die labels Sammlung bietet die folgenden Methoden zum Lesen von Labelwerten, wobei jede Methode eine bestimmte Aufgabe erfüllt:

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

Label nach Ressourcennamen abrufen

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

Ein Label-Ressourcenname ist erforderlich und kann so strukturiert sein:

  • labels/{id} oder labels/{id}@latest: Ruft die letzte Label-Überarbeitung ab.
  • labels/{id}@published: Ruft die aktuelle veröffentlichte Label-Überarbeitung ab.
  • labels/{id}@{revisionId}: Ruft das Label mit der angegebenen Überarbeitungs-ID ab.

Außerdem müssen Sie Folgendes angeben:

  • LabelView ist LABEL_VIEW_FULL, um die Ressourcenansicht festzulegen, die auf Label-Antworten 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

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

Außerdem müssen Sie Folgendes angeben:

  • Ein customer, um diese Listenanfrage einzugrenzen. Wenn customer nicht festgelegt ist, werden alle Labels des aktuellen Kunden zurückgegeben.

  • LabelView ist LABEL_VIEW_FULL, um die Ressourcenansicht festzulegen, die auf Label-Antworten angewendet wird. LABEL_VIEW_FULL gibt alle möglichen Felder zurück.

In diesem Beispiel wird CUSTOMER verwendet, um die Label-Liste 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');
  }
});