Rechercher des libellés

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

Ce document explique comment rechercher et récupérer des libellés à l'aide de l'API Drive Labels.

Méthodes

La ressource labels fournit les méthodes suivantes pour lire les valeurs de libellé, chacune ayant une tâche spécifique en tête :

Plage Méthode
Libellé unique par nom de ressource labels.get
Tous les libellés labels.list

Obtenir un libellé par nom de ressource

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

Un name de ressource de libellé est requis 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 du libellé publié actuel.
  • labels/{id}@{revisionId} : obtient le libellé à l'ID de révision spécifié.

Vous devez spécifier un LabelView objet en tant que LABEL_VIEW_FULL pour définir une vue de ressource appliquée aux réponses de libellé. LABEL_VIEW_FULL renvoie tous les champs possibles.

L'exemple de code suivant montre comment utiliser le name du libellé pour obtenir un seul libellé par 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
const name = 'labels/NAME@published';

// Label view controls level of data in response
const 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);
});

Remplacez NAME par le nom du libellé.

Répertorier tous les libellés

Pour obtenir une liste de libellés, utilisez la list méthode sur la labels ressource.

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

  • Un customer paramètre de requête pour limiter cette requête de liste. Si customer n'est pas défini, tous les libellés du client actuel sont renvoyés.

  • Un objet LabelView en tant que LABEL_VIEW_FULL pour définir une vue de ressource appliquée aux réponses de libellé. LABEL_VIEW_FULL renvoie tous les champs possibles.

L'exemple de code suivant montre comment utiliser le paramètre de requête customer pour obtenir une liste de libellés :

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

Remplacez CUSTOMER par le nom du client.