เอกสารนี้มีการให้สิทธิ์เฉพาะ 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 |
ดู เขียน ส่ง อัปเดต และลบข้อความ รวมถึงเพิ่ม ดู และลบความรู้สึกต่อข้อความ | ถูกจำกัด | ||
https://www.googleapis.com/auth/chat.messages.readonly |
ดูข้อความและความรู้สึกใน Google Chat | จำกัด |
||
https://www.googleapis.com/auth/chat.messages.reaction วิ |
ดู เพิ่ม และลบความรู้สึกที่มีต่อข้อความใน Chat | จำกัด |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
ดูความรู้สึกที่มีต่อข้อความใน Chat | จำกัด |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
อนุญาตให้แอปสร้าง แก้ไข และอ่านข้อมูลเมตาเกี่ยวกับพื้นที่ประชุมที่แอปของคุณสร้างขึ้น | ละเอียดอ่อน |
||
https://www.googleapis.com/auth/meetings.space.readonly |
อนุญาตให้แอปอ่านข้อมูลเมตาเกี่ยวกับพื้นที่ประชุมที่ผู้ใช้มีสิทธิ์เข้าถึง | ละเอียดอ่อน |
||
คอลัมน์การใช้งานในตารางก่อนหน้านี้ระบุถึงความละเอียดอ่อนของแต่ละขอบเขตตามคำจำกัดความต่อไปนี้
ไม่ละเอียดอ่อน - ขอบเขตเหล่านี้ให้ขอบเขตที่เล็กที่สุดในการเข้าถึงการให้สิทธิ์ และใช้เฉพาะการยืนยันแอปพื้นฐานเท่านั้น ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่ขั้นตอนในการเตรียมพร้อมสำหรับการยืนยันตัวตน
มีความละเอียดอ่อน - ขอบเขตเหล่านี้ให้สิทธิ์การเข้าถึงข้อมูลผู้ใช้ Google ที่เฉพาะเจาะจงซึ่งผู้ใช้ให้สิทธิ์สำหรับแอปของคุณ คุณจำเป็นต้องผ่านการยืนยันแอปเพิ่มเติม ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่ขั้นตอนสำหรับแอปที่ขอขอบเขตที่ละเอียดอ่อน
จำกัด - ขอบเขตเหล่านี้ให้สิทธิ์เข้าถึงข้อมูลผู้ใช้ Google ในวงกว้าง และกำหนดให้คุณต้องเข้าสู่กระบวนการยืนยันขอบเขตที่จำกัด ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่บริการ Google API: นโยบายข้อมูลผู้ใช้และข้อกำหนดเพิ่มเติมสำหรับขอบเขต API เฉพาะ หากคุณจัดเก็บข้อมูลขอบเขตที่จำกัดไว้ในเซิร์ฟเวอร์ (หรือส่ง) คุณจะต้องเข้าสู่การประเมินความปลอดภัย
หากแอปต้องการเข้าถึง API อื่นๆ ของ Google คุณจะเพิ่มขอบเขตเหล่านั้นได้เช่นกัน ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต 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 | ||||||||
| การประชุมจะเริ่มต้นหรือสิ้นสุด |
|
|
||||||
| ผู้เข้าร่วมเข้าร่วมหรือออกจากการประชุม |
|
|
||||||
| สร้างไฟล์บันทึกเสียงแล้ว |
|
|
||||||
| สร้างข้อความถอดเสียงแล้ว |
|
|
||||||