เลือกขอบเขต Google Drive API

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

กำหนดค่า OAuth 2.0 สำหรับการให้สิทธิ์

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

ขอบเขตของ Drive API

หากต้องการกำหนดระดับการเข้าถึงที่มอบให้กับแอป คุณจะต้องระบุและประกาศขอบเขตการให้สิทธิ์ ขอบเขตการให้สิทธิ์คือสตริง URI ของ OAuth 2.0 ที่มีชื่อแอป Google Workspace, ประเภทข้อมูลที่เข้าถึง และระดับการเข้าถึง ขอบเขตคือคำขอของแอปเพื่อทำงานกับข้อมูลใน Google Workspace รวมถึงข้อมูลบัญชี Google ของผู้ใช้

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

เมื่อเป็นไปได้ เราขอแนะนำให้ใช้ขอบเขตที่ไม่มีความละเอียดอ่อน เนื่องจากจะให้ขอบเขตการเข้าถึงต่อไฟล์และจำกัดการเข้าถึงฟีเจอร์บางอย่างที่แอปจำเป็นต้องใช้

Drive API รองรับขอบเขตต่อไปนี้

รหัสขอบเขต คำอธิบาย การใช้งาน
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.appfolder
ดูและจัดการข้อมูลการกำหนดค่าของแอปใน Google ไดรฟ์ของคุณ แนะนำ
ไม่ละเอียดอ่อน
https://www.googleapis.com/auth/drive.install อนุญาตให้แอปปรากฏเป็นตัวเลือกในเมนู "เปิดด้วย" หรือ "ใหม่" แนะนำ
ไม่ละเอียดอ่อน
https://www.googleapis.com/auth/drive.file สร้างไฟล์ในไดรฟ์ใหม่หรือแก้ไขไฟล์ที่มีอยู่ซึ่งคุณเปิดด้วยแอปหรือที่ผู้ใช้แชร์กับแอปขณะใช้ Google Picker API หรือเครื่องมือเลือกไฟล์ของแอป แนะนำ
ไม่ละเอียดอ่อน
https://www.googleapis.com/auth/drive.apps.readonly ดูแอปที่อนุญาตให้เข้าถึงไดรฟ์ของคุณ ละเอียดอ่อน
https://www.googleapis.com/auth/drive ดูและจัดการไฟล์ในไดรฟ์ทั้งหมด ถูกจำกัด
https://www.googleapis.com/auth/drive.readonly ดูและดาวน์โหลดไฟล์ในไดรฟ์ทั้งหมดของคุณ ถูกจำกัด
https://www.googleapis.com/auth/drive.activity ดูและเพิ่มข้อมูลในบันทึกกิจกรรมของไฟล์ในไดรฟ์ ถูกจำกัด
https://www.googleapis.com/auth/drive.activity.readonly ดูบันทึกกิจกรรมของไฟล์ในไดรฟ์ ถูกจำกัด
https://www.googleapis.com/auth/drive.meet.readonly ดูไฟล์ในไดรฟ์ที่ Google Meet สร้างหรือแก้ไข ถูกจำกัด
https://www.googleapis.com/auth/drive.metadata ดูและจัดการข้อมูลเมตาของไฟล์ในไดรฟ์ของคุณ ถูกจำกัด
https://www.googleapis.com/auth/drive.metadata.readonly ดูข้อมูลเมตาสำหรับไฟล์ในไดรฟ์ของคุณ ถูกจำกัด
https://www.googleapis.com/auth/drive.scripts ปรับเปลี่ยนลักษณะการทำงานของสคริปต์ใน Google Apps Script ถูกจำกัด

คอลัมน์การใช้งานในตารางด้านบนจะระบุความละเอียดอ่อนของแต่ละขอบเขต ตามคำจำกัดความต่อไปนี้

  • แนะนำ / ไม่มีความละเอียดอ่อน: ขอบเขตเหล่านี้ให้ขอบเขตที่เล็กที่สุดสำหรับสิทธิ์การเข้าถึงการให้สิทธิ์ และต้องใช้เฉพาะการยืนยันแอปพื้นฐานเท่านั้น ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่ข้อกำหนดการยืนยัน

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

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

หากแอปของคุณต้องมีสิทธิ์เข้าถึง API อื่นๆ ของ Google คุณก็เพิ่มขอบเขตเหล่านั้นได้เช่นกัน สำหรับข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต Google API โปรดดูการใช้ OAuth 2.0 เพื่อเข้าถึง Google API

ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต OAuth 2.0 ที่เฉพาะเจาะจงได้ที่ขอบเขต OAuth 2.0 สำหรับ Google APIs

การยืนยัน OAuth

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

กรณีที่ควรใช้ขอบเขตที่จำกัด

สำหรับไดรฟ์ มีเพียงแอปพลิเคชันประเภทต่อไปนี้เท่านั้นที่เข้าถึงขอบเขตที่มีการจำกัดได้

  1. แอปเฉพาะแพลตฟอร์มและเว็บแอปที่มีการซิงค์ภายในเครื่องหรือการสำรองข้อมูลไฟล์ในไดรฟ์ของผู้ใช้โดยอัตโนมัติ
  2. แอปพลิเคชันเพื่อการทำงานและการศึกษาที่อินเทอร์เฟซผู้ใช้อาจเกี่ยวข้องกับการโต้ตอบกับไฟล์ในไดรฟ์ (หรือข้อมูลเมตาหรือสิทธิ์) แอปพลิเคชันเพื่อการทำงานประกอบด้วยการจัดการงาน การจดโน้ต การสื่อสารในกลุ่มงาน และแอปพลิเคชันการทำงานร่วมกันในชั้นเรียน
  3. แอปพลิเคชันการรายงานและการรักษาความปลอดภัยที่ให้ข้อมูลเชิงลึกเกี่ยวกับผู้ใช้หรือลูกค้าเกี่ยวกับวิธีแชร์หรือเข้าถึงไฟล์

หากต้องการใช้ขอบเขตที่จำกัดต่อไป คุณควรเตรียมแอปให้พร้อมสำหรับการยืนยันขอบเขตที่จำกัด

ย้ายข้อมูลแอปที่มีอยู่จากขอบเขตที่จำกัด

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

ประโยชน์ของขอบเขต OAuth drive.file

การใช้ขอบเขต OAuth ของ drive.file และ Google Picker API จะช่วยเพิ่มประสิทธิภาพทั้งประสบการณ์ของผู้ใช้และความปลอดภัยสำหรับแอป

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

  • ความสามารถในการใช้งาน: ขอบเขต drive.file ใช้งานได้กับทรัพยากร REST ทั้งหมดของ Drive API ซึ่งหมายความว่าคุณจะใช้ขอบเขตลักษณะเดียวกับการใช้ขอบเขต OAuth ที่กว้างขึ้นได้

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

  • ความสะดวก: แอปสามารถใช้ตัวกรองสำหรับประเภทไฟล์ของไดรฟ์บางประเภท (เช่น Google เอกสาร, ชีต และรูปภาพ) เมื่อใช้ตัวกรองในไฟล์ Google Picker

นอกจากนี้ เนื่องจาก drive.file ไม่ใช่ข้อมูลที่ละเอียดอ่อน จึงช่วยให้กระบวนการยืนยันมีประสิทธิภาพมากขึ้น

บันทึกโทเค็นการรีเฟรช

บันทึกโทเค็นการรีเฟรชไว้ในพื้นที่เก็บข้อมูลที่ปลอดภัยและระยะยาวและใช้งานต่อไปตราบใดที่ยังใช้ได้อยู่