שירות מתקדם של תוויות ב-Drive

ליצור ולנהל תוויות לקבצים ולתיקיות ב-Drive באמצעות השירות המתקדם 'תוויות' של Google Drive. בעזרת השירות המתקדם הזה, אתם יכולים להשתמש בכל התכונות של Drive Labels API ב-Apps Script.

כדי להוסיף תוויות ל-Drive או להסיר אותן, צריך להשתמש בשירות המתקדם של Drive.

הערה: זהו שירות מתקדם שצריך להפעיל לפני השימוש.

חומרי עזר

מידע נוסף על השירות הזה זמין במאמרי העזרה בנושא Google Drive Labels API. בדומה לכל השירותים המתקדמים ב-Apps Script, שירות Drive Labels API משתמש באותם אובייקטים, שיטות ופרמטרים כמו ה-API הציבורי.

כדי לדווח על בעיות ולמצוא תמיכה נוספת, אפשר לעיין במדריך התמיכה של Google Drive Labels API.

קוד לדוגמה

קוד לדוגמה שבהמשך משתמש בגרסה 2 של ה-API.

הצגת רשימה של תוויות

בדוגמת הקוד הבאה אפשר לראות איך מקבלים רשימה של התוויות שזמינות למשתמש ששולח את הבקשה.

advanced/driveLabels.gs

הצגת הקוד ב-GitHub

/**
 * 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 או משתמשים בכלי לניהול תוויות ב-Drive. מידע נוסף על מרכז ניהול התוויות זמין במאמר ניהול תוויות ב-Drive.

advanced/driveLabels.gs

הצגת הקוד ב-GitHub

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

הצגת תוויות של פריט ב-Drive

בדוגמת הקוד הבאה אפשר לראות איך מקבלים פריט ב-Drive ומציגים רשימה של כל התוויות שחלות על הפריט הזה.

advanced/driveLabels.gs

הצגת הקוד ב-GitHub

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