เอกสารนี้มีการให้สิทธิ์เฉพาะ 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
ตารางต่อไปนี้แสดงขอบเขตที่รองรับสำหรับ API กิจกรรม Google Workspace:
| รหัสขอบเขต | คำอธิบาย | การใช้งาน | ||
|---|---|---|---|---|
| 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 ที่เฉพาะเจาะจง ขอบเขต หากคุณจัดเก็บข้อมูลขอบเขตที่จำกัดบนเซิร์ฟเวอร์ (หรือส่ง) คุณต้อง ทำการประเมินความปลอดภัยได้
หากแอปของคุณต้องมีสิทธิ์เข้าถึง API อื่นๆ ของ Google คุณก็สามารถเพิ่มขอบเขตเหล่านั้นได้ ได้เป็นอย่างดี โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต Google API ที่การใช้ OAuth 2.0 เพื่อ เข้าถึง Google APIs
โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต OAuth 2.0 เฉพาะที่ขอบเขต OAuth 2.0 สำหรับ Google APIs
การยืนยัน OAuth
การใช้ขอบเขต OAuth บางขอบเขตอาจกำหนดให้แอปของคุณต้องดำเนินการต่อตามขั้นตอนของ การยืนยัน OAuth กระบวนการ อ่านการยืนยัน OAuth API คำถามที่พบบ่อย เพื่อพิจารณาว่าแอปของคุณควรผ่านการยืนยันเมื่อใดและประเภทใด ต้องมีการยืนยัน โปรดดูข้อกำหนดเพิ่มเติมของ Google ไดรฟ์ บริการ
ประเภทของการตรวจสอบสิทธิ์ที่จำเป็น
ส่วนนี้จะอธิบายประเภทการตรวจสอบสิทธิ์ที่จำเป็นต้องใช้หรือรองรับ และระบุขอบเขตที่รองรับสำหรับแต่ละเมธอดของ Google Workspace Events API
สำหรับการสมัครใช้บริการกิจกรรมใน Google Chat จะใช้ Google Workspace Events API
รองรับทั้งการตรวจสอบสิทธิ์ผู้ใช้และแอปเพื่อเรียกเมธอดบางเมธอด หากเป็น API
วิธีรองรับทั้งข้อมูลเข้าสู่ระบบ ประเภทของข้อมูลเข้าสู่ระบบที่ใช้ในการเรียก
จะส่งผลต่อผลลัพธ์ที่ส่งกลับ ตัวอย่างเช่น หากคุณเรียกเมธอด
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 โดยใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะทำสิ่งต่อไปนี้ได้ ต้องระบุขอบเขตอย่างน้อยหนึ่งรายการที่สอดคล้องกับประเภทเหตุการณ์ของ การสมัครใช้บริการ
ตารางต่อไปนี้แสดงขอบเขตการให้สิทธิ์ที่รองรับสําหรับแต่ละขอบเขต ประเภทเหตุการณ์:
| เหตุการณ์ | ประเภทเหตุการณ์ | รองรับขอบเขตการให้สิทธิ์ | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| ระบบจะโพสต์หรืออัปเดตข้อความ |
|
|
||||||
| มีการเพิ่มหรือลบรีแอ็กชัน หรือเปลี่ยนรีแอ็กชันหลายรายการ |
|
|
||||||
| การเป็นสมาชิก มีการสร้าง อัปเดต หรือนำการเป็นสมาชิกออก หรือมีการเป็นสมาชิกหลายรายการ มีการเปลี่ยนแปลง |
|
|
||||||
| มีการอัปเดตหรือลบพื้นที่ทำงาน |
|
|
||||||
| Google Meet | ||||||||
| การประชุมจะเริ่มต้นหรือสิ้นสุด |
|
|
||||||
| ผู้เข้าร่วมเข้าร่วมหรือออกจากการประชุม |
|
|
||||||
| ระบบสร้างการบันทึกแล้ว |
|
|
||||||
| ระบบสร้าง transcript แล้ว |
|
|
||||||