Votre organisation peut utiliser plusieurs libellés, les libellés comportant plusieurs champs.
L'API Libellés 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 d'étiquette, chacune ayant une tâche spécifique en tête:
Plage | Lecture |
---|---|
Étiquette unique par nom de ressource | labels.get |
Toutes les étiquettes | labels.list |
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}
oulabels/{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
est défini surLABEL_VIEW_FULL
pour définir la vue des ressources appliquée aux réponses de 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.
Python
# 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()
Node.js
# 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 méthode labels.list
.
Vous devez également spécifier les éléments suivants:
Un élément
customer
au niveau duquel cette requête de liste doit être définie. Sicustomer
n'est pas défini, toutes les étiquettes du client actuel sont renvoyées.LabelView
est défini surLABEL_VIEW_FULL
pour définir la vue des ressources appliquée aux réponses de libellé.LABEL_VIEW_FULL
renvoie tous les champs possibles.
Cet exemple utilise CUSTOMER
pour récupérer la liste des étiquettes.
Python
response = service.labels().list(
customer='customers/CUSTOMER', view='LABEL_VIEW_FULL').execute()
Node.js
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');
}
});