Cercare le etichette

La tua organizzazione può avere più etichette, ognuna con diversi campi. L'API Google Drive Labels fornisce la labels risorsa per consentire la lettura delle etichette.

Questo documento descrive come cercare e recuperare le etichette utilizzando l'API Drive Labels.

Metodi

La risorsa labels fornisce i seguenti metodi per la lettura dei valori delle etichette, ognuno con un'attività specifica in mente:

Intervallo Metodo
Singola etichetta per nome risorsa labels.get
Tutte le etichette labels.list

Recuperare un'etichetta in base al nome risorsa

Per recuperare una singola etichetta in base al nome risorsa, utilizza il get metodo sulla labels risorsa.

È necessario un name della risorsa etichetta, che può essere strutturato come segue:

  • labels/{id} o labels/{id}@latest: recupera l'ultima revisione dell'etichetta.
  • labels/{id}@published: recupera la revisione dell'etichetta pubblicata corrente.
  • labels/{id}@{revisionId}: recupera l'etichetta con l'ID revisione specificato.

Devi specificare un LabelView oggetto come LABEL_VIEW_FULL per impostare una visualizzazione delle risorse applicata alle risposte delle etichette. LABEL_VIEW_FULL restituisce tutti i campi possibili.

Il seguente esempio di codice mostra come utilizzare il name dell'etichetta per recuperare una singola etichetta in base al nome risorsa:

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

Sostituisci NAME con il nome dell'etichetta.

Elencare tutte le etichette

Per ottenere un elenco di etichette, utilizza il list metodo sulla labels risorsa.

Devi anche specificare:

  • Un customer parametro di query a cui limitare questa richiesta di elenco. Se customer non è impostato, vengono restituite tutte le etichette del cliente corrente.

  • Un oggetto LabelView come LABEL_VIEW_FULL per impostare una visualizzazione delle risorse applicata alle risposte delle etichette. LABEL_VIEW_FULL restituisce tutti i campi possibili.

Il seguente esempio di codice mostra come utilizzare il parametro di query customer per ottenere un elenco di etichette:

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

Sostituisci CUSTOMER con il nome del cliente.