Service Advanced Drive Labels

en utilisant le service avancé Libellés Drive dans Google Apps Script.

Créez et gérez des libellés pour vos fichiers et dossiers Drive avec le service avancé Libellés Google Drive. Ce service avancé vous permet d'utiliser toutes les fonctionnalités de l'API Drive Labels dans Google Apps Script.

Pour appliquer ou supprimer des libellés Drive, utilisez le service Drive avancé.

Il s'agit d'un service avancé que vous devez activer avant de l'utiliser.

Référence

Pour en savoir plus sur ce service, consultez la documentation de l'API Google Drive Labels. Comme tous les services avancés d'Apps Script, le service Drive Labels API utilise les mêmes objets, méthodes et paramètres que l'API publique.

Pour signaler des problèmes et trouver d'autres ressources d'assistance, consultez le guide d'assistance de l'API Google Drive Labels.

Exemple de code

L'exemple de code suivant utilise la version 2 de l'API.

Lister les libellés

L'exemple de code suivant montre comment obtenir la liste des libellés disponibles pour l'utilisateur qui envoie la requête.

advanced/driveLabels.gs
/**
 * List labels available to the user.
 */
function listLabels() {
  let pageToken = null;
  let labels = [];
  do {
    try {
      const response = DriveLabels.Labels.list({
        publishedOnly: true,
        pageToken: pageToken,
      });
      pageToken = response.nextPageToken;
      labels = labels.concat(response.labels);
    } catch (err) {
      // TODO (developer) - Handle exception
      console.log("Failed to list labels with error %s", err.message);
    }
  } while (pageToken != null);

  console.log("Found %d labels", labels.length);
}

Obtenir un libellé

L'exemple de code suivant montre comment obtenir un libellé unique à l'aide de son nom de ressource (qui correspond à la valeur de chaîne du libellé). Pour trouver le nom d'un libellé, obtenez la liste des libellés via l'API ou utilisez le gestionnaire de libellés Drive. Pour en savoir plus sur le gestionnaire de libellés, consultez Gérer les libellés Drive.

advanced/driveLabels.gs
/**
 * Get a label by name.
 * @param {string} labelName The label name.
 */
function getLabel(labelName) {
  try {
    const label = DriveLabels.Labels.get(labelName, {
      view: "LABEL_VIEW_FULL",
    });
    const title = label.properties.title;
    const fieldsLength = label.fields.length;
    console.log(
      `Fetched label with title: '${title}' and ${fieldsLength} fields.`,
    );
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed to get label with error %s", err.message);
  }
}

Lister les libellés d'un élément Drive

L'exemple de code suivant montre comment obtenir un élément Drive et lister tous les libellés qui lui sont appliqués.

advanced/driveLabels.gs
/**
 * List Labels on a Drive Item
 * Fetches a Drive Item and prints all applied values along with their to their
 * human-readable names.
 *
 * @param {string} fileId The Drive File ID
 */
function listLabelsOnDriveItem(fileId) {
  try {
    const appliedLabels = Drive.Files.listLabels(fileId);

    console.log(
      "%d label(s) are applied to this file",
      appliedLabels.labels.length,
    );

    for (const appliedLabel of appliedLabels.labels) {
      // Resource name of the label at the applied revision.
      const labelName = `labels/${appliedLabel.id}@${appliedLabel.revisionId}`;

      console.log("Fetching Label: %s", labelName);
      const label = DriveLabels.Labels.get(labelName, {
        view: "LABEL_VIEW_FULL",
      });

      console.log("Label Title: %s", label.properties.title);

      for (const fieldId of Object.keys(appliedLabel.fields)) {
        const fieldValue = appliedLabel.fields[fieldId];
        const field = label.fields.find((f) => f.id === fieldId);

        console.log(
          `Field ID: ${field.id}, Display Name: ${field.properties.displayName}`,
        );
        switch (fieldValue.valueType) {
          case "text":
            console.log("Text: %s", fieldValue.text[0]);
            break;
          case "integer":
            console.log("Integer: %d", fieldValue.integer[0]);
            break;
          case "dateString":
            console.log("Date: %s", fieldValue.dateString[0]);
            break;
          case "user": {
            const user = fieldValue.user
              .map((user) => {
                return `${user.emailAddress}: ${user.displayName}`;
              })
              .join(", ");
            console.log(`User: ${user}`);
            break;
          }
          case "selection": {
            const choices = fieldValue.selection.map((choiceId) => {
              return field.selectionOptions.choices.find(
                (choice) => choice.id === choiceId,
              );
            });
            const selection = choices
              .map((choice) => {
                return `${choice.id}: ${choice.properties.displayName}`;
              })
              .join(", ");
            console.log(`Selection: ${selection}`);
            break;
          }
          default:
            console.log("Unknown: %s", fieldValue.valueType);
            console.log(fieldValue.value);
        }
      }
    }
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed with error %s", err.message);
  }
}