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

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

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

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

  • หากผู้ใช้คลิกไอคอนส่วนเสริมขณะอยู่ใน Google ไดรฟ์ ส่วนเสริมจะเรียกใช้ฟังก์ชัน drive.homepageTrigger ที่เกี่ยวข้อง (หากมี) ฟังก์ชันนี้จะสร้างและแสดงผลการ์ดหน้าแรกไปยัง Google ไดรฟ์เพื่อแสดง หากไม่ได้กำหนดฟังก์ชัน drive.homepageTrigger ไว้ ระบบจะแสดงการ์ดหน้าแรกทั่วไปแทน
  • หากผู้ใช้เลือกอย่างน้อย 1 รายการใน Google ไดรฟ์ แล้วคลิกไอคอนส่วนเสริม หรือเลือกรายการในขณะที่ส่วนเสริมเปิดอยู่ ส่วนเสริมจะเรียกใช้ฟังก์ชันตามบริบท drive.onItemsSelectedTrigger ที่เกี่ยวข้อง (หากมี) ฟังก์ชันนี้จะสร้างอินเทอร์เฟซ "items selected" ตามบริบทของ 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 ของส่วนเสริมเพื่อระบุหน้าแรกของไดรฟ์โดยเฉพาะ

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

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

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

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

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

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

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

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

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

ระบบจะสร้างออบเจ็กต์เหตุการณ์และส่งไปยังฟังก์ชันทริกเกอร์ 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"
          },
          ...
        ]
      },
      ...
    }