เลือกขอบเขต Gmail API

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

ขอบเขตที่ละเอียดอ่อน

รหัสขอบเขต คำอธิบาย
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.send ส่งอีเมลในนามของคุณ

ขอบเขตที่จำกัด

รหัสขอบเขต คำอธิบาย
https://mail.google.com/ อ่าน เขียน ส่ง และลบอีเมลทั้งหมดใน Gmail อย่างถาวร

หมายเหตุ: ขอขอบเขตนี้เฉพาะในกรณีที่แอปพลิเคชันของคุณต้อง ลบเธรดและข้อความทันทีและถาวร โดยข้ามถังขยะ คุณดำเนินการอื่นๆ ทั้งหมดได้โดยใช้ขอบเขตที่ให้สิทธิ์น้อยกว่า
https://www.googleapis.com/auth/gmail.readonly ดูข้อความอีเมลและการตั้งค่าของคุณ
https://www.googleapis.com/auth/gmail.compose จัดการร่างจดหมายและส่งอีเมล
https://www.googleapis.com/auth/gmail.insert เพิ่มอีเมลลงในกล่องจดหมาย Gmail
https://www.googleapis.com/auth/gmail.modify อ่าน เขียน และส่งอีเมลจากบัญชี Gmail ขอบเขตนี้ ไม่อนุญาตให้ลบเธรดและข้อความอย่างถาวรในทันที โดยข้ามถังขยะ
https://www.googleapis.com/auth/gmail.metadata ดูข้อมูลเมตาของข้อความอีเมล เช่น ป้ายกำกับและส่วนหัว แต่ไม่ดูเนื้อความของอีเมล
https://www.googleapis.com/auth/gmail.settings.basic ดู แก้ไข สร้าง หรือเปลี่ยนการตั้งค่าและตัวกรองอีเมลใน Gmail
https://www.googleapis.com/auth/gmail.settings.sharing จัดการการตั้งค่าอีเมลที่ละเอียดอ่อน รวมถึงกำหนดว่าใครสามารถจัดการอีเมลของคุณ

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

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

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

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

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

การยืนยัน OAuth

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