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

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

เปิดใช้ Drive API

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

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

• เปิดใช้ API ของ Google ไดรฟ์ในคอนโซล Google Cloud

  เปิดใช้ API

ตั้งค่าการผสานรวม 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
   คำเตือน: ระบบเลิกใช้งานตัวเลือกการแสดงหน้าจอขอความยินยอม OAuth 2.0 โดยอัตโนมัติแล้ว อย่าเลือกช่องนี้ แอปพลิเคชันต้องเริ่มคำขอการให้สิทธิ์ทั้งหมด

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 ของไดรฟ์ เมื่อส่งคำขอขอบเขตนี้ ผู้ใช้จะได้รับข้อความ ที่คล้ายกับข้อความต่อไปนี้

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

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

หมายเหตุ: หากคุณเผยแพร่แอปไดรฟ์ของคุณ ไปยัง Google Workspace Marketplace ผู้ใช้และผู้ดูแลระบบโดเมนจะค้นหาและติดตั้งแอปได้โดยตรงจาก Google Workspace Marketplace

พารามิเตอร์ 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 ได้

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

หัวข้อที่เกี่ยวข้อง

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