Cercare le etichette

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

Questa pagina descrive come cercare e recuperare le etichette.

Metodi

La raccolta labels fornisce i seguenti metodi per leggere i valori delle etichette, ognuno con un'attività specifica in mente:

Intervallo Lettura
Etichetta singola per nome risorsa labels.get
Tutte le etichette labels.list

Ottenere l'etichetta in base al nome della risorsa

Per ottenere una singola etichetta dal nome della risorsa, utilizza il metodo labels.get.

È necessario un nome della risorsa dell'etichetta, che può essere strutturato come segue:

  • labels/{id} o labels/{id}@latest: recupera la revisione più recente dell'etichetta.
  • labels/{id}@published: recupera la revisione dell'etichetta pubblicata corrente.
  • labels/{id}@{revisionId}: recupera l'etichetta associata all'ID revisione specificato.

Devi anche specificare:

  • LabelView è LABEL_VIEW_FULL per impostare la visualizzazione Risorse applicata alle risposte alle etichette. LABEL_VIEW_FULL restituisce tutti i campi possibili.

Questo esempio utilizza Name per ottenere una singola etichetta in base al nome della 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

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

Elenca tutte le etichette

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

Devi anche specificare:

  • Un customer a cui applicare l'ambito della richiesta di inclusione nella lista. Se customer non è impostato, vengono restituite tutte le etichette del cliente corrente.

  • LabelView è LABEL_VIEW_FULL per impostare la visualizzazione Risorse applicata alle risposte alle etichette. LABEL_VIEW_FULL restituisce tutti i campi possibili.

In questo esempio viene utilizzato CUSTOMER per recuperare l'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');
  }
});