ドライブラベルの高度なサービス

Google Apps Script のドライブ ラベル拡張サービスを使用する。

Google ドライブのラベルの高度なサービスを使用して、ドライブのファイルとフォルダのラベルを作成、管理します。この高度なサービスを使用すると、Google Apps Script で Drive Labels API のすべての機能を使用できます。

ドライブのラベルを適用または削除するには、高度なドライブ サービスを使用します。

これは、使用前に有効にする必要がある拡張サービスです。

リファレンス

このサービスの詳細については、Google Drive Labels API のドキュメントをご覧ください。Apps Script のすべての高度なサービスと同様に、Drive Labels API サービスでは、公開 API と同じオブジェクト、メソッド、パラメータを使用します。

問題を報告したり、その他のサポートを利用したりするには、Google Drive Labels API のサポートガイドをご覧ください。

サンプルコード

次のサンプルコードでは、API のバージョン 2 を使用しています。

ラベルを一覧表示する

次のコードサンプルは、リクエストを行うユーザーが使用できるラベルのリストを取得する方法を示しています。

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

ラベルを取得する

次のコードサンプルは、リソース名（ラベルの文字列値）で単一のラベルを取得する方法を示しています。ラベル名を確認するには、API を使用してラベルのリストを取得するか、ドライブ ラベル マネージャーを使用します。ラベル マネージャーについて詳しくは、ドライブのラベルを管理するをご覧ください。

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

ドライブ アイテムのラベルを一覧表示する

次のコードサンプルは、ドライブ アイテムを取得し、そのアイテムに適用されているすべてのラベルを一覧表示する方法を示しています。

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