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