หน้านี้อธิบายวิธีที่แอป Google Chat รับและตอบสนองต่อเหตุการณ์ใน Google Chat ได้
เหตุการณ์ Google Chat แสดงถึงกิจกรรมหรือการเปลี่ยนแปลงใน Chat เช่น ข้อความใหม่ในพื้นที่ทำงาน แอป Chat สามารถใช้เหตุการณ์เพื่อทำความเข้าใจสิ่งที่เกิดขึ้นและดำเนินการหรือตอบสนองในลักษณะที่มีความหมายต่อผู้ใช้
ตัวอย่างการใช้เหตุการณ์มีดังนี้
- ตรวจสอบและตอบสนองต่อข้อความใหม่ในพื้นที่ทำงาน เช่น การตรวจสอบคำหรือวลีสำคัญ
- ส่งข้อความต้อนรับถึงผู้ใช้เมื่อเข้าร่วมพื้นที่ทำงาน เพื่ออธิบายหลักเกณฑ์ของพื้นที่ทำงานหรือแชร์เคล็ดลับเกี่ยวกับวิธีใช้แอป Chat อย่างมีประสิทธิภาพ
- ติดตามและวิเคราะห์กิจกรรมใน Chat เช่น ส่งรายงานรายเดือนเกี่ยวกับสมาชิกใหม่หรือข้อความที่มีรีแอ็กชันหรือการตอบกลับมากที่สุด
- สื่อสารในแพลตฟอร์มการรับส่งข้อความต่างๆ เช่น ผู้ใช้สามารถรับและส่งข้อความจากผู้ใช้ในแพลตฟอร์มการรับส่งข้อความอื่นได้โดยไม่ต้องออกจาก Chat
วิธีทำงานของเหตุการณ์
เมื่อใดก็ตามที่มีสิ่งเกิดขึ้นใน Google Chat ระบบจะสร้าง อัปเดต หรือลบทรัพยากร Google Chat API Chat ใช้เหตุการณ์เพื่อส่งข้อมูลไปยังแอป Chat เกี่ยวกับประเภทกิจกรรมที่เกิดขึ้นและทรัพยากร Chat API ที่ได้รับผลกระทบ
Message
จากนั้น Chat จะสร้างเหตุการณ์ที่มีข้อมูลเกี่ยวกับข้อความใหม่
message.Chat จัดหมวดหมู่เหตุการณ์ตามประเภท ประเภทเหตุการณ์ช่วยให้คุณกรองและรับเฉพาะข้อมูลประเภทที่ต้องการ รวมถึงจัดการกิจกรรมที่คล้ายกันในลักษณะเดียวกันได้
ตารางต่อไปนี้แสดงวิธีที่กิจกรรมใน Chat ส่งผลต่อทรัพยากร Chat API ที่เกี่ยวข้อง และประเภทเหตุการณ์ที่แอป Chat ได้รับ
| กิจกรรม | ทรัพยากร Chat API | ประเภทเหตุการณ์ |
|---|---|---|
| ผู้ใช้โพสต์ข้อความในพื้นที่ใน Chat | ระบบจะสร้างทรัพยากร Message |
ข้อความใหม่ |
| ผู้ใช้กลายเป็นผู้จัดการพื้นที่ทำงาน | ระบบจะอัปเดตทรัพยากร Membership |
การเป็นสมาชิกที่อัปเดต |
| ผู้ใช้แสดงความรู้สึกต่อข้อความ | ระบบจะสร้างทรัพยากร Reaction |
รีแอ็กชันใหม่ |
| ผู้ใช้ออกจากพื้นที่ทำงาน | ระบบจะลบทรัพยากร Membership |
การเป็นสมาชิกที่ลบ |
รับเหตุการณ์จาก Google Chat
หากต้องการรับเหตุการณ์ แอป Chat สามารถทำอย่างใดอย่างหนึ่งต่อไปนี้
- สมัครรับข้อมูลเหตุการณ์โดยใช้ Google Workspace Events API เพื่อรับเหตุการณ์เมื่อเกิดขึ้น
- ค้นหาเหตุการณ์ล่าสุดโดยเรียก Chat API
ตารางต่อไปนี้อธิบายความแตกต่างและเหตุผลในการค้นหาหรือสมัครรับข้อมูลเหตุการณ์
| สมัครรับข้อมูลเหตุการณ์ | ค้นหาเหตุการณ์ | |
|---|---|---|
| กรณีการใช้งาน |
|
|
| API | Google Workspace Events API | Chat API |
| แหล่งที่มาของเหตุการณ์ | พื้นที่ทำงาน ผู้ใช้ และองค์กร Google Workspace ( เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์) | พื้นที่ทำงานเท่านั้น |
| เหตุการณ์ที่รองรับ |
ดูรายการประเภทเหตุการณ์ที่รองรับได้ที่ ประเภทเหตุการณ์สำหรับการสร้างการสมัครรับข้อมูล ใน เอกสารประกอบ Google Workspace Events API |
ดูรายการประเภทเหตุการณ์ที่รองรับได้ที่ทรัพยากร spaceEvents ในเอกสารอ้างอิง Chat API
|
| รูปแบบเหตุการณ์ | ข้อความ Google Cloud Pub/Sub ที่จัดรูปแบบตามข้อกำหนด CloudEvent โปรดดูรายละเอียดที่ โครงสร้างของเหตุการณ์ Google Workspace |
ทรัพยากร Chat API
(
spaces.spaceEvent)
|
| ข้อมูลเหตุการณ์ | สตริงที่เข้ารหัสแบบ Base64 พร้อมข้อมูลทรัพยากรหรือไม่ก็ได้ ดูเพย์โหลดตัวอย่างได้ที่ข้อมูลเหตุการณ์ | เพย์โหลด JSON ที่มีข้อมูลทรัพยากร เหตุการณ์บางประเภทจะมีเพียงบางช่องทรัพยากรเท่านั้น ดูเพย์โหลดตัวอย่างได้ใน เอกสารอ้างอิง |
ตัวอย่าง: ค้นหาหรือสมัครรับข้อมูลเหตุการณ์เกี่ยวกับการเป็นสมาชิกในพื้นที่ทำงาน
ในตัวอย่างนี้ แอป Chat ต้องการรับข้อมูลเกี่ยวกับการเปลี่ยนแปลงสมาชิกของพื้นที่ใน Chat โดยมีกิจกรรมการเป็นสมาชิกต่อไปนี้เกิดขึ้นในพื้นที่ทำงาน
- ผู้ใช้เข้าร่วมพื้นที่ทำงาน ซึ่งจะสร้างทรัพยากร
Membershipและทริกเกอร์เหตุการณ์สมาชิกใหม่ - ผู้ใช้กลายเป็นผู้จัดการพื้นที่ทำงาน ซึ่งจะอัปเดตทรัพยากร
Membershipของผู้ใช้และทริกเกอร์เหตุการณ์สมาชิกที่อัปเดต - ผู้ใช้ออกจากพื้นที่ทำงาน ซึ่งจะลบทรัพยากร
Membershipของผู้ใช้และทริกเกอร์เหตุการณ์สมาชิกที่ลบ
สมัครรับข้อมูลเหตุการณ์การเป็นสมาชิก
หากต้องการรับเหตุการณ์แบบเรียลไทม์ แอป Chat จะเรียกใช้เมธอด Google Workspace Events API
subscriptions.create()
เพื่อสมัครรับข้อมูลพื้นที่ทำงานสำหรับเหตุการณ์การเป็นสมาชิกทุกประเภท หลังจากสร้างการสมัครรับข้อมูลแล้ว แอป Chat จะเริ่มรับเหตุการณ์การเป็นสมาชิกได้
ในรูปที่ 2 แอป Chat มีการสมัครรับข้อมูลพื้นที่ทำงานที่ใช้งานอยู่ ดังนั้นแอปจะได้รับเหตุการณ์ทุกครั้งที่การเป็นสมาชิกในพื้นที่ทำงานมีการเปลี่ยนแปลง จากนั้นแอป Chat จะประมวลผลหรือตอบสนองต่อกิจกรรมต่างๆ แบบเรียลไทม์ได้ เช่น โพสต์ข้อความต้อนรับแบบส่วนตัวถึงสมาชิกที่เข้าร่วมพื้นที่ทำงาน
ดูข้อมูลเกี่ยวกับการสร้างการสมัครรับข้อมูลโดยใช้ Google Workspace Events API ได้ในเอกสารประกอบ Google Workspace Events API
ค้นหาเหตุการณ์การเป็นสมาชิกล่าสุด
แอป Chat สามารถเรียก Chat API เพื่อแสดงรายการเหตุการณ์ล่าสุดในพื้นที่ทำงานที่เกี่ยวข้องกับกิจกรรมการเป็นสมาชิกแทนที่จะรับเหตุการณ์การเป็นสมาชิกเมื่อเกิดขึ้น
ในรูปที่ 3 แอป Chat จะเรียกใช้เมธอดของ Chat API
spaces.spaceEvents.list()
หลังจากกิจกรรมการเป็นสมาชิกทั้งหมดเกิดขึ้นแล้ว และกรองการค้นหา
เหตุการณ์การเป็นสมาชิกใหม่ อัปเดต และลบ Chat API จะแสดงรายการทรัพยากร spaceEvent ที่แสดงถึงการเปลี่ยนแปลงการเป็นสมาชิกแต่ละรายการ
จากนั้นแอป Chat จะประมวลผลหรือตอบสนองตามกิจกรรมล่าสุดได้ เช่น โพสต์ข้อความรายสัปดาห์พร้อมสรุปกิจกรรมการเป็นสมาชิกของพื้นที่ทำงานในช่วง 7 วันที่ผ่านมา
หากต้องการค้นหาเหตุการณ์โดยใช้ Chat API โปรดดู แสดงรายการเหตุการณ์จากพื้นที่ใน Google Chat
ข้อจำกัดและลักษณะการทำงานในการส่ง
ข้อจำกัดทั่วไป
- หากต้องการรับเหตุการณ์การเป็นสมาชิก ผู้ใช้หรือแอป Chat ต้องเป็นสมาชิกโดยตรงของพื้นที่ทำงาน หากมีการเพิ่ม อัปเดต หรือนำผู้ใช้หรือแอปออกทางอ้อมจากพื้นที่ทำงานผ่าน Google Group การสมัครรับข้อมูลจะไม่ได้รับเหตุการณ์การเป็นสมาชิกเหล่านั้น ดูวิธีทำงานของการเป็นสมาชิก Google Group ได้ที่หัวข้อ เพิ่ม Google Group ลงในพื้นที่ทำงาน
การสมัครใช้บริการของผู้ใช้
-
สำหรับการสมัครรับข้อมูลผู้ใช้ เหตุการณ์เกี่ยวกับสมาชิกใหม่ในข้อความส่วนตัวหรือการแชทเป็นกลุ่มที่ไม่มีชื่อ (
google.workspace.chat.membership.v1.created) จะทริกเกอร์หลังจากมีการโพสต์ข้อความแรกเท่านั้น
การสมัครรับข้อมูลของลูกค้า ( Developer Preview)
สำหรับการสมัครรับข้อมูลของลูกค้า จะมีข้อจำกัดดังต่อไปนี้
- องค์กร Google Workspace ต้องมีใบอนุญาต Enterprise SKU อย่างน้อย 1 ใบ โปรดทราบว่าข้อกำหนดนี้จะไม่มีการบังคับใช้อย่างเข้มงวดในระยะโปรแกรม Developer Preview แต่จะมีการบังคับใช้ในอนาคต (จะประกาศแยกต่างหาก)
- แอป Chat สามารถสร้างการสมัครรับข้อมูลของลูกค้าได้เพียง 1 รายการสำหรับองค์กร Google Workspace ที่กำหนด องค์กร Google Workspace สามารถมีการสมัครรับข้อมูลของลูกค้าได้สูงสุด 5 รายการ (สร้างโดยแอป Chat ต่างๆ)
สำหรับการสมัครรับข้อมูลของลูกค้า การส่งเหตุการณ์จะเป็นไปตามกฎทั่วไปต่อไปนี้
- เหตุการณ์ในพื้นที่ทำงาน: จะส่งก็ต่อเมื่อเหตุการณ์เกิดขึ้นในพื้นที่ทำงานที่จัดการโดยองค์กร Google Workspace ของคุณ
- เหตุการณ์ของผู้ใช้: จะส่งก็ต่อเมื่อเหตุการณ์เกิดขึ้นกับผู้ใช้ที่เป็นขององค์กร Google Workspace ของคุณ
ข้อยกเว้นเพียงอย่างเดียวสำหรับกฎเหล่านี้คือเหตุการณ์การเป็นสมาชิก การสมัครรับข้อมูลของคุณสามารถรับเหตุการณ์การเป็นสมาชิกจากทั้งพื้นที่ทำงานที่จัดการโดยองค์กรของคุณและพื้นที่ทำงานที่จัดการโดยองค์กรภายนอก แต่ลักษณะการส่งจะขึ้นอยู่กับองค์กรที่จัดการพื้นที่ทำงาน ดังนี้
พื้นที่ทำงานที่จัดการโดยองค์กร Google Workspace ของคุณ
หากมีการเปลี่ยนแปลงการเป็นสมาชิกในพื้นที่ทำงานที่จัดการโดยองค์กร Google Workspace ระบบจะส่งการเปลี่ยนแปลงดังกล่าวเป็นเหตุการณ์ในพื้นที่ทำงาน
ชื่อทรัพยากรของเหตุการณ์ในพื้นที่ทำงานใช้รูปแบบต่อไปนี้
spaces/{spaceId}/spaceEvents/{spaceEventId}
พื้นที่ทำงานที่จัดการโดยองค์กรภายนอก
หากการเป็นสมาชิกของผู้ใช้ที่จัดการโดยองค์กร Google Workspace ของคุณมีการเปลี่ยนแปลงในพื้นที่ทำงานที่จัดการโดยองค์กรภายนอก (เช่น พื้นที่ทำงานที่มีชื่อภายนอกหรือข้อความส่วนตัวที่สร้างโดยผู้ใช้ภายนอก) การสมัครรับข้อมูลของคุณจะได้รับเหตุการณ์นี้เป็นเหตุการณ์ของผู้ใช้
ชื่อทรัพยากรของเหตุการณ์ของผู้ใช้ใช้รูปแบบต่อไปนี้
users/{userId}/userEvents/{userEventId}
หัวข้อที่เกี่ยวข้อง
- ภาพรวมของ Google Workspace Events API
- สร้างการสมัครรับข้อมูล
- ดูรายละเอียดเกี่ยวกับเหตุการณ์ในพื้นที่ใน Google Chat
- แสดงรายการเหตุการณ์จากพื้นที่ใน Google Chat