Rechercher des libellés

Votre organisation peut avoir plusieurs libellés, chacun comportant plusieurs champs. L'API Labels fournit la collection labels pour permettre la lecture des libellés.

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 de libellé, chacune étant associée à une tâche spécifique :

Obtenir un libellé par nom de ressource

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

Un nom de ressource d'étiquette est obligatoire et peut être structuré comme suit :

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

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

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

Cet exemple utilise Name pour obtenir un seul libellé par 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 éléments suivants :

• customer pour définir le champ d'application de cette requête de liste. Si customer n'est pas défini, tous les libellés du client actuel sont renvoyés.

• LabelView est défini sur LABEL_VIEW_FULL pour définir la vue des ressources appliquée aux réponses des 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');
  }
});