Cercare le etichette

La tua organizzazione può avere più etichette, che hanno più campi. L'API Etichette fornisce labels per attivare lettura delle etichette.

In questa pagina viene descritto come cercare e recuperare le etichette.

Metodi

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

Ottieni etichetta in base al nome della risorsa

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

Il nome risorsa dell'etichetta è obbligatorio e può essere strutturato come segue:

• labels/{id} o labels/{id}@latest: riceve l'ultima revisione dell'etichetta.
• labels/{id}@published: ottiene la revisione corrente dell'etichetta pubblicata.
• labels/{id}@{revisionId}: ottiene l'etichetta all'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.

In questo esempio viene utilizzato 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);
});

Elenco di tutte le etichette

Per ottenere un elenco di etichette, utilizza la labels.list.

Devi inoltre specificare:

• Un customer per definire questo ambito a cui inviare una richiesta di elenco. Se il criterio customer non viene configurato, tutte le etichette all'interno dell'attuale al cliente.

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

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