กําหนดค่าการผสานรวม UI ของไดรฟ์

หากต้องการแสดงแอปใน Google ไดรฟ์เมื่อผู้ใช้สร้างหรือเปิดไฟล์ คุณต้องตั้งค่าการผสานรวมอินเทอร์เฟซผู้ใช้ (UI) ของไดรฟ์ก่อน การกําหนดค่ายังต้องแสดงแอปใน Google Workspace Marketplace ด้วย

เปิดใช้ Drive API

ก่อนใช้ Google API คุณต้องเปิด API เหล่านั้นในโปรเจ็กต์ Google Cloud คุณสามารถเปิด API อย่างน้อย 1 รายการในโปรเจ็กต์ Google Cloud รายการเดียวได้

หากต้องการเริ่มผสานรวมกับ UI ของ Google ไดรฟ์ คุณต้องเปิดใช้ API ของไดรฟ์ ซึ่งทําให้คุณสามารถเข้าถึง API และฟีเจอร์การผสานรวม UI ได้

ตั้งค่าการผสานรวม UI ของไดรฟ์

  1. ในคอนโซล Google API ให้ไปที่เมนู > API และบริการ > API และบริการที่เปิดใช้

    ไปที่ API และบริการที่เปิดใช้

  2. คลิกGoogle Drive API ที่ด้านล่างของหน้าแดชบอร์ด API และบริการ หน้าการกําหนดค่า Google Drive API จะปรากฏขึ้น
  3. เลือกแท็บการผสานรวม UI ของไดรฟ์
  4. (ไม่บังคับ) ป้อนชื่อในช่องชื่อแอปพลิเคชัน ชื่อแอปพลิเคชันจะแสดงต่อผู้ใช้ในแท็บ "จัดการแอป" ในการตั้งค่าไดรฟ์
  5. (ไม่บังคับ) ป้อนคําอธิบาย 1 บรรทัดสั้นๆ ในช่องคําอธิบายแบบย่อ คําอธิบายสั้นๆ จะแสดงต่อผู้ใช้ในแท็บ "จัดการแอป" ในการตั้งค่าไดรฟ์
  6. (ไม่บังคับ) ป้อนคําอธิบายแบบเต็มในช่องคําอธิบายแบบยาว

  7. อัปโหลดไอคอนแอปพลิเคชันอย่างน้อย 1 รายการเพื่อแสดงในรายการแอปไดรฟ์ที่เชื่อมต่อของผู้ใช้และในเมนูตามบริบท "เปิดด้วย" ไอคอนต้องอยู่ในรูปแบบ PNG ที่มีพื้นหลังโปร่งใส ไอคอนอาจใช้เวลาถึง 24 ชั่วโมงจึงจะปรากฏในไดรฟ์

  8. หากต้องการใช้รายการเมนู "เปิดด้วย" ของ UI ของไดรฟ์ ให้ป้อน URL ไปยังแอปของคุณในช่อง URL แบบเปิด URL นี้ใช้โดยเมนูตามบริบท "เปิดด้วย"

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

  9. (ไม่บังคับ) ป้อนประเภท MIME และนามสกุลไฟล์ในช่องประเภท MIME เริ่มต้นและนามสกุลไฟล์เริ่มต้น ประเภท MIME เริ่มต้นและนามสกุลไฟล์แสดงถึงไฟล์ที่แอปสร้างขึ้นที่ไม่ซ้ําเพื่อเปิด เช่น แอปอาจเปิดรูปแบบที่มีในตัวสําหรับสร้างเลเยอร์และแก้ไขรูปภาพ ใส่เฉพาะประเภทสื่อมาตรฐานและตรวจสอบว่าไม่มีการพิมพ์ผิดและการสะกดผิด หากแอปเปิดเฉพาะทางลัดทางลัดหรือไฟล์ทางลัดของบุคคลที่สาม ให้เว้นว่างประเภท MIME ไว้

  10. (ไม่บังคับ) ป้อนประเภท MIME รองและนามสกุลไฟล์ในช่องประเภท MIME รองและนามสกุลไฟล์รอง ประเภท MIME รองและนามสกุลไฟล์แสดงถึงแอปที่แอปของคุณเปิดได้ แต่ไม่ได้เจาะจงสําหรับแอป เช่น แอปอาจเป็นแอปแต่งภาพที่จะเปิดรูปภาพ PNG และ JPG ใส่เฉพาะประเภทสื่อมาตรฐานและตรวจสอบว่าไม่มีการพิมพ์ผิดและการสะกดผิด หากแอปเปิดเฉพาะทางลัดทางลัดหรือไฟล์ทางลัดของบุคคลที่สาม ให้เว้นว่างประเภท MIME ไว้

  11. หากต้องการใช้ปุ่ม "ใหม่" ของ UI ของไดรฟ์ และกําหนดให้ผู้ใช้สร้างไฟล์ด้วยแอป ให้เลือกช่องสร้างไฟล์ ช่อง URL ใหม่และชื่อเอกสาร (ไม่บังคับ) จะปรากฏขึ้น

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

  12. ป้อน URL ในช่อง URL ใหม่ ปุ่ม "ใหม่" จะใช้ URL นี้เพื่อเปลี่ยนเส้นทางผู้ใช้ไปยังแอปพลิเคชัน

  13. (ไม่บังคับ) หากต้องการให้แอปเปิดไฟล์ที่ Google Workspace รองรับ ให้เลือกช่องการนําเข้า

  14. (ไม่บังคับ) หากแอปของคุณต้องจัดการไฟล์ในไดรฟ์ที่แชร์ ให้เลือกช่องการรองรับไดรฟ์ที่แชร์ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีสนับสนุนไดรฟ์ที่แชร์ในแอปได้ที่การใช้งานการรองรับไดรฟ์ที่แชร์

  15. คลิกส่ง

