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

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

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

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

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

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

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

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

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

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

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

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

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

ไดรฟ์ใช้ทริกเกอร์ตามบริบทเพื่อกำหนดอินเทอร์เฟซ (หากมี) ที่จะแสดงเมื่อผู้ใช้เลือกรายการในไดรฟ์ อย่างน้อย 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. เช่นเดียวกับบัตรอื่นๆ ให้ใช้ฟังก์ชันเรียกกลับที่ใช้เพื่อมอบ วิดเจ็ตแบบอินเทอร์แอกทีฟสำหรับอินเทอร์เฟซ เช่น หากคุณใส่ปุ่ม ในอินเทอร์เฟซ ปุ่มนั้นควรมีAction ที่แนบมา และฟังก์ชัน Callback ที่ใช้งาน ซึ่งจะทำงานเมื่อมีการคลิกปุ่ม

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

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

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

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

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

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

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