การสร้างอินเทอร์เฟซ Google ไดรฟ์

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

การเข้าถึง UI ของส่วนเสริม

คุณสามารถเปิดส่วนเสริมของ Google Workspace ใน Google ไดรฟ์ได้หากไอคอนของส่วนเสริมปรากฏใน คอลัมน์ไอคอนทางด้านขวาของอินเทอร์เฟซผู้ใช้ไดรฟ์ ส่วนเสริมของ Google Workspace สามารถกำหนดอินเทอร์เฟซหน้าแรก อินเทอร์เฟซการเลือกรายการ หรือทั้ง 2 อย่างได้

  • หากผู้ใช้คลิกไอคอนส่วนเสริมขณะอยู่ใน Google ไดรฟ์ ส่วนเสริมจะเรียกใช้ ฟังก์ชัน drive.homepageTrigger ที่เกี่ยวข้อง (หากมี) ฟังก์ชันนี้ สร้างและแสดงการ์ดหน้าแรก ไปยัง Google ไดรฟ์เพื่อแสดง หากไม่ได้กำหนดฟังก์ชัน drive.homepageTrigger ไว้ ระบบจะแสดงการ์ดหน้าแรกทั่วไปแทน
  • หากผู้ใช้เลือกรายการอย่างน้อย 1 รายการใน Google ไดรฟ์ แล้วคลิกไอคอนส่วนเสริม หรือเลือกรายการขณะที่ส่วนเสริมเปิดอยู่ ส่วนเสริมจะเรียกใช้ฟังก์ชันตามบริบท drive.onItemsSelectedTrigger ที่เกี่ยวข้อง (หากมี) ฟังก์ชันนี้จะสร้างอินเทอร์เฟซ "รายการที่เลือก" ตามบริบทของ Google ไดรฟ์ของส่วนเสริม และส่งกลับไปยัง Google ไดรฟ์เพื่อแสดง

การสร้างอินเทอร์เฟซไดรฟ์ของส่วนเสริม

คุณสามารถสร้างอินเทอร์เฟซที่ขยาย Google ไดรฟ์ได้โดยทำตามขั้นตอนทั่วไปต่อไปนี้

  1. เลือกว่าต้องการให้ส่วนเสริมมีหน้าแรกเฉพาะของไดรฟ์หรือไม่ นอกจากนี้ ให้ตั����������จด้วยว่าคุณต้องการจัดเตรียมอินเทอร์เฟซตามบริบทเมื่อผู้ใช้เลือกรายการในไดรฟ์หรือไม่
  2. เพิ่มช่อง addOns.commonและ addOns.driveที่เหมาะสมลงใน โปรเจ็กต์สคริปต์ของส่วนเสริม ไฟล์ Manifest รวมถึง ขอบเขตของไดรฟ์ที่จำเป็น
  3. หากคุณระบุหน้าแรกสำหรับไดรฟ์โดยเฉพาะ ให้ใช้ฟังก์ชัน drive.homepageTrigger เพื่อสร้างอินเทอร์เฟซนี้ นอกจากนี้ คุณยังเลือกใช้ common.homepageTrigger อินเทอร์เฟซสำหรับโฮสต์ Google Workspace หลายรายการได้ด้วย
  4. หากคุณมีอินเทอร์เฟซการเลือกรายการตามบริบทของไดรฟ์ คุณต้อง ใช้ฟังก์ชันทริกเกอร์ตามบริบท drive.onItemsSelectedTrigger เพื่อสร้างอินเทอร์เฟซนี้ ดูรายละเอียดได้ที่อินเทอร์เฟซตามบริบทของไดรฟ์สำหรับรายการที่เลือก
  5. ใช้ฟังก์ชันเรียกกลับที่เชื่อมโยงที่จำเป็นเพื่อตอบสนองต่อการโต้ตอบ UI ของผู้ใช้ เช่น การคลิกปุ่ม

หน้าแรกของไดรฟ์

Google ไดรฟ์รองรับการแสดงหน้าแรกของส่วนเสริม Google Workspace หากต้องการแสดงหน้าแรกทั่วไปของส่วนเสริมใน Google ไดรฟ์ เพียงตรวจสอบว่ามีฟิลด์ addOns.drive ในไฟล์ Manifest ของส่วนเสริม

หรือจะเพิ่ม drive.homepageTrigger ลงในไฟล์ Manifest ของส่วนเสริมเพื่อระบุหน้าแรกสำหรับไดรฟ์โดยเฉพาะก็ได้

ไม่ว่าจะในกรณีใด คุณต้องระบุชื่อฟังก์ชันทริกเกอร์หน้าแรกในโปรเจ็กต์สคริปต์ของส่วนเสริม ระบบจะเรียกฟังก์ชันนี้โดยอัตโนมัติเพื่อสร้าง หน้าแรกของไดรฟ์เมื่อจำเป็น คุณต้องใช้ฟังก์ชันนี้เพื่อสร้างและ แสดงผล Card รายการเดียวหรืออาร์เรย์ของออบเจ็กต์ Card ที่ประกอบกันเป็นหน้าแรก ฟังก์ชันทริกเกอร์หน้าแรกจะรับ ออบเจ็กต์เหตุการณ์ เป็นพารามิเตอร์ที่มีข้อมูลทั่วไปบางอย่าง เช่น แพลตฟอร์มของไคลเอ็นต์ คุณสามารถใช้ข้อมูลออบเจ็กต์เหตุการณ์เ��ื่อปรับแต่งการสร้าง หน้าแรก

อินเทอร์เฟซตามบริบทของไดรฟ์สำหรับรายการที่เลือก

Google ไดรฟ์ใช้ทริกเกอร์ตามบริบทเพื่อพิจารณาว่าจะแสดงอินเทอร์เฟซใด (หากมี) เมื่อผู้ใช้เลือกรายการใน Google ไดรฟ์อย่างน้อย 1 รายการ เมื่อทริกเกอร์ทำงาน ระบบจะเรียกใช้ฟังก์ชันทริกเกอร์ตามบริบทที่ระบุโดยฟิลด์ drive.onItemsSelectedTrigger.runFunction ในไฟล์ Manifest ของส่วนเสริม

หากต้องการสร้างอินเทอร์เฟซการเลือกรายการตามบริบทสำหรับไดรฟ์ คุณต้องทำสิ่งต่อไปนี้

  1. ตรวจสอบว่าไฟล์ Manifest ��องส่วนเสริมม�� https://www.googleapis.com/auth/drive.addons.metadata.readonly scope

  2. ตรวจสอบว่าไฟล์ Manifest มีส่วน drive.onItemsSelectedTrigger

  3. ใช้ฟังก์ชันที่ระบุชื่อในฟิลด์ drive.onItemsSelectedTrigger ฟังก์ชันนี้รับออบเจ็กต์เหตุการณ์เป็นอาร์กิวเมนต์ และต้องแสดงผลออบเจ็กต์ Card รายการเดียวหรืออาร์เรย์ของออบเจ็กต์ Card

  4. เช่นเดียวกับการ์ดอื่นๆ คุณต้องใช้ฟังก์ชันเรียกกลับที่ใช้เพื่อมอบ การโต้ตอบของวิดเจ็ตสำหรั���อินเทอร์เฟซ เช่น หากคุณใส่ปุ่ม ในอินเทอร์เฟซ ปุ่มนั้นควรมี Action แนบอยู่และมีฟังก์ชัน Callback ที่ใช้งานซึ่งจะทํางานเมื่อมีการคลิกปุ่ม

ออบเจ็กต์เหตุการณ์

ระบบจะสร้างออบเจ็กต์เหตุการณ์และส่งไปยังฟังก์ชันทริกเกอร์ drive.homepageTrigger หรือ drive.onItemsSelectedTrigger เมื่อมีการเรียกใช้ฟังก์ชันเหล่านั้น ฟังก์ชันทริกเกอร์สามารถใช้ข้อมูลในออบเจ็กต์เหตุการณ์นี้เพื่อกำหนดวิธีสร้างการ์ดส่วนเสริม หรือควบคุมลักษณะการทำงานของส่วนเสริม

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

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

ตัวอย่างต่อไปนี้แสดงออบเจ็กต์เหตุการณ์ในไดรฟ์ ที่ส่งไปยังฟังก์ชัน drive.onItemsSelectedTrigger

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }