เอกสารนี้มีการให้สิทธิ์เฉพาะ Gmail API และ ข้อมูลสำหรับการตรวจสอบสิทธิ์ ก่อนอ่านเอกสารนี้ โปรดอ่านข้อมูลการตรวจสอบสิทธิ์และการให้สิทธิ์ทั่วไปของ Google Workspace ที่ดูข้อมูลเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์
กำหนดค่า OAuth 2.0 สำหรับการให้สิทธิ์
กำหนดค่าหน้าจอคำยินยอม OAuth และเลือกขอบเขตเพื่อกำหนดข้อมูลที่แสดงต่อผู้ใช้และผู้ตรวจสอบแอป รวมถึงลงทะเบียนแอปเพื่อให้เผยแพร่ได้ในภายหลัง
ขอบเขต Gmail API
หากต้องการกำหนดระดับการเข้าถึงที่กำหนดให้กับแอป คุณต้องระบุและประกาศขอบเขตการให้สิทธิ์ ขอบเขตการให้สิทธิ์คือสตริง URI ของ OAuth 2.0 ที่มีชื่อแอป Google Workspace, ประเภทข้อมูลที่เข้าถึง และระดับการเข้าถึง ขอบเขตคือคำขอการทำงานของแอปกับข้อมูล Google Workspace ซึ่งรวมถึงข้อมูลบัญชี Google ของผู้ใช้
เมื่อติดตั้งแอปแล้ว ระบบจะขอให้ผู้ใช้ตรวจสอบขอบเขตที่แอปใช้ โดยทั่วไปคุณควรเลือกขอบเขตที่เจาะจงที่สุดเท่าที่จะทำได้ และหลีกเลี่ยงการขอขอบเขตที่แอปไม่จำเป็นต้องใช้ ผู้ใช้พร้อมจะให้สิทธิ์เข้าถึงขอบเขตที่จำกัดและอธิบายไว้อย่างชัดเจนมากกว่า
Gmail API รองรับขอบเขตต่อไปนี้
| โค้ดขอบเขต | คำอธิบาย | การใช้งาน |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
จัดการร่างจดหมายและส่งอีเมลเมื่อคุณโต้ตอบกับส่วนเสริม | ไม่ละเอียดอ่อน |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
ดูข้อความอีเมลเมื่อคุณโต้ตอบกับส่วนเสริม | ไม่ละเอียดอ่อน |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
ดูข้อมูลเมตาของข้อความอีเมลเมื่อส่วนเสริมทำงานอยู่ | ละเอียดอ่อน |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
ดูข้อความอีเมลเมื่อส่วนเสริมทำงานอยู่ | ละเอียดอ่อน |
https://www.googleapis.com/auth/gmail.labels |
สร้าง อ่าน อัปเดต และลบป้ายกำกับเท่านั้น | ไม่ละเอียดอ่อน |
https://www.googleapis.com/auth/gmail.send |
ส่งข้อความเท่านั้น ไม่มีสิทธิ์ในการอ่านหรือแก้ไขในกล่องจดหมาย | ละเอียดอ่อน |
https://www.googleapis.com/auth/gmail.readonly |
อ่านทรัพยากรและข้อมูลเมตาทั้งหมด โดยไม่ต้องเขียน | จำกัด |
https://www.googleapis.com/auth/gmail.compose |
สร้าง อ่าน อัปเดต และลบฉบับร่าง ส่งข้อความและฉบับร่าง | จำกัด |
https://www.googleapis.com/auth/gmail.insert |
แทรกและนำเข้าข้อความเท่านั้น | จำกัด |
https://www.googleapis.com/auth/gmail.modify |
การดำเนินการอ่าน/เขียนทั้งหมด ยกเว้นการลบชุดข้อความและข้อความแบบถาวรในทันที การข้ามผ่านถังขยะ | จำกัด |
https://www.googleapis.com/auth/gmail.metadata |
อ่านข้อมูลเมตาของทรัพยากร ซึ่งรวมถึงป้ายกำกับ บันทึกประวัติ และส่วนหัวของข้อความอีเมล แต่ไม่อ่านเนื้อหาข้อความหรือไฟล์แนบ | จำกัด |
https://www.googleapis.com/auth/gmail.settings.basic |
จัดการการตั้งค่าอีเมลพื้นฐาน | จำกัด |
https://www.googleapis.com/auth/gmail.settings.sharing |
จัดการการตั้งค่าอีเมลที่ละเอียดอ่อน รวมถึงกฎการส่งต่อและชื่อแทน
หมายเหตุ: การดำเนินการที่ป้องกันโดยขอบเขตนี้จำกัดให้ใช้ในฐานะผู้ดูแลระบบเท่านั้น ฟีเจอร์เหล่านี้ใช้ได้เฉพาะกับลูกค้า Google Workspace ที่ใช้บัญชีบริการที่มีการมอบสิทธิ์ทั่วทั้งโดเมน |
จำกัด |
https://mail.google.com/ |
สิทธิ์เข้าถึงกล่องจดหมายของบัญชีโดยสมบูรณ์ ซึ่งรวมถึงการลบชุดข้อความและข้อความอย่างถาวร ควรขอขอบเขตนี้เฉพาะในกรณีที่แอปพลิเคชันจำเป็นต้องลบชุดข้อความและข้อความทันทีและอย่างถาวร เลี่ยงการข้ามถังขยะ ส่วนการดำเนินการอื่นๆ ทั้งหมดสามารถทำได้โดยมีขอบเขตที่ให้สิทธิ์น้อยกว่า | จำกัด |
คอลัมน์การใช้งานในตารางด้านบนระบุความละเอียดอ่อนของแต่ละขอบเขตตามคำจำกัดความต่อไปนี้
ไม่ละเอียดอ่อน - ขอบเขตเหล่านี้ให้ขอบเขตการเข้าถึงที่มีขนาดเล็กที่สุดและต้องใช้การยืนยันแอปเบื้องต้นเท่านั้น สำหรับข้อมูลเพิ่มเติมเกี่ยวกับข้อกำหนดนี้ โปรดดูขั้นตอนในการเตรียมพร้อมสำหรับการยืนยัน
ละเอียดอ่อน - ขอบเขตเหล่านี้อนุญาตการเข้าถึงข้อมูลผู้ใช้ Google และต้องมีกระบวนการยืนยันขอบเขตที่มีความละเอียดอ่อน ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่บริการ Google API: นโยบายข้อมูลผู้ใช้ ขอบเขตเหล่านี้ไม่จำเป็นต้องมีการประเมินความปลอดภัย
จำกัด ขอบเขตเหล่านี้ให้สิทธิ์เข้าถึงข้อมูลผู้ใช้ Google ได้ในวงกว้าง และกำหนดให้คุณดำเนินการตามขั้นตอนการยืนยันขอบเขตที่จำกัด ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่บริการ Google API: นโยบายข้อมูลผู้ใช้และข้อกำหนดเพิ่มเติมสำหรับขอบเขต API เฉพาะ หากคุณเก็บข้อมูลขอบเขตที่จำกัดไว้ในเซิร์ฟเวอร์ (หรือส่ง) คุณจะต้องผ่านการประเมินความปลอดภัย
ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้งานและการเข้าถึง Gmail API เมื่อคุณขอสิทธิ์เข้าถึงข้อมูลผู้ใช้ได้ในนโยบายสำหรับนักพัฒนาและข้อมูลผู้ใช้ของบริการ Gmail API
หากแอปต้องมีสิทธิ์เข้าถึง Google API อื่นๆ คุณก็เพิ่มขอบเขตเหล่านั้นได้เช่นกัน สำหรับข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต Google API โปรดดูการใช้ OAuth 2.0 เพื่อเข้าถึง Google API
การยืนยัน OAuth
การใช้ขอบเขต OAuth ที่มีความละเอียดอ่อนบางขอบเขตอาจกำหนดให้แอปต้องผ่านกระบวนการยืนยัน OAuth ของ Google อ่านคำถามที่พบบ่อยเกี่ยวกับการยืนยัน OAuth เพื่อดูว่าแอปควรผ่านการยืนยันเมื่อใดและต้องใช้การยืนยันประเภทใด โปรดดูบริการ Google API: นโยบายข้อมูลผู้ใช้