Labels suchen

Ihre Organisation kann mehrere Labels mit jeweils mehreren Feldern haben. Die Labels API bietet die Sammlung labels, mit der Labels gelesen werden können.

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

Methoden

Die Sammlung labels bietet die folgenden Methoden zum Lesen von Labelwerten, die jeweils für eine bestimmte Aufgabe vorgesehen sind:

Label anhand des Ressourcennamens abrufen

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

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

• labels/{id} oder labels/{id}@latest: Ruft die letzte Label-Version ab.
• labels/{id}@published: Ruft die aktuelle veröffentlichte Label-Revision ab.
• labels/{id}@{revisionId}: Ruft das Label mit der angegebenen Revisions-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.

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

# 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, 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.

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

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