หน้านี้อธิบายเหตุการณ์ของ Chat ที่แอป Chat สามารถสมัครรับข้อมูลได้โดยใช้ Google Workspace Events API หลังจากตัดสินใจเลือกประเภทเหตุการณ์ที่ต้องการแล้ว ให้สร้างการสมัครรับข้อมูลเพื่อเริ่ม รับเหตุการณ์จาก Chat
นอกจากการสมัครรับข้อมูลเหตุการณ์แล้ว คุณยังค้นหาเหตุการณ์ได้ด้วยการเรียก Google Chat API การเรียก Chat API ช่วยให้คุณดึงข้อมูลเหตุการณ์เป็นระยะๆ หรือติดตามเหตุการณ์ที่คุณอาจพลาดไปจากการสมัครรับข้อมูลเนื่องจากบริการหยุดทำงาน ดูข้อมูลเกี่ยวกับวิธีรับและตอบสนองต่อเหตุการณ์ของ Chat ได้ที่หัวข้อ ทำงานกับเหตุการณ์จาก Chat ใน เอกสารประกอบของ Chat
เหตุการณ์ของ Chat ที่รองรับ
การสมัครใช้บริการ Google Workspace ช่วยให้คุณรับเหตุการณ์เกี่ยวกับการเปลี่ยนแปลงประเภทต่อไปนี้ใน Chat ได้
- ข้อความใหม่ อัปเดต หรือลบ ข้อความ ในพื้นที่ทำงาน
- การแสดงความรู้สึกใหม่หรือนำออก ต่อข้อความ
- สมาชิกใหม่ อัปเดต หรือนำออก สมาชิก ในพื้นที่ทำงาน
- การเปลี่ยนแปลงพื้นที่ทำงาน ที่คุณสมัครรับข้อมูล เช่น ชื่อหรือคำอธิบายพื้นที่ทำงานที่อัปเดต
ทรัพยากรที่คุณตรวจสอบหาเหตุการณ์ได้
หากต้องการรับเหตุการณ์ ให้ระบุทรัพยากร Chat ที่จะตรวจสอบ ซึ่งเรียกว่า ทรัพยากรเป้าหมายของการสมัครรับข้อมูล
Google Workspace Events API รองรับทรัพยากรเป้าหมายต่อไปนี้สำหรับ Chat
| ทรัพยากรเป้าหมาย | รูปแบบ | ข้อจำกัด |
|---|---|---|
| พื้นที่ทำงาน |
โดยที่ SPACE คือรหัสใน
ชื่อทรัพยากรของทรัพยากร |
ผู้ใช้ Chat หรือแอป Chat ที่ให้สิทธิ์การสมัครรับข้อมูลต้อง เป็นสมาชิกของพื้นที่ทำงานผ่านบัญชี Google Workspace หรือบัญชี Google รองรับสิ่งต่อไปนี้ |
| พื้นที่ทำงานทั้งหมดของผู้ใช้ |
|
การสมัครรับข้อมูลจะรับเหตุการณ์สำหรับพื้นที่ทำงานที่ผู้ใช้เป็นสมาชิกผ่านบัญชี Google Workspace หรือบัญชี Google เท่านั้น รองรับเฉพาะการตรวจสอบสิทธิ์ของผู้ใช้ |
| ผู้ใช้ |
โดยที่ USER คือรหัสใน
ชื่อทรัพยากรของทรัพยากร |
การสมัครรับข้อมูลจะรับเหตุการณ์เกี่ยวกับผู้ใช้ที่ ให้สิทธิ์การสมัครรับข้อมูลเท่านั้น ผู้ใช้ไม่สามารถให้สิทธิ์การสมัครรับข้อมูลในนามของผู้ใช้รายอื่นได้ รองรับเฉพาะการตรวจสอบสิทธิ์ของผู้ใช้ |
ประเภทเหตุการณ์สำหรับการสร้างการสมัครรับข้อมูล
เมื่อสร้างการสมัครรับข้อมูล ให้ใช้ช่อง
eventTypes[]
เพื่อระบุประเภทเหตุการณ์ที่ต้องการรับ ประเภทเหตุการณ์จะ
จัดรูปแบบตามข้อกำหนด CloudEvents เช่น
google.workspace.APPLICATION.RESOURCE.VERSION.ACTION
ตัวอย่างเช่น หากต้องการรับเหตุการณ์เกี่ยวกับผู้ใช้ที่เข้าร่วมพื้นที่ทำงาน Chat ให้ระบุพื้นที่ทำงานเป็นทรัพยากรเป้าหมาย และประเภทเหตุการณ์เป็น google.workspace.chat.membership.v1.created หากต้องการรับเหตุการณ์เกี่ยวกับผู้ใช้ที่เข้าร่วมพื้นที่ทำงาน ให้ระบุผู้ใช้เป็นทรัพยากรเป้าหมาย และประเภทเหตุการณ์เป็น google.workspace.chat.membership.v1.created ดูข้อมูลเพิ่มเติมเกี่ยวกับ
วิธีทำงานของเหตุการณ์ได้ที่ โครงสร้างของเหตุการณ์ Google Workspace
เหตุการณ์
ตารางต่อไปนี้แสดงประเภทเหตุการณ์ที่รองรับสำหรับการสมัครรับข้อมูลพื้นที่ทำงานและการสมัครรับข้อมูลผู้ใช้ ดูข้อมูลเกี่ยวกับข้อยกเว้นเกี่ยวกับ สิ่งที่จะทริกเกอร์เหตุการณ์ได้ที่ ข้อจำกัด
| ประเภทเหตุการณ์ | รูปแบบ | ข้อมูลทรัพยากร | ||
|---|---|---|---|---|
| การสมัครรับข้อมูลพื้นที่ทำงาน | ||||
| มีการโพสต์ข้อความ |
|
|
||
| มีการอัปเดตข้อความ |
|
|
||
| มีการลบข้อความ |
|
|
||
| มีการสร้างการแสดงความรู้สึก |
|
|
||
| มีการลบการแสดงความรู้สึก |
|
|
||
| มีการเพิ่มสมาชิกในพื้นที่ทำงาน |
|
|
||
| มีการอัปเดตสมาชิกในพื้นที่ทำงาน |
|
|
||
| มีการนำสมาชิกออกจากพื้นที่ทำงาน |
|
|
||
| มีการอัปเดตพื้นที่ทำงาน |
|
|
||
| มีการลบพื้นที่ทำงาน |
|
|
||
| การสมัครรับข้อมูลผู้ใช้ | ||||
| ผู้ใช้กลายเป็นสมาชิกของพื้นที่ทำงาน
ไม่ใช่สมาชิกใหม่ทั้งหมดที่จะทริกเกอร์เหตุการณ์ ดูรายละเอียดได้ที่ ข้อจำกัด |
|
|
||
| มีการอัปเดตการเป็นสมาชิกพื้นที่ทำงานของผู้ใช้ |
|
|
||
| มีการนำผู้ใช้ออกจากการเป็นสมาชิกโดยตรงของพื้นที่ทำงาน |
|
|
||
| มีการอัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ ( Developer Preview) |
|
|
||
| มีการอัปเดตสถานะการอ่านเธรดของผู้ใช้ ( Developer Preview) |
|
|
||
ประเภทเหตุการณ์แบบกลุ่ม (เอาต์พุตเท่านั้น)
นอกเหนือจากการรับประเภทเหตุการณ์ที่คุณสมัครรับข้อมูลแล้ว แอป Chat ของคุณอาจได้รับเหตุการณ์แบบกลุ่มด้วย เหตุการณ์แบบกลุ่มคือเหตุการณ์ที่แสดงถึงเหตุการณ์หลายรายการประเภทเดียวกันที่เกิดขึ้นในช่วงเวลาสั้นๆ เพย์โหลดของเหตุการณ์แบบกลุ่มจะมีรายการทรัพยากรทั้งหมดที่เปลี่ยนแปลง
ตัวอย่างเช่น หากผู้ใช้เพิ่มผู้ใช้ 20 คนลงในพื้นที่ทำงานพร้อมกัน แอป Chat ของคุณอาจได้รับเหตุการณ์แบบกลุ่ม (google.workspace.chat.membership.v1.batchCreated) เพย์โหลดของเหตุการณ์จะมีรายการทรัพยากร Membership ใหม่ทั้งหมดที่สร้างขึ้นเมื่อผู้ใช้เพิ่มสมาชิกลงในพื้นที่ทำงาน
คุณจะได้รับเหตุการณ์แบบกลุ่มสำหรับประเภทเหตุการณ์ที่คุณสมัครรับข้อมูล ดังนั้นจึงไม่จำเป็นต้องระบุเหตุการณ์แบบกลุ่มเมื่อสร้างการสมัครรับข้อมูล ตัวอย่างเช่น หากคุณสมัครรับข้อมูลการแสดงความรู้สึกใหม่ (google.workspace.chat.reaction.v1.created) ระบบจะกำหนดค่าแอป Chat ของคุณโดยอัตโนมัติให้รับเหตุการณ์การแสดงความรู้สึกแบบกลุ่ม (google.workspace.chat.reaction.v1.batchCreated)
ตารางต่อไปนี้แสดงเหตุการณ์แบบกลุ่มที่เป็นไปได้สำหรับการสมัครรับข้อมูล
| ประเภทเหตุการณ์แบบกลุ่ม | รูปแบบ |
|---|---|
| มีการโพสต์ข้อความหลายรายการ |
|
| มีการอัปเดตข้อความหลายรายการ |
|
| มีการลบข้อความหลายรายการ |
|
| มีการสร้างการแสดงความรู้สึกหลายรายการ |
|
| มีการลบการแสดงความรู้สึกหลายรายการ |
|
| มีการเพิ่มสมาชิกหลายคนลงในพื้นที่ทำงานที่สมัครรับข้อมูล หรือมีการเพิ่มผู้ใช้ที่สมัครรับข้อมูลลงในพื้นที่ทำงานหลายแห่ง |
|
| มีการอัปเดตการเป็นสมาชิกหลายรายการในพื้นที่ทำงานที่สมัครรับข้อมูล หรือสำหรับผู้ใช้ที่สมัครรับข้อมูล |
|
| มีการนำสมาชิกหลายคนออกจากพื้นที่ทำงานที่สมัครรับข้อมูล หรือมีการนำผู้ใช้ที่สมัครรับข้อมูลออกจากพื้นที่ทำงานหลายแห่ง |
|
| พื้นที่ทำงานมีการอัปเดตหลายรายการ |
|
| มีการอัปเดตสถานะการอ่านพื้นที่ทำงานหลายรายการสำหรับผู้ใช้ที่สมัครรับข้อมูล ( Developer Preview) |
|
| มีการอัปเดตสถานะการอ่านเธรดหลายรายการสำหรับผู้ใช้ที่สมัครรับข้อมูล ( Developer Preview) |
|
ข้อมูลเหตุการณ์
ส่วนนี้อธิบายข้อมูลเหตุการณ์และเพย์โหลดตัวอย่างสำหรับเหตุการณ์ใน Chat
เมื่อการสมัครใช้บริการ Google Workspace ได้รับเหตุการณ์จาก
Chat, dataช่อง
จะมีเพย์โหลดสำหรับเหตุการณ์ เพย์โหลดนี้มีข้อมูลเกี่ยวกับทรัพยากร Google Workspace ที่เปลี่ยนแปลง ตัวอย่างเช่น หากคุณสมัครรับข้อมูลเหตุการณ์การเป็นสมาชิกในพื้นที่ทำงาน เพย์โหลดสำหรับเหตุการณ์เหล่านี้มีข้อมูลเกี่ยวกับทรัพยากร spaces.membership ที่เปลี่ยนแปลง
ข้อมูลทรัพยากรในเพย์โหลดของเหตุการณ์
เมื่อสร้างการสมัครรับข้อมูล คุณสามารถระบุได้ว่าต้องการให้เพย์โหลดมีรายละเอียดเกี่ยวกับทรัพยากรหรือมีเพียงชื่อทรัพยากร ตัวอย่างเช่น หากต้องการรับเหตุการณ์เกี่ยวกับสมาชิกในพื้นที่ทำงาน Chat ให้ระบุช่องของทรัพยากรการเป็นสมาชิกที่ต้องการรับในเพย์โหลดของเหตุการณ์
ตารางต่อไปนี้แสดงตัวอย่างเพย์โหลด JSON สำหรับการสมัครรับข้อมูลพื้นที่ใน Chat spaces/AAAABBBBBB สำหรับแต่ละเหตุการณ์ที่การสมัครรับข้อมูลได้รับ เพย์โหลดจะปรากฏในช่อง data ของเหตุการณ์
| ตัวอย่าง | ประเภทเหตุการณ์ | เพย์โหลด JSON |
|---|---|---|
ผู้ใช้โพสต์ข้อความในพื้นที่ทำงานว่า "Hello world" |
|
รวมข้อมูลทรัพยากร:
{
"message":
{
"name": "spaces/ไม่รวมข้อมูลทรัพยากร:
{
"message":
{
"name": "spaces/ |
| ผู้ใช้กลายเป็นผู้จัดการพื้นที่ทำงาน |
|
รวมข้อมูลทรัพยากร:
{
"membership":
{
"name": "spaces/ไม่รวมข้อมูลทรัพยากร:
{
"membership":
{
"name": "spaces/ |
| ผู้ใช้อัปเดตคำอธิบายของพื้นที่ทำงานเป็น "Sales team for Cymbal Labs" | google.workspace.chat.space.v1.updated |
รวมข้อมูลทรัพยากร:
{
"space":
{
"name": "spaces/ไม่รวมข้อมูลทรัพยากร:
{
"space":
{
"name": "spaces/ |
| มีการเพิ่มผู้ใช้ Chat 2 คนลงในพื้นที่ทำงานพร้อมกัน | google.workspace.chat.membership.v1.batchCreated |
รวมข้อมูลทรัพยากร:
{
"memberships": [
{
"membership": {
"name": "spaces/ไม่รวมข้อมูลทรัพยากร:
{
"memberships": [
{
"membership": {
"name": "spaces/ |
| ผู้ใช้แสดงความรู้สึกต่อข้อความด้วยอีโมจิ 😊 | google.workspace.chat.reaction.v1.created |
รวมข้อมูลทรัพยากร:
{
"reaction":
{
"name": "spaces/ไม่รวมข้อมูลทรัพยากร:
{
"reaction":
{
"name": "spaces/ |
| ผู้ใช้แสดงความรู้สึกต่อข้อความด้วยอีโมจิ 😊 และ 😸 | google.workspace.chat.reaction.v1.batchCreated |
รวมข้อมูลทรัพยากร:
{
"reactions": [
{
"reaction": {
"name": "spaces/ไม่รวมข้อมูลทรัพยากร:
{
"reactions": [
{
"reaction": {
"name": "spaces/ |
| ผู้ใช้เข้าชมพื้นที่ทำงานที่ยังไม่ได้อ่าน ซึ่งจะอัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ ( Developer Preview) | google.workspace.chat.spaceReadState.v1.updated |
รวมข้อมูลทรัพยากร:
{
"spaceReadState": {
"name": "users/ไม่รวมข้อมูลทรัพยากร:
{
"spaceReadState": {
"name": "users/ |
| ผู้ใช้อ่านข้อความในเธรด ซึ่งจะอัปเดตสถานะการอ่านเธรดของผู้ใช้ ( Developer Preview) | google.workspace.chat.threadReadState.v1.updated |
รวมข้อมูลทรัพยากร:
{
"threadReadState": {
"name": "users/ไม่รวมข้อมูลทรัพยากร:
{
"threadReadState": {
"name": "users/ |
ข้อจำกัด
-
สำหรับการสมัครรับข้อมูลผู้ใช้ เหตุการณ์เกี่ยวกับสมาชิกใหม่ในข้อความโดยตรงหรือการแชทเป็นกลุ่มที่ไม่มีชื่อ (
google.workspace.chat.membership.v1.created) จะทริกเกอร์หลังจากมีการโพสต์ข้อความแรกเท่านั้น - หากต้องการรับเหตุการณ์การเป็นสมาชิก ผู้ใช้หรือแอป Chat ต้องเป็นสมาชิกโดยตรงของพื้นที่ทำงาน หากมีการเพิ่ม อัปเดต หรือนำผู้ใช้หรือแอป Chat ออกจากพื้นที่ทำงานโดยอ้อมผ่าน Google Group การสมัครรับข้อมูลจะไม่ได้รับเหตุการณ์การเป็นสมาชิกเหล่านั้น ดูวิธีทำงานของการเป็นสมาชิก Google Group ได้ที่ เพิ่ม Google Group ลงในพื้นที่ทำงาน
หัวข้อที่เกี่ยวข้อง
- โครงสร้างของเหตุการณ์ Google Workspace
- เลือกขอบเขต OAuth
- สร้างการสมัครรับข้อมูลเพื่อ รับเหตุการณ์ของ Chat