Rechercher des libellés

Votre organisation peut être associée à plusieurs libellés, qui comportent plusieurs champs. L'API Étiquettes fournit la collection labels pour permettre la lecture des étiquettes.

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

Méthodes

La collection labels fournit les méthodes suivantes pour lire les valeurs des étiquettes, chacune ayant une tâche spécifique à l'esprit:

Obtenir une étiquette par nom de ressource

Pour obtenir un seul libellé par son nom de ressource, utilisez la méthode labels.get.

Veuillez indiquer un nom de ressource de libellé. Il 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 de libellé actuellement publiée.
• labels/{id}@{revisionId} : récupère le libellé correspondant à l'ID de révision spécifié.

Vous devez également spécifier les informations suivantes:

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

Cet exemple utilise Name pour obtenir une étiquette unique à partir 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);
});

Lister tous les libellés

Pour obtenir la liste des libellés, utilisez la méthode labels.list.

Vous devez également spécifier les informations suivantes:

• Un élément customer auquel appliquer cette requête de liste. Si customer n'est pas défini, toutes les étiquettes du client actuel sont renvoyées.

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

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

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