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

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

เปิดใช้ Drive API

ก่อนที่จะใช้ Google API คุณต้องเปิดใช้งานในโปรเจ็กต์ Google Cloud คุณเปิด API ได้อย่างน้อย 1 รายการในโปรเจ็กต์ Google Cloud เดียว

หากต้องการเริ่มผสานรวมกับ UI ของ Google ไดรฟ์ คุณต้องเปิดใช้ Drive 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 นี้ควรเข้าถึงได้โดยผู้ใช้ที่คุณตั้งใจจะใช้แอปพลิเคชัน หากคุณมีแอปพลิเคชันหลายเวอร์ชัน เช่น เวอร์ชันหนึ่งสำหรับการเผยแพร่ต่อสาธารณะ และอีกเวอร์ชันสำหรับการเผยแพร่ที่จำกัดให้กับผู้ใช้ที่เลือก แต่ละเวอร์ชันควรใช้ URL ที่ไม่ซ้ำกัน จากนั้นคุณสามารถสร้างการกำหนดค่าแอป ที่แตกต่างกันสำหรับแต่ละเวอร์ชัน
    • คุณต้องยืนยันการเป็นเจ้าของ 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 ของไดรฟ์