Labels suchen

Ihre Organisation kann mehrere Labels haben, die wiederum mehrere Felder enthalten. 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 diese 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

Wenn Sie ein einzelnes Label anhand seines Ressourcennamens abrufen möchten, verwenden Sie die Methode labels.get.

Ein Labelressourcenname ist erforderlich und kann so strukturiert sein:

• labels/{id} oder labels/{id}@latest: Hiermit wird die neueste Labelversion abgerufen.
• labels/{id}@published: Die aktuell veröffentlichte Labelversion wird abgerufen.
• 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 Antwortlabels 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

Eine Liste der Labels erhalten Sie mit der Methode labels.list.

Außerdem müssen Sie Folgendes angeben:

• Eine customer, auf die sich diese Listenanfrage beziehen soll. Wenn customer nicht festgelegt ist, werden alle Labels für den aktuellen Kunden zurückgegeben.

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

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