เอกสารนี้มีการให้สิทธิ์เฉพาะ Gmail API และ ข้อมูลการตรวจสอบสิทธิ์ ก่อนอ่านเอกสารนี้ อย่าลืมอ่าน การตรวจสอบสิทธิ์ทั่วไปและข้อมูลการให้สิทธิ์ของ Google Workspace ที่ ดูข้อมูลเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์
กำหนดค่า OAuth 2.0 สำหรับการให้สิทธิ์
กำหนดค่าหน้าจอขอความยินยอม OAuth และเลือกขอบเขต เพื่อกําหนดข้อมูลที่จะแสดงแก่ผู้ใช้และผู้ตรวจสอบแอป รวมทั้งลงทะเบียน เพื่อเผยแพร่แอปในภายหลัง
ขอบเขต API ของ Gmail
หากต้องการกำหนดระดับการเข้าถึงที่ให้กับแอป คุณจะต้องระบุและ ประกาศขอบเขตการให้สิทธิ์ ขอบเขตการให้สิทธิ์คือสตริง 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: นโยบายข้อมูลผู้ใช้