การดำเนินการกับไดรฟ์

ออบเจ็กต์ Action ช่วยให้คุณสร้างพฤติกรรมแบบอินเทอร์แอกทีฟลงในส่วนเสริม Google Workspace ได้ โดยจะกําหนดสิ่งที่จะเกิดขึ้นเมื่อผู้ใช้โต้ตอบกับวิดเจ็ต (เช่น ปุ่ม) ใน UI ส่วนเสริม

การทํางานจะแนบไปกับวิดเจ็ตหนึ่งๆ โดยใช้ฟังก์ชันตัวแฮนเดิลวิดเจ็ต ซึ่งกําหนดเงื่อนไขที่จะทริกเกอร์การทํางาน เมื่อทริกเกอร์ การดําเนินการจะเรียกใช้ฟังก์ชันเรียกกลับที่กําหนด ฟังก์ชันเรียกกลับจะส่งผ่านออบเจ็กต์เหตุการณ์ซึ่งมีข้อมูลเกี่ยวกับการโต้ตอบฝั่งไคลเอ็นต์ของผู้ใช้ คุณต้องใช้ฟังก์ชันฟังก์ชันเรียกกลับและให้ฟังก์ชันแสดงออบเจ็กต์การตอบกลับที่เฉพาะเจาะจง

เช่น สมมติว่าคุณต้องการปุ่มที่สร้างและแสดงการ์ดใหม่เมื่อคลิก คุณต้องสร้างวิดเจ็ตปุ่มใหม่ และใช้ฟังก์ชันตัวควบคุมปุ่ม setOnClickAction(action) เพื่อตั้งค่าวิดเจ็ตการ์ด Action Action ที่คุณกําหนดจะระบุฟังก์ชันเรียกกลับของ Apps Script ที่จะทํางานเมื่อมีการคลิกปุ่ม ในกรณีนี้ ให้ใช้ฟังก์ชันเรียกกลับเพื่อสร้างการ์ดที่ต้องการและส่งคืนออบเจ็กต์ ActionResponse ออบเจ็กต์การตอบกลับจะบอกส่วนเสริมเพื่อแสดงการ์ดที่สร้างฟังก์ชันเรียกกลับที่สร้างขึ้น

หน้านี้จะอธิบายถึงการดําเนินการกับวิดเจ็ตเฉพาะไดรฟ์ที่คุณใส่ไว้ในส่วนเสริมได้

กระตุ้นการโต้ตอบ

ส่วนเสริม Google Workspace ที่ขยายไดรฟ์อาจรวมถึงการดําเนินการเพิ่มเติมเกี่ยวกับวิดเจ็ตเฉพาะไดรฟ์ การดําเนินการนี้ต้องใช้ฟังก์ชันเรียกกลับเพื่อดําเนินการที่เกี่ยวข้อง เพื่อแสดงออบเจ็กต์การตอบกลับพิเศษ

การดําเนินการที่เกิดขึ้น ฟังก์ชันเรียกกลับควรแสดงผล
ขอสิทธิ์เข้าถึงไฟล์สําหรับไฟล์ที่เลือก DriveItemsSelectedActionResponse

หากต้องการใช้การดําเนินการกับวิดเจ็ตและออบเจ็กต์การตอบกลับเหล่านี้ เงื่อนไขต่อไปนี้ต้องเป็นจริงทั้งหมด

  • ซึ่งจะทริกเกอร์ขณะที่ผู้ใช้เลือกรายการในไดรฟ์อย่างน้อย 1 รายการ
  • ส่วนเสริมจะมี https://www.googleapis.com/auth/drive.file ขอบเขตของไดรฟ์ในไฟล์ Manifest

ส่งคําขอเข้าถึงไฟล์สําหรับไฟล์ที่เลือก

ตัวอย่างต่อไปนี้แสดงวิธีสร้างอินเทอร์เฟซตามบริบทสําหรับ Google ไดรฟ์ที่จะแสดงขึ้นเมื่อผู้ใช้เลือกรายการในไดรฟ์อย่างน้อย 1 รายการ ตัวอย่างจะทดสอบแต่ละรายการเพื่อดูว่าส่วนเสริมได้รับสิทธิ์การเข้าถึงหรือไม่ หากไม่มี ก็จะใช้ออบเจ็กต์ DriveItemsSelectedActionResponse เพื่อขอสิทธิ์จากผู้ใช้ เมื่อให้สิทธิ์สําหรับรายการแล้ว ส่วนเสริมจะแสดงการใช้งานโควต้าไดรฟ์ของรายการนั้น

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