ผู้ใช้ต้องให้สิทธิ์ส่วนเสริมและแอปพลิเคชันอื่นๆ ที่เข้าถึงข้อมูลของตน หรือดำเนินการในนามของตน เมื่อผู้ใช้เรียกใช้ส่วนเสริมเป็นครั้งแรก UI ของส่วนเสริมจะแสดงข้อความแจ้งการให้สิทธิ์เพื่อเริ่มขั้นตอนการให้สิทธิ์
ในระหว่างขั้นตอนการทำงานนี้ พรอมต์จะแจ้งให้ผู้ใช้ทราบว่าแอปพลิเคชันต้องการ สิทธิ์ทำอะไร เช่น ส่วนเสริมอาจต้องการสิทธิ์ในการอ่านข้อความอีเมลของผู้ใช้ หรือสร้างกิจกรรมในปฏิทินของผู้ใช้ โปรเจ็กต์สคริปต์ของส่วนเสริมจะกำหนดสิทธิ์แต่ละรายการเหล่านี้เป็นขอบเขต OAuth
คุณประกาศขอบเขตในไฟล์ Manifest
โดยใช้สตริง URL ในระหว่างโฟลว์การให้สิทธิ์ Apps Script จะแสดงคำอธิบายขอบเขตที่มนุษย์อ่านได้ต่อผู้ใช้ เช่น ส่วนเสริม Google Workspace
อาจใช้ขอบเขต "อ่านข้อความปัจจุบัน" ซึ่งเขียนไว้ในไฟล์ Manifest เป็น
https://www.googleapis.com/auth/gmail.addons.current.message.readonly
ในระหว่างโฟลว์การให้สิทธิ์ ส่วนเสริมที่มีขอบเขตนี้จะขอให้ผู้ใช้อนุญาตให้ส่วนเสริมดูข้อความอีเมลเมื่อส่วนเสริมทำงาน
ขอบเขตการดู
คุณดูขอบเขตที่โปรเจ็กต์สคริปต์ต้องใช้ในปัจจุบันได้โดยทำดังนี้
- เปิดโปรเจ็กต์สคริปต์
- คลิกภาพรวม ทางด้านซ้าย
- ดูขอบเขตในส่วน "ขอบเขต OAuth ของโปรเจ็กต์"
นอกจากนี้ คุณยังดูขอบเขตปัจจุบันของโปรเจ็กต์สคริปต์ได้ในไฟล์ Manifest ของโปรเจ็กต์
ในฟิลด์ oauthScopes
แต่จะดูได้ก็ต่อเมื่อคุณตั้งค่าขอบเขตเหล่านั้นอย่างชัดเจนเท่านั้น
การตั้งค่าขอบเขตที่ชัดเจน
Apps Script จะกำหนดขอบเขตที่สคริปต์ต้องการโดยอัตโนมัติด้วยการสแกน โค้ดเพื่อหาการเรียกฟังก์ชันที่ต้องใช้ขอบเขต สำหรับสคริปต์ส่วนใหญ่ การดำเนินการนี้ก็เพียงพอและช่วยประหยัดเวลา แต่สำหรับส่วนเสริมที่เผยแพร่แล้ว คุณควรควบคุมขอบเขตโดยตรงมากขึ้น
ตัวอย่างเช่น Apps Script อาจให้สิทธิ์เข้าถึงที่กว้างมากแก่โปรเจ็กต์สคริปต์ส่วนเสริมhttps://mail.google.com
โดยค่าเริ่มต้น เมื่อผู้ใช้ให้สิทธิ์โปรเจ็กต์สคริปต์ที่มีขอบเขตนี้ โปรเจ็กต์จะได้รับสิทธิ์เข้าถึงบัญชี Gmail ของผู้ใช้โดยสมบูรณ์ สำหรับส่วนเสริมที่เผยแพร่แล้ว คุณต้องแทนที่ขอบเขตนี้ด้วยชุดขอบเขตที่จำกัดมากขึ้นซึ่งครอบคลุมความต้องการของส่วนเสริมและไม่มีขอบเขตอื่นๆ
คุณตั้งค่าขอบเขตที่โปรเจ็กต์สคริปต์ใช้ได้อย่างชัดเจนโดยการแก้ไขไฟล์Manifest ฟิลด์ไฟล์ Manifest
oauthScopes
คืออาร์เรย์
ของขอบเขตทั้งหมดที่ส่วนเสริมใช้ หากต้องการตั้งค่าขอบเขตของโปรเจ็กต์ ให้ทำดังนี้
- ดูขอบเขตที่ส่วนเสริมใช้อยู่ในปัจจุบัน พิจารณาว่าต้องทำการเปลี่ยนแปลงใดบ้าง เช่น การใช้ขอบเขตที่แคบลง
- เปิดไฟล์ Manifest ของส่วนเสริม
- ค้นหาฟิลด์ระดับบนสุดที่มีป้ายกำกับว่า
oauthScopes
หากไม่มี คุณก็เพิ่มได้ ฟิลด์
oauthScopes
ระบุอาร์เรย์ของสตริง หากต้องการตั้งค่าขอบเขตที่โปรเจ็กต์ใช้ ให้แทนที่เนื้อหาของอาร์เรย์นี้ด้วยขอบเขตที่คุณต้องการให้ใช้ เช่น สำหรับส่วนเสริม Google Workspace ที่ขยาย Gmail คุณอาจมีสิ่งต่อไปนี้{ ... "oauthScopes": [ "https://www.googleapis.com/auth/gmail.addons.current.message.metadata", "https://www.googleapis.com/auth/userinfo.email" ], ... }
บันทึกการเปลี่ยนแปลงไฟล์ Manifest
การยืนยัน OAuth
การใช้ขอบเขต OAuth ที่มีความละเอียดอ่อนบางอย่างอาจกำหนดให้ส่วนเสริมต้องผ่านการยืนยันไคลเอ็นต์ OAuth ก่อนจึงจะเผยแพร่ได้ ดูข้อมูลเพิ่มเติมได้ที่คู่มือต่อไปนี้
- การยืนยันไคลเอ็นต์ OAuth สำหรับ Apps Script
- แอปที่ไม่ผ่านการตรวจสอบ
- คำถามที่พบบ่อยเกี่ยวกับการยืนยัน OAuth
- บริการ Google API: นโยบายข้อมูลผู้ใช้
ขอบเขตที่จำกัด
ขอบเขตบางอย่างถูกจำกัดและอยู่ภายใต้กฎเพิ่มเติมที่ช่วย ปกป้องข้อมูลผู้ใช้ หากคุณต้องการเผยแพร่ส่วนเสริมของ Gmail หรือ Editor ที่ใช้ขอบเขตที่ถูกจำกัดอย่างน้อย 1 รายการ ส่วนเสริมต้องเป็นไปตามข้อจำกัดที่ระบุทั้งหมดก่อนจึงจะเผยแพร่ได้
โปรดดูรายการขอบเขตที่ถูกจำกัดทั้งหมด ก่อนที่จะพยายามเผยแพร่ หากส่วนเสริมใช้ API ใดก็ตาม คุณต้องปฏิบัติตามข้อกำหนดเพิ่มเติมสำหรับขอบเขต API ที่เฉพาะเจาะจง ก่อนที่จะเผยแพร่
ส่วนขยายเครื่องมือสำหรับนักพัฒนาซอฟต์แวร์ Google Workspace สำหรับ Visual Studio Code จะให้ข้อมูลการวินิจฉัยสำหรับขอบเขตทั้งหมด ซึ่งรวมถึงคำอธิบายของขอบเขตและระบุว่าขอบเขตนั้นเป็นข้อมูลที่ละเอียดอ่อนหรือถูกจำกัดหรือไม่
เลือกขอบเขตสำหรับส่วนเสริมของ Google Workspace
ส่วนต่อไปนี้จะระบุขอบเขตที่ใช้กันโดยทั่วไปสำหรับ ส่วนเสริมของ Google Workspace
ขอบเขตของตัวแก้ไข
ด้านล่างนี้คือขอบเขตที่ใช้บ่อยสำหรับส่วนเสริมของ Google Workspace ที่ขยายเอกสาร ชีต และสไลด์
ขอบเขต | |
---|---|
การเข้าถึงไฟล์เอกสารปัจจุบัน |
https://www.googleapis.com/auth/documents.currentonly
ต้องระบุหากส่วนเสริมเข้าถึง Apps Script Docs API ให้สิทธิ์เข้าถึงเนื้อหาของเอกสารที่เปิดอยู่ชั่วคราว |
การเข้าถึงไฟล์ชีตปัจจุบัน |
https://www.googleapis.com/auth/spreadsheets.currentonly
ต้องระบุหากส่วนเสริมเข้าถึง Apps Script Sheets API ให้สิทธิ์เข้าถึงเนื้อหาของสเปรดชีตแบบเปิดชั่วคราว |
การเข้าถึงไฟล์สไลด์ปัจจุบัน |
https://www.googleapis.com/auth/presentations.currentonly
ต้องระบุหากส่วนเสริมเข้าถึง Apps Script Slides API ให้สิทธิ์เข้าถึงเนื้อหาของงานนำเสนอแบบเปิดชั่วคราว |
การเข้าถึงต่อไฟล์ |
https://www.googleapis.com/auth/drive.file
ต้องใช้เพื่อให้ส่วนเสริมใช้ |
Gmail
มีขอบเขตบางอย่างที่สร้างขึ้นมาสำหรับส่วนเสริมของ Google Workspace โดยเฉพาะเพื่อช่วยปกป้องข้อมูล Gmail ของผู้ใช้ คุณต้องเพิ่มขอบเขตเหล่านี้อย่างชัดแจ้งลงในไฟล์ Manifest ของส่วนเสริม พร้อมกับขอบเขตอื่นๆ ที่โค้ดของส่วนเสริมต้องการ
ด้านล่างนี้คือขอบเขตที่ใช้บ่อยสำหรับส่วนเสริมของ Google Workspace ที่ขยาย Gmail ส่วนที่ติดป้ายกำกับว่าต้องระบุจะต้องเพิ่มลงใน ไฟล์ Manifest ของส่วนเสริม Google Workspace หากส่วนเสริมขยาย Gmail
อย่าลืมแทนที่https://mail.google.com
ขอบเขตที่กว้างมากในส่วนเสริม
ด้วยชุดขอบเขตที่แคบลงซึ่งอนุญาตให้มีการโต้ตอบที่ส่วนเสริม
ต้องการและไม่มากไปกว่านั้น
ขอบเขต | |
---|---|
สร้างฉบับร่างใหม่ |
https://www.googleapis.com/auth/gmail.addons.current.action.compose
ต้องระบุหากส่วนเสริมใช้ ทริกเกอร์การดำเนินการเขียน อนุญาตให้ส่วนเสริมสร้างข้อความฉบับร่างใหม่และ การตอบกลับชั่วคราว ดูรายละเอียดได้ที่ การเขียนข้อความฉบับร่าง โดยขอบเขตนี้มักใช้ร่วมกับ การดำเนินการเขียนด้วย ต้องใช้โทเค็นเพื่อการเข้าถึง |
อ่านข้อมูลเมตาของข้อความที่เปิด |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata
ให้สิทธิ์เข้าถึงข้อมูลเมตาของข้อความที่เปิดอยู่ชั่วคราว (เช่น
หัวเรื่องหรือผู้รับ) ไม่อนุญาตให้อ่านเนื้อหาของข้อความ
และต้องใช้โทเค็นเพื่อการเข้าถึง ต้องระบุหากส่วนเสริมใช้ข้อมูลเมตาในการดำเนินการเขียน ทริกเกอร์ สำหรับ การดำเนินการเขียน จะต้องมีขอบเขตนี้หากทริกเกอร์การเขียน ต้องการเข้าถึงข้อมูลเมตา ในทางปฏิบัติ ขอบเขตนี้จะช่วยให้การเขียน ทริกเกอร์การเข้าถึงรายชื่อผู้รับ (ถึง:, สำเนา:, และสำเนาลับ:) ของอีเมลฉบับร่าง ตอบกลับ |
อ่านเนื้อหาข้อความที่เปิดอยู่ |
https://www.googleapis.com/auth/gmail.addons.current.message.action
ให้สิทธิ์เข้าถึงเนื้อหาของข้อความที่เปิดเมื่อผู้ใช้โต้ตอบ เช่น เมื่อเลือกรายการเมนูส่วนเสริม ต้องใช้โทเค็นเพื่อการเข้าถึง |
อ่านเนื้อหาของชุดข้อความที่เปิดอยู่ |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly
ให้สิทธิ์เข้าถึงข้อมูลเมตาและเนื้อหาของข้อความที่เปิดชั่วคราว รวมถึงให้สิทธิ์เข้าถึงเนื้อหาของข้อความอื่นๆ ในชุดข้อความที่เปิดอยู่ด้วย ต้องใช้โทเค็นเพื่อการเข้าถึง |
อ่านเนื้อหาและข้อมูลเมตาของข้อความ |
https://www.googleapis.com/auth/gmail.readonly
อ่านข้อมูลเมตาและเนื้อหาของอีเมล รวมถึงข้อความที่เปิด ต้องระบุหากคุณต้องการอ่านข้อมูลเกี่ยวกับข้อความอื่นๆ เช่น เมื่อดำเนินการค้นหาหรืออ่านชุดข้อความอีเมลทั้งหมด |
ขอบเขตของ Google ปฏิทิน
ด้านล่างนี้คือขอบเขตที่ใช้บ่อยสำหรับส่วนเสริม Google Workspace ที่ขยาย Google ปฏิทิน
ขอบเขต | |
---|---|
เข้าถึงข้อมูลเมตาของเหตุการณ์ |
https://www.googleapis.com/auth/calendar.addons.execute
ต้องระบุหากส่วนเสริมเข้าถึงข้อมูลเมตาของกิจกรรมในปฏิทิน อนุญาต ให้ส่วนเสริมเข้าถึงข้อมูลเมตาของกิจกรรม |
อ่านข้อมูลเหตุการณ์ที่ผู้ใช้สร้างขึ้น |
https://www.googleapis.com/auth/calendar.addons.current.event.read
ต้องระบุหากส่วนเสริมต้องอ่านข้อมูลเหตุการณ์ที่ผู้ใช้สร้างขึ้น
อนุญาตให้ส่วนเสริมเข้าถึงข้อมูลเหตุการณ์ที่ผู้ใช้สร้างขึ้น ข้อมูลนี้จะใช้ได้
ก็ต่อเมื่อตั้งค่า
ฟิลด์ Manifest ของ |
เขียนข้อมูลเหตุการณ์ที่ผู้ใช้สร้างขึ้น |
https://www.googleapis.com/auth/calendar.addons.current.event.write
ต้องระบุหากส่วนเสริมต้องเขียนข้อมูลเหตุการณ์ที่ผู้ใช้สร้างขึ้น
อนุญาตให้ส่วนเสริมแก้ไขข้อมูลเหตุการณ์ที่ผู้ใช้สร้างขึ้น ข้อมูลนี้จะใช้ได้
ก็ต่อเมื่อตั้งค่า
ฟิลด์ Manifest ของ |
ขอบเขตของ Google Chat
หากต้องการเรียกใช้ Chat API คุณต้องตรวจสอบสิทธิ์ในฐานะผู้ใช้ Google Chat หรือในฐานะแอปใน Chat การตรวจสอบสิทธิ์แต่ละประเภทต้องใช้ขอบเขตที่แตกต่างกัน และเมธอด Chat API บางรายการไม่รองรับการตรวจสอบสิทธิ์ของแอป
ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขตของ Chat และประเภทการตรวจสอบสิทธิ์ได้ที่ภาพรวมการตรวจสอบสิทธิ์และการให้สิทธิ์ของ Chat API
ตารางต่อไปนี้แสดงเมธอดและขอบเขตของ Chat API ที่ใช้บ่อย ตามประเภทการตรวจสอบสิทธิ์ที่รองรับ
วิธีการ | รองรับการตรวจสอบสิทธิ์ของผู้ใช้ | รองรับการตรวจสอบสิทธิ์แอป | ขอบเขตการให้สิทธิ์ที่รองรับ | |
---|---|---|---|---|
ส่งข้อความ |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ให้ทำดังนี้
|
|||
สร้างพื้นที่ทำงาน |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ให้ทำดังนี้
|
|||
สร้างและเพิ่มสมาชิกไปยังพื้นที่ทำงาน | — |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ให้ทำดังนี้
|
||
เพิ่มผู้ใช้ลงในพื้นที่ทำงาน |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ให้ทำดังนี้
|
|||
แสดงกิจกรรมหรือเหตุการณ์จากพื้นที่ใน Chat | — |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้
คุณต้องใช้ขอบเขตสำหรับ
ประเภทเหตุการณ์แต่ละรายการที่รวมอยู่ในคำขอ
|
ขอบเขตของ Google ไดรฟ์
ด้านล่างนี้คือขอบเขตที่ใช้บ่อยสำหรับส่วนเสริม Google Workspace ที่ขยาย Google ไดรฟ์
ขอบเขต | |
---|---|
อ่านข้อมูลเมตาของรายการที่เลือก |
https://www.googleapis.com/auth/drive.addons.metadata.readonly
ต้องระบุหากส่วนเสริมใช้ส่วนติดต่อตามบริบทที่ทริกเกอร์ เมื่อผู้ใช้เลือกรายการในไดรฟ์ อนุญาตให้ส่วนเสริมอ่านข้อมูลเมตาแบบจำกัดเกี่ยวกับรายการที่ผู้ใช้เลือกใน Google ไดรฟ์ ข้อมูลเมตาจะจำกัดไว้ที่รหัสของรายการ ชื่อ ประเภท MIME, URL ของไอคอน และดูว่าส่วนเสริมมีสิทธิ์ เข้าถึงรายการหรือไม่ |
การเข้าถึงต่อไฟล์ |
https://www.googleapis.com/auth/drive.file
แนะนำในกรณีที่ส่วนเสริมต้องเข้าถึงไฟล์แต่ละไฟล์ในไดรฟ์
ให้สิทธิ์เข้าถึงไฟล์แต่ละไฟล์ที่แอปสร้างหรือเปิด โดยใช้บริการขั้นสูงของไดรฟ์ใน Apps Script แต่การดำเนินการนี้ไม่ได้อนุญาตให้ใช้การดำเนินการที่คล้ายกันโดยใช้
บริการไดรฟ์พื้นฐาน
ระบบจะให้สิทธิ์ไฟล์ทีละไฟล์และจะเพิกถอนสิทธิ์เมื่อผู้ใช้ยกเลิกการให้สิทธิ์แอป |
โทเค็นเพื่อการเข้าถึง
ขอบเขต Gmail ที่ใช้ในส่วนเสริมของ Google Workspace จะให้สิทธิ์เข้าถึงข้อมูลผู้ใช้แบบชั่วคราวเท่านั้นเพื่อปกป้องข้อมูลผู้ใช้ หากต้องการเปิดใช้สิทธิ์เข้าถึงชั่วคราว คุณต้องเรียกใช้ฟังก์ชัน
GmailApp.setCurrentMessageAccessToken(accessToken)
โดยใช้โทเค็นเพื่อการเข้าถึงเป็นอาร์กิวเมนต์ คุณต้องขอรับโทเค็นเพื่อการเข้าถึงจาก
ออบเจ็กต์เหตุการณ์การกระทํา
ตัวอย่างต่อไปนี้แสดงการตั้งค่าโทเค็นเพื่อการเข้าถึงเพื่ออนุญาตให้เข้าถึง
ข้อมูลเมตาของข้อความ ขอบเขตที่จำเป็นสำหรับตัวอย่างนี้คือ
https://www.googleapis.com/auth/gmail.addons.current.message.metadata
function readSender(e) {
var accessToken = e.gmail.accessToken;
var messageId = e.gmail.messageId;
// The following function enables short-lived access to the current
// message in Gmail. Access to other Gmail messages or data isn't
// permitted.
GmailApp.setCurrentMessageAccessToken(accessToken);
var mailMessage = GmailApp.getMessageById(messageId);
return mailMessage.getFrom();
}
ขอบเขตอื่นๆ ของ Google Workspace
ส่วนเสริมอาจต้องใช้ขอบเขตเพิ่มเติมหากใช้บริการอื่นๆ ของ Google Workspace หรือ Apps Script ในกรณีส่วนใหญ่ คุณสามารถปล่อยให้ Apps Script ตรวจหาสขอบเขตเหล่านี้และอัปเดต ไฟล์ Manifest โดยอัตโนมัติได้ เมื่อแก้ไขรายการขอบเขตของไฟล์ Manifest อย่าลบขอบเขตใดๆ ออก เว้นแต่คุณจะแทนที่ด้วยทางเลือกที่เหมาะสมกว่า เช่น ขอบเขตที่แคบลง
ตารางต่อไปนี้แสดงรายการขอบเขตที่ส่วนเสริมของ Google Workspace มักใช้
ขอบเขต | |
---|---|
อ่านอีเมลของผู้ใช้ |
https://www.googleapis.com/auth/userinfo.email
อนุญาตให้โปรเจ็กต์อ่านอีเมลของผู้ใช้ปัจจุบัน |
อนุญาตการเรียกใช้บริการภายนอก |
https://www.googleapis.com/auth/script.external_request
อนุญาตให้โปรเจ็กต์ส่งคำขอ
|
อ่านภาษาและเขตเวลาของผู้ใช้ |
https://www.googleapis.com/auth/script.locale
อนุญาตให้โปรเจ็กต์ทราบภาษาและเขตเวลาของผู้ใช้ปัจจุบัน ดูรายละเอียดได้ที่ การเข้าถึงภาษาและเขตเวลาของผู้ใช้ |
สร้างทริกเกอร์ |
https://www.googleapis.com/auth/script.scriptapp
อนุญาตให้โปรเจ็กต์สร้าง ทริกเกอร์ |
แสดงตัวอย่างลิงก์ของบุคคลที่สาม |
https://www.googleapis.com/auth/workspace.linkpreview
ต้องระบุหากส่วนเสริมแสดงตัวอย่างลิงก์จากบริการของบุคคลที่สาม อนุญาตให้โปรเจ็กต์เห็นลิงก์ภายในแอปพลิเคชัน Google Workspace ขณะที่ผู้ใช้โต้ตอบกับลิงก์ ดูข้อมูลเพิ่มเติมได้ที่ แสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ |
สร้างแหล่งข้อมูลของบุคคลที่สาม |
https://www.googleapis.com/auth/workspace.linkcreate
ต้องระบุหากส่วนเสริมสร้างทรัพยากรในบริการของบุคคลที่สาม อนุญาตให้โปรเจ็กต์อ่านข้อมูลที่ผู้ใช้ส่งไปยัง แบบฟอร์มการสร้างทรัพยากรและ แทรกลิงก์ไปยังทรัพยากรภายในแอปพลิเคชัน Google Workspace ดูข้อมูลเพิ่มเติมได้ที่ สร้างทรัพยากรของบุคคลที่สามจากเมนู @ |