ขอขอบเขต drive.install

หากต้องการอนุญาตให้แอปแสดงเป็นตัวเลือกในเมนู "เปิดด้วย" หรือ "ใหม่" ให้ขอขอบเขต https://www.googleapis.com/auth/drive.install เพื่อผสานรวมกับ UI ของไดรฟ์ เมื่อขอขอบเขตนี้ ผู้ใช้จะได้รับ กล่องโต้ตอบในลักษณะนี้

กล่องโต้ตอบการติดตั้ง UI ของ Google ไดรฟ์
รูปที่ 1 กล่องโต้ตอบการติดตั้งเมื่อใช้ขอบเขตสําหรับ UI ของไดรฟ์

ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขตที่ส่งคําขอสําหรับแอปไดรฟ์ได้ และวิธีขอขอบเขต โปรดดูข้อมูลการให้สิทธิ์และการตรวจสอบสิทธิ์เฉพาะ API

พารามิเตอร์ state

โดยค่าเริ่มต้น ระบบจะเพิ่มพารามิเตอร์ state ต่อท้ายทั้ง URL แบบเปิดและ URL ใหม่เพื่อส่งข้อมูลจาก UI ของไดรฟ์ไปยังแอป พารามิเตอร์นี้จะมีสตริงที่เข้ารหัส JSON พร้อมตัวแปรเทมเพลตและข้อมูลเกี่ยวกับคําขอที่ส่งไปยังแอป ตัวแปรที่รวมจะขึ้นอยู่กับประเภทของ URL ที่ใช้ (URL แบบเปิดหรือ URL ใหม่) ดังนี้

ตัวแปรเทมเพลต คำอธิบาย แอปพลิเคชัน URL
{ids} รายการรหัสไฟล์ที่เปิดอยู่โดยคั่นด้วยคอมมา เปิด URL
{exportIds} รายการรหัสไฟล์ที่จะส่งออกซึ่งคั่นด้วยคอมมา (ใช้เมื่อเปิดเอกสาร Google ในตัวเท่านั้น) เปิด URL
{resourceKeys} พจนานุกรม JSON ของรหัสไฟล์ที่แมปกับคีย์ทรัพยากรที่เกี่ยวข้อง เปิด URL
{folderId} รหัสของโฟลเดอร์ระดับบน URL ใหม่
{folderResourceKey} คีย์ทรัพยากรของโฟลเดอร์ระดับบนสุด URL ใหม่
{userId} รหัสโปรไฟล์ที่ระบุผู้ใช้ เปิด URL และ URL ใหม่
{action} การดําเนินการที่ทํา ค่าคือ open เมื่อใช้ URL แบบเปิดหรือ create เมื่อใช้ URL ใหม่ เปิด URL และ URL ใหม่

พารามิเตอร์ state มีการเข้ารหัส URL ดังนั้นแอปจึงต้องจัดการอักขระหลีกและแยกวิเคราะห์เป็น JSON แอปตรวจหาค่า create ในพารามิเตอร์ state เพื่อยืนยันคําขอสร้างไฟล์ได้

ตัวอย่างข้อมูลสถานะใน JSON สําหรับ URL ใหม่

ข้อมูล state สําหรับ URL ใหม่คือ

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

ตัวอย่างข้อมูลสถานะใน JSON สําหรับ URL แบบเปิด

ข้อมูล state สําหรับ URL แบบเปิดคือ

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

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

แอปที่ติดตั้งไว้จะต้องสร้าง จัดการ และเปิดการดําเนินการที่เปิดจาก UI ของไดรฟ์ได้ ดูข้อมูลเพิ่มเติมได้ที่ผสานรวมกับปุ่ม "ใหม่" ของ UI ของไดรฟ์ หรือผสานรวมกับเมนูตามบริบท "เปิดด้วย" ของ UI ของไดรฟ์