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

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

เปิดใช้ Drive API

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

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

• เปิดใช้ Google Drive API ในคอนโซล Google Cloud

  เปิดใช้ API

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

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

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

2. ที่ด้านล่างของแดชบอร์ด API และบริการ ให้คลิก Google Drive API หน้าการกำหนดค่า Google Drive API จะปรากฏขึ้น
3. เลือกแท็บการผสานรวม UI ของไดรฟ์
4. (ไม่บังคับ) ป้อนชื่อในช่องชื่อแอปพลิเคชัน ชื่อแอปพลิเคชันจะแสดงต่อผู้ใช้ในแท็บจัดการแอปในการตั้งค่าไดรฟ์
5. (ไม่บังคับ) ป้อนคำอธิบายสั้นๆ บรรทัดเดียวในช่องคำอธิบายสั้นๆ คำอธิบายแบบย่อจะแสดงให้ผู้ใช้เห็นในแท็บจัดการแอปในการตั้งค่าไดรฟ์
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 Workspace เท่านั้น	เปิด 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 ของไดรฟ์