Rechercher des libellés

Votre organisation peut utiliser plusieurs libellés, les libellés comportant plusieurs champs. L'API Libellés fournit la collection labels pour activer la lecture des étiquettes.

Cette page explique comment rechercher et récupérer des libellés.

Méthodes

La collection labels fournit les suivantes pour lire les valeurs d'étiquette, chacune ayant une tâche spécifique en tête:

Obtenir une étiquette par nom de ressource

Pour obtenir une seule étiquette par son nom de ressource, utilisez la méthode labels.get.

Veuillez indiquer un nom de ressource d'étiquette qui peut être structuré comme suit:

• labels/{id} ou labels/{id}@latest : récupère la dernière révision du libellé.
• labels/{id}@published : récupère la révision du libellé actuellement publiée.
• labels/{id}@{revisionId} : récupère le libellé associé à l'ID de révision spécifié.

Vous devez également spécifier les éléments suivants:

• LabelView correspond à LABEL_VIEW_FULL pour définir la vue des ressources appliquée aux réponses du libellé. LABEL_VIEW_FULL renvoie tous les champs possibles.

Cet exemple utilise Name pour obtenir une seule étiquette en fonction de son nom de ressource.

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

Répertorier tous les libellés

Pour obtenir la liste des étiquettes, utilisez la labels.list.

Vous devez également spécifier les éléments suivants:

• Un customer pour définir le champ d'application liste. Si customer n'est pas défini, tous les libellés de la valeur actuelle client sont renvoyés.

• LabelView correspond à LABEL_VIEW_FULL pour définir la vue des ressources appliquée aux réponses du libellé. LABEL_VIEW_FULL renvoie tous les champs possibles.

Cet exemple utilise CUSTOMER pour récupérer la liste des étiquettes.

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