Labels suchen

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

In diesem Dokument wird beschrieben, wie Sie mit der Drive Labels API nach Labels suchen und sie abrufen.

Methoden

Die Ressource labels bietet die folgenden Methoden zum Lesen von Labelwerten, die jeweils eine bestimmte Aufgabe erfüllen:

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

Label nach Ressourcennamen abrufen

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

Ein Labelressourcen-name ist erforderlich und kann so strukturiert sein:

  • labels/{id} oder labels/{id}@latest: Ruft die neueste 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.

Sie müssen ein LabelView-Objekt als LABEL_VIEW_FULL angeben, um eine Ressourcenansicht festzulegen, die auf Labelantworten angewendet wird. LABEL_VIEW_FULL gibt alle möglichen Felder zurück.

Das folgende Codebeispiel zeigt, wie Sie mit dem name des Labels ein einzelnes Label anhand seines Ressourcennamens abrufen:

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
const name = 'labels/NAME@published';

// Label view controls level of data in response
const 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);
});

Ersetzen Sie NAME durch den Namen des Labels.

Alle Labels auflisten

Verwenden Sie die list Methode für die labels Ressource, um eine Liste von Labels abzurufen.

Außerdem müssen Sie Folgendes angeben:

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

  • Ein LabelView Objekt als LABEL_VIEW_FULL, um eine Ressourcenansicht festzulegen, die auf Label Antworten angewendet wird. LABEL_VIEW_FULL gibt alle möglichen Felder zurück.

Das folgende Codebeispiel zeigt, wie Sie den Abfrageparameter customer verwenden, um eine Liste von Labels 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');
  }
});

Ersetzen Sie CUSTOMER durch den Namen des Kunden.