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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  4. เช่นเดียวกับการ์ดอื่นๆ คุณต้องติดตั้งใช้งานฟังก์ชัน Callback ที่ใช้เพื่อมอบการโต้ตอบแบบวิดเจ็ตสําหรับอินเทอร์เฟซ เช่น หากคุณใส่ปุ่มในอินเทอร์เฟซ ปุ่มนั้นควรมีการดำเนินการที่แนบมาและฟังก์ชัน 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"
          },
          ...
        ]
      },
      ...
    }