Cercare le etichette

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

Questa pagina descrive come cercare e recuperare le etichette.

Metodi

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

Ottenere l'etichetta per nome risorsa

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

È necessario un nome 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 inoltre specificare:

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

Questo esempio utilizza Name per ottenere una singola etichetta in base al nome della risorsa.

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

Elencare tutte le etichette

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

Devi inoltre specificare:

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

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

Questo esempio utilizza CUSTOMER per recuperare l'elenco delle etichette.

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