קידום פעולות

Action אובייקטים מאפשרים ליצור אובייקטים אינטראקטיביים ההתנהגות של המשתמשים בתוספים של Google Workspace. הם מגדירים מה קורה כשמשתמש יוצר אינטראקציה עם ווידג'ט (לדוגמה, לחצן) בממשק המשתמש של התוסף.

הפעולה מצורפת לווידג'ט נתון באמצעות את פונקציית ה-handler של הווידג'טים, שמגדיר גם את התנאי שמפעיל את הפעולה. כשהיא מופעלת, הפרמטר הפעולה מבצעת פונקציית קריאה חוזרת. פונקציית הקריאה החוזרת מועברת אובייקט אירוע שנושא מידע על האינטראקציות של המשתמש בצד הלקוח. עליך ליישם את פונקציית הקריאה החוזרת כדי להחזיר אובייקט תגובה ספציפי.

לדוגמה, נניח שאתם רוצים לחצן ליצירה ולהצגה של כרטיס חדש בוצעה לחיצה. לשם כך, צריך ליצור ווידג'ט חדש של לחצנים ולהשתמש בווידג'ט הלחצנים פונקציית handler setOnClickAction(action) כדי להגדיר בניית כרטיסים Action. Action שמגדירים מציין את Apps Script פונקציית קריאה חוזרת (callback) שמופעלת כשלוחצים על הלחצן. במקרה הזה, להטמיע את פונקציית הקריאה החוזרת כדי ליצור את הכרטיס הרצוי ולהחזיר ActionResponse לאובייקט. אובייקט התשובה מורה לתוסף להציג את הכרטיס שהקריאה אליו חוזרת גנרטיבית.

בדף הזה מתוארות פעולות בווידג'ט ספציפיות ל-Drive שאפשר לכלול

הגדלת האינטראקציות

תוספים ל-Google Workspace שמרחיבים את Drive יכולים לכלול פעולה נוספת בווידג'ט שספציפית ל-Drive. לפעולה זו נדרש פונקציית קריאה חוזרת לביצוע פעולה כדי להחזיר אובייקט תגובה מיוחד:

בוצע ניסיון לפעולה	פונקציית הקריאה החוזרת אמורה לחזור
בקשת גישה לקבצים שנבחרו	DriveItemsSelectedActionResponse

כדי להשתמש בפעולות הווידג'ט ובאובייקטים של התשובות, צריך לבצע את כל חייב להיות True:

• הפעולה מופעלת כל עוד המשתמש בוחר פריט אחד או יותר ב-Drive.
• התוסף כולל את https://www.googleapis.com/auth/drive.file ההיקף של Drive במסגרת .

בקשת גישה לקבצים שנבחרו

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

/**
 * Build a simple card that checks selected items' quota usage. Checking
 * quota usage requires user-permissions, so this add-on provides a button
 * to request `drive.file` scope for items the add-on doesn't yet have
 * permission to access.
 *
 * @param e The event object passed containing contextual information about
 *    the Drive items selected.
 * @return {Card}
 */
function onDriveItemsSelected(e) {
  var builder =  CardService.newCardBuilder();

  // For each item the user has selected in Drive, display either its
  // quota information or a button that allows the user to provide
  // permission to access that file to retrieve its quota details.
  e['drive']['selectedItems'].forEach(
    function(item){
      var cardSection = CardService.newCardSection()
          .setHeader(item['title']);

      // This add-on uses the recommended, limited-permission `drive.file`
      // scope to get granular per-file access permissions.
      // See: https://developers.google.com/drive/api/v2/about-auth
      if (item['addonHasFileScopePermission']) {
        // If the add-on has access permission, read and display its
        // quota.
        cardSection.addWidget(
          CardService.newTextParagraph().setText(
              "This file takes up: " + getQuotaBytesUsed(item['id'])));
      } else {
        // If the add-on does not have access permission, add a button
        // that allows the user to provide that permission on a per-file
        // basis.
        cardSection.addWidget(
          CardService.newTextParagraph().setText(
              "The add-on needs permission to access this file's quota."));

        var buttonAction = CardService.newAction()
          .setFunctionName("onRequestFileScopeButtonClicked")
          .setParameters({id: item.id});

        var button = CardService.newTextButton()
          .setText("Request permission")
          .setOnClickAction(buttonAction);

        cardSection.addWidget(button);
      }

      builder.addSection(cardSection);
    });

  return builder.build();
}

/**
 * Callback function for a button action. Instructs Drive to display a
 * permissions dialog to the user, requesting `drive.file` scope for a
 * specific item on behalf of this add-on.
 *
 * @param {Object} e The parameters object that contains the item's
 *   Drive ID.
 * @return {DriveItemsSelectedActionResponse}
 */
function onRequestFileScopeButtonClicked (e) {
  var idToRequest = e.parameters.id;
  return CardService.newDriveItemsSelectedActionResponseBuilder()
      .requestFileScope(idToRequest).build();
}

/**
 * Use the Advanced Drive Service
 * (See https://developers.google.com/apps-script/advanced/drive),
 * with `drive.file` scope permissions to request the quota usage of a
 * specific Drive item.
 *
 * @param {string} itemId The ID of the item to check.
 * @return {string} A description of the item's quota usage, in bytes.
 */
function getQuotaBytesUsed(itemId) {
  try {
    return Drive.Files.get(itemId,{fields: "quotaBytesUsed"})
        .quotaBytesUsed + " bytes";
  } catch (e) {
    return "Error fetching how much quota this item uses. Error: " + e;
  }
}