เอกสารนี้มีข้อมูลการให้สิทธิ์และการตรวจสอบสิทธิ์เฉพาะสำหรับ Google Workspace Events API ก่อนอ่านเอกสารนี้ โปรดอ่านข้อมูลการตรวจสอบสิทธิ์และการให้สิทธิ์ทั่วไปของ Google Workspace ที่หัวข้อดูข้อมูลเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์
กำหนดค่า OAuth 2.0 สำหรับการให้สิทธิ์
กำหนดค่าหน้าจอขอความยินยอม OAuth และเลือกขอบเขตเพื่อกำหนดข้อมูลที่แสดงต่อผู้ใช้และผู้ตรวจสอบแอป และลงทะเบียนแอปเพื่อให้เผยแพร่ได้ในภายหลัง
ขอบเขตของ Google Workspace Events API
หากต้องการกำหนดระดับการเข้าถึงที่อนุญาตแก่แอป คุณต้องระบุและประกาศขอบเขตการให้สิทธิ์ ขอบเขตการให้สิทธิ์คือสตริง URI ของ OAuth 2.0 ซึ่งมีชื่อแอป Google Workspace, ประเภทข้อมูลที่แอปเข้าถึง และระดับการเข้าถึง ขอบเขตคือคําขอของแอปในการจัดการข้อมูล Google Workspace ซึ่งรวมถึงข้อมูลบัญชี Google ของผู้ใช้
เมื่อติดตั้งแอปแล้ว ระบบจะขอให้ผู้ใช้ตรวจสอบขอบเขตที่แอปใช้ โดยทั่วไป คุณควรเลือกขอบเขตที่มุ่งเน้นแคบที่สุดเท่าที่จะเป็นไปได้และหลีกเลี่ยงการขอขอบเขตที่แอปไม่จําเป็นต้องใช้ ผู้ใช้จะให้สิทธิ์เข้าถึงขอบเขตที่จำกัดและอธิบายไว้อย่างชัดเจนได้ง่ายขึ้น
เราขอแนะนำให้ใช้ขอบเขตที่ไม่ละเอียดอ่อนเมื่อเป็นไปได้ เนื่องจากจะมอบขอบเขตการเข้าถึงระดับไฟล์และจำกัดการเข้าถึงฟังก์ชันการทำงานที่เฉพาะเจาะจงซึ่งแอปต้องการ
Google Workspace Events API ใช้ขอบเขตจากแอปพลิเคชัน Google Workspace ที่รองรับการสมัครใช้บริการ หากแอปใช้ขอบเขตที่จําเป็นสําหรับการสมัครใช้บริการอยู่แล้ว คุณไม่จําเป็นต้องเพิ่มขอบเขตเพิ่มเติมเพื่อใช้ Google Workspace Events API
ตารางต่อไปนี้แสดงขอบเขตที่รองรับสําหรับ Google Workspace Events API
| รหัสขอบเขต | คำอธิบาย | การใช้งาน | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
อนุญาตให้แอป Google Chat ดูแชทและส่งข้อความ ให้สิทธิ์เข้าถึงฟีเจอร์ทั้งหมดที่มีให้ใช้งานในแอป Chat | ข้อมูลที่ไม่ละเอียดอ่อน | ||
https://www.googleapis.com/auth/chat.memberships |
ดู เพิ่ม และนำสมาชิกออกจากการสนทนาใน Google Chat | มีความละเอียดอ่อน |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
ดูสมาชิกในการสนทนาใน Google Chat | มีความละเอียดอ่อน |
||
https://www.googleapis.com/auth/chat.spaces |
สร้างการสนทนาและพื้นที่ทำงาน ตลอดจนดูหรืออัปเดตข้อมูลเมตา (รวมถึงการตั้งค่าประวัติ) ใน Google Chat | ละเอียดอ่อน | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
ดูแชทและพื้นที่ทำงานใน Google Chat | มีความละเอียดอ่อน |
||
https://www.googleapis.com/auth/chat.messages.reaction วินาที |
ดู เพิ่ม และลบความรู้สึกที่มีต่อข้อความใน Chat | มีความละเอียดอ่อน |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
ดูความรู้สึกที่มีต่อข้อความใน Chat | มีความละเอียดอ่อน |
||
https://www.googleapis.com/auth/chat.messages |
ดู เขียน ส่ง อัปเดต และลบข้อความ รวมถึงเพิ่ม ดู และลบความรู้สึกต่อข้อความ | จำกัด | ||
https://www.googleapis.com/auth/chat.messages.readonly |
ดูข้อความและความรู้สึกใน Google Chat | ถูกจํากัด |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
อนุญาตให้แอปสร้าง แก้ไข และอ่านข้อมูลเมตาเกี่ยวกับพื้นที่ทำงานที่สร้างโดยแอปของคุณ | มีความละเอียดอ่อน |
||
https://www.googleapis.com/auth/meetings.space.readonly |
อนุญาตให้แอปอ่านข้อมูลเมตาเกี่ยวกับพื้นที่การประชุมที่ผู้ใช้มีสิทธิ์เข้าถึง | มีความละเอียดอ่อน |
||
คอลัมน์การใช้งานในตารางก่อนหน้าระบุความละเอียดอ่อนของขอบเขตแต่ละรายการตามคำจำกัดความต่อไปนี้
ไม่ใช่ข้อมูลที่ละเอียดอ่อน - ขอบเขตเหล่านี้มีขอบเขตการเข้าถึงการให้สิทธิ์ที่แคบที่สุดและกำหนดให้มีการยืนยันแอปขั้นพื้นฐานเท่านั้น ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่ขั้นตอนการเตรียมพร้อมสำหรับการยืนยัน
มีความละเอียดอ่อน - ขอบเขตเหล่านี้ให้สิทธิ์เข้าถึงข้อมูลผู้ใช้ Google บางประเภทที่ผู้ใช้ให้สิทธิ์แก่แอปของคุณ โดยคุณจะต้องดำเนินการยืนยันแอปเพิ่มเติม ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่ขั้นตอนสำหรับแอปที่ขอขอบเขตที่มีความละเอียดอ่อน
ถูกจํากัด - ขอบเขตเหล่านี้ให้สิทธิ์เข้าถึงข้อมูลผู้ใช้ Google ในวงกว้าง และกำหนดให้คุณต้องทำตามกระบวนการยืนยันขอบเขตที่จำกัด ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่บริการ Google API: นโยบายข้อมูลผู้ใช้ และข้อกำหนดเพิ่มเติมสำหรับขอบเขต API เฉพาะ หากคุณจัดเก็บข้อมูลขอบเขตที่จํากัดไว้ในเซิร์ฟเวอร์ (หรือส่ง) คุณต้องผ่านการประเมินความปลอดภัย
หากแอปของคุณต้องใช้สิทธิ์เข้าถึง Google API อื่นๆ คุณสามารถเพิ่มขอบเขตเหล่านั้นได้เช่นกัน ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต Google API ได้ที่หัวข้อการใช้ OAuth 2.0 เพื่อเข้าถึง Google API
ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต OAuth 2.0 ที่เฉพาะเจาะจงได้ที่ขอบเขต OAuth 2.0 สำหรับ Google APIs
การยืนยัน OAuth
การใช้ขอบเขต OAuth บางรายการอาจกำหนดให้แอปของคุณต้องดำเนินการตามกระบวนการยืนยัน OAuth ของ Google อ่านคำถามที่พบบ่อยเกี่ยวกับการยืนยัน OAuth API เพื่อพิจารณาว่าควรยืนยันแอปเมื่อใดและต้องใช้การยืนยันประเภทใด โปรดดูที่ข้อกำหนดในการให้บริการเพิ่มเติมของ Google ไดรฟ์
ประเภทการตรวจสอบสิทธิ์ที่จำเป็น
ส่วนนี้จะอธิบายประเภทการตรวจสอบสิทธิ์ที่จําเป็นหรือรองรับ รวมถึงระบุขอบเขตที่รองรับสําหรับเมธอดแต่ละรายการของ Google Workspace Events API
สําหรับการสมัครรับข้อมูลกิจกรรมใน Google Chat นั้น Google Workspace Events API จะรองรับทั้งการตรวจสอบสิทธิ์ผู้ใช้และการตรวจสอบสิทธิ์แอปเพื่อเรียกใช้เมธอดบางอย่าง หากเมธอด API รองรับข้อมูลเข้าสู่ระบบทั้ง 2 ประเภท ประเภทข้อมูลเข้าสู่ระบบที่ใช้ในการเรียกใช้จะส่งผลต่อผลลัพธ์ที่แสดง เช่น หากคุณเรียกใช้เมธอด subscriptions.list() ที่มีการตรวจสอบสิทธิ์ผู้ใช้ API จะแสดงรายการการสมัครใช้บริการที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์เข้าถึงได้ หากคุณใช้การตรวจสอบสิทธิ์ของแอป API จะแสดงรายการการติดตามที่แอปเข้าถึงได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับประเภทการตรวจสอบสิทธิ์ของ Chat ได้ที่หัวข้อตรวจสอบสิทธิ์และให้สิทธิ์แอปใน Chat และคำขอ Google Chat API
ตารางต่อไปนี้แสดงขอบเขตและประเภทการตรวจสอบสิทธิ์ที่จําเป็นหรือรองรับสําหรับเมธอด Google Workspace Events API แต่ละรายการ
| วิธีการ | ต้องมีการตรวจสอบสิทธิ์ผู้ใช้หรือรองรับการตรวจสอบสิทธิ์ผู้ใช้ | รองรับการตรวจสอบสิทธิ์ของแอป (แอป Google Chat เท่านั้น) | ขอบเขตการให้สิทธิ์ที่รองรับ | |
|---|---|---|---|---|
| สร้างการสมัครใช้บริการ | — |
ต้องมีขอบเขตที่รองรับสําหรับเหตุการณ์แต่ละประเภท
|
||
| สมัครใช้บริการ |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ วิธีการนี้ต้องใช้ขอบเขตที่รองรับเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ
เมื่อใช้การตรวจสอบสิทธิ์ของแอป (แอป Google Chat เท่านั้น)
|
|||
| แสดงรายการการสมัครใช้บริการ |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ วิธีการนี้ต้องใช้ขอบเขตที่รองรับเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ
เมื่อใช้การตรวจสอบสิทธิ์ของแอป (แอป Google Chat เท่านั้น)
|
|||
| อัปเดตการสมัครใช้บริการ | — |
ต้องมีขอบเขตที่รองรับสําหรับเหตุการณ์แต่ละประเภท
|
||
| เปิดใช้งานการสมัครใช้บริการอีกครั้ง | — |
ต้องมีขอบเขตที่รองรับสําหรับเหตุการณ์แต่ละประเภท
|
||
| ลบการสมัครใช้บริการ |
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ วิธีการนี้ต้องใช้ขอบเขตที่รองรับเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ
เมื่อใช้การตรวจสอบสิทธิ์ของแอป (แอป Google Chat เท่านั้น)
|
|||
ขอบเขตตามประเภทเหตุการณ์
เมื่อเรียกใช้ Google Workspace Events API โดยใช้การตรวจสอบสิทธิ์ของผู้ใช้ คุณต้องระบุขอบเขตอย่างน้อย 1 รายการที่สอดคล้องกับประเภทกิจกรรมของการสมัครใช้บริการ
ตารางต่อไปนี้แสดงขอบเขตการให้สิทธิ์ที่รองรับสำหรับกิจกรรมแต่ละประเภท
| เหตุการณ์ | ประเภทเหตุการณ์ | ขอบเขตการให้สิทธิ์ที่รองรับ | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| โพสต์หรืออัปเดตข้อความ |
|
|
||||||
| มีการเพิ่มหรือลบรีแอ็กชัน หรือมีการเปลี่ยนแปลงรีแอ็กชันหลายรายการ |
|
|
||||||
| มีการสร้าง อัปเดต หรือนำการเป็นสมาชิกออก หรือมีการเปลี่ยนแปลงการเป็นสมาชิกหลายรายการ |
|
|
||||||
| มีการอัปเดตหรือลบพื้นที่ทำงาน |
|
|
||||||
| Google Meet | ||||||||
| การประชุมเริ่มต้นหรือสิ้นสุด |
|
|
||||||
| ผู้เข้าร่วมเข้าร่วมหรือออกจากการประชุม |
|
|
||||||
| ระบบสร้างไฟล์บันทึกเสียงแล้ว |
|
|
||||||
| ระบบสร้างข้อความถอดเสียงแล้ว |
|
|
||||||