ใช้งานกิจกรรมจาก Google Chat

หน้านี้อธิบายวิธีที่แอป Google Chat รับและตอบกลับ เหตุการณ์ใน Google Chat

เหตุการณ์ใน Google Chat แสดงถึงกิจกรรมหรือการเปลี่ยนแปลงใน Chat เช่น ข้อความใหม่ในพื้นที่ทำงาน แอป Chat สามารถใช้ เหตุการณ์เพื่อทำความเข้าใจสิ่งที่เกิดขึ้นและดำเนินการหรือตอบสนองในลักษณะที่มีความหมาย สำหรับผู้ใช้

ตัวอย่างการใช้เหตุการณ์มีดังนี้

  • ตรวจสอบและตอบกลับข้อความใหม่ในพื้นที่ทำงาน เช่น ตรวจสอบคีย์เวิร์ดหรือวลีสำคัญ
  • ส่งข้อความต้อนรับถึงผู้ใช้เมื่อเข้าร่วมพื้นที่ทำงานเพื่ออธิบายหลักเกณฑ์ของพื้นที่ทำงาน หรือแชร์เคล็ดลับเกี่ยวกับวิธีใช้แอป Chat อย่างมีประสิทธิภาพ
  • ติดตามและวิเคราะห์กิจกรรมใน Chat เช่น เพื่อส่งรายงานรายเดือนเกี่ยวกับสมาชิกใหม่หรือข้อความที่ได้รับการรีแอ็กชันหรือคำตอบมากที่สุด
  • สื่อสารผ่านแพลตฟอร์มการรับส่งข้อความ เช่น ผู้ใช้สามารถส่ง และรับข้อความจากผู้ใช้ในแพลตฟอร์มการรับส่งข้อความอื่นได้โดยไม่ต้อง ออกจาก Chat

วิธีการทำงานของกิจกรรม

เมื่อใดก็ตามที่มีการดำเนินการใน Google Chat ระบบจะสร้าง อัปเดต หรือลบทรัพยากร Google Chat API Chat ใช้เหตุการณ์เพื่อส่งข้อมูลไปยังแอป Chat เกี่ยวกับประเภทกิจกรรมที่เกิดขึ้นและทรัพยากร Chat API ที่ได้รับผลกระทบ

ตัวอย่างวิธีที่ข้อความที่โพสต์ในพื้นที่ใน Google Chat จะทริกเกอร์เหตุการณ์
รูปที่ 1 ผู้ใช้โพสต์ข้อความในพื้นที่ใน 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
แหล่งที่มาของเหตุการณ์ Spaces, ผู้ใช้ และองค์กร Google Workspace ( เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์) เฉพาะพื้นที่ทำงาน
เหตุการณ์ที่รองรับ
  • ข้อความ
  • การเป็นสมาชิก
  • รีแอ็กชัน
  • Space

ดูรายการประเภทกิจกรรมที่รองรับได้ที่ ประเภทกิจกรรมสำหรับการสร้างการสมัครรับข้อมูลใน เอกสารประกอบของ Google Workspace Events API
  • ข้อความ
  • การเป็นสมาชิก
  • รีแอ็กชัน
  • Space

ดูรายการประเภทเหตุการณ์ที่รองรับได้ที่ แหล่งข้อมูลspaceEventsในเอกสารอ้างอิง Chat API
รูปแบบกิจกรรม ข้อความ Google Cloud Pub/Sub ที่จัดรูปแบบตาม ข้อกำหนด CloudEvent โปรดดูรายละเอียดที่หัวข้อ โครงสร้างของกิจกรรมใน Google Workspace ทรัพยากร Chat API ( spaces.spaceEvent)
ข้อมูลเหตุการณ์ สตริงที่เข้ารหัส Base64 ที่มีหรือไม่มีข้อมูลทรัพยากร ดูเพย์โหลดตัวอย่างได้ที่ข้อมูลเหตุการณ์ เพย์โหลด JSON ที่มีข้อมูลทรัพยากร เหตุการณ์บางประเภทจะมีเฉพาะฟิลด์ทรัพยากรบางรายการเท่านั้น ดูเพย์โหลดตัวอย่างได้ใน เอกสารอ้างอิง

ตัวอย่าง: ค้นหาหรือติดตามกิจกรรมเกี่ยวกับการเป็นสมาชิกในพื้นที่ทำงาน

ในตัวอย่างนี้ แอป Chat ต้องการรับข้อมูลเกี่ยวกับการเปลี่ยนแปลงสมาชิกในพื้นที่ทำงานของ Chat ใน พื้นที่ทำงาน จะเกิดกิจกรรมการเป็นสมาชิกต่อไปนี้

  • ผู้ใช้เข้าร่วมพื้นที่ทำงาน ซึ่งจะสร้างMembershipทรัพยากรและทริกเกอร์ เหตุการณ์สมาชิกใหม่
  • ผู้ใช้จะกลายเป็นผู้จัดการพื้นที่ทำงาน ซึ่งจะอัปเดตMembershipทรัพยากรสำหรับผู้ใช้และทริกเกอร์กิจกรรมสมาชิกที่อัปเดตแล้ว
  • ผู้ใช้ออกจากพื้นที่ ซึ่งจะลบทรัพยากร Membership สำหรับผู้ใช้และทริกเกอร์เหตุการณ์ที่สมาชิกถูกลบ

เหตุการณ์การเป็นสมาชิก

หากต้องการรับกิจกรรมแบบเรียลไทม์ แอป Chat จะเรียกใช้เมธอด subscriptions.create() ของ Google Workspace Events API เพื่อสมัครรับข้อมูลพื้นที่ทำงานสำหรับกิจกรรมการเป็นสมาชิกทุกประเภท หลังจาก สร้างการสมัครใช้บริการแล้ว แอปแชทจะเริ่ม รับเหตุการณ์การเป็นสมาชิกได้

แอป Chat ที่สมัครรับข้อมูลกิจกรรมโดยใช้
      Google Workspace Events API
รูปที่ 2 แอป Chat จะได้รับเหตุการณ์การเป็นสมาชิกผ่านการสมัครรับข้อมูลโดยใช้ Google Workspace Events API

ในรูปที่ 2 แอป Chat มีการสมัครใช้บริการพื้นที่ทำงานที่ใช้งานอยู่ ดังนั้นแอปจะได้รับเหตุการณ์ทุกครั้งที่มีการเปลี่ยนแปลงการเป็นสมาชิกในพื้นที่ทำงาน จากนั้นแอป Chat จะประมวลผลหรือตอบกลับกิจกรรมต่างๆ ได้แบบเรียลไทม์ เช่น การโพสต์ข้อความต้อนรับส่วนตัวถึงสมาชิกที่เข้าร่วมพื้นที่ทำงาน

ดูข้อมูลเกี่ยวกับการสร้างการสมัครใช้บริการโดยใช้ Google Workspace Events API ได้ที่เอกสารประกอบของ Google Workspace Events API

ค้นหากิจกรรมเกี่ยวกับการเป็นสมาชิกล่าสุด

แอปใน Chat สามารถเรียกใช้ Chat API เพื่อแสดงรายการ เหตุการณ์ล่าสุดในพื้นที่ทำงานที่เกี่ยวข้องกับกิจกรรมการเป็นสมาชิกแทนที่จะรับเหตุการณ์การเป็นสมาชิกเมื่อเกิดขึ้น

แอป Chat ที่ค้นหาเหตุการณ์โดยใช้ Chat API
รูปที่ 3 แอป 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) จะทริกเกอร์หลังจากโพสต์ข้อความแรกเท่านั้น

การติดตามของลูกค้า ( เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์)

สำหรับการสมัครใช้บริการของลูกค้า จะมีข้อจำกัดดังต่อไปนี้

  • องค์กร Google Workspace ต้องมีใบอนุญาต SKU ของ Enterprise อย่างน้อย 1 ใบ โปรดทราบว่าข้อกำหนดนี้ไม่ได้บังคับใช้อย่างเคร่งครัดในระยะโปรแกรมทดลองใช้เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ แต่จะบังคับใช้ในอนาคต (จะประกาศแยกต่างหาก)
  • แอป Chat จะสร้างการสมัครใช้บริการของลูกค้าได้เพียง 1 รายการสำหรับองค์กร Google Workspace ที่กำหนด องค์กร Google Workspace สามารถมีการสมัครใช้บริการของลูกค้าได้สูงสุด 5 รายการ (สร้างโดยแอป Chat ต่างๆ)

สำหรับการสมัครใช้บริการของลูกค้า การนำส่งกิจกรรมจะเป็นไปตามกฎทั่วไปต่อไปนี้

  • กิจกรรมในพื้นที่: จะแสดงก็ต่อเมื่อกิจกรรมเกิดขึ้นในพื้นที่ที่องค์กร Google Workspace ของคุณจัดการ
  • กิจกรรมของผู้ใช้: จะแสดงก็ต่อเมื่อเกิดกิจกรรมสำหรับผู้ใช้ที่เป็นขององค์กร Google Workspace ของคุณ

ข้อยกเว้นเพียงอย่างเดียวของกฎเหล่านี้คือกิจกรรมสำหรับสมาชิก การสมัครใช้บริการจะรับเหตุการณ์การเป็นสมาชิกได้จากทั้งพื้นที่ทำงานที่องค์กรของคุณจัดการและพื้นที่ทำงานที่องค์กรภายนอกจัดการ แต่การนำส่งจะขึ้นอยู่กับว่าองค์กรใดเป็นผู้จัดการพื้นที่ทำงาน

Spaces ที่จัดการโดยองค์กร Google Workspace

หากมีการเปลี่ยนแปลงการเป็นสมาชิกในพื้นที่ทำงานที่องค์กร Google Workspace จัดการ ระบบจะส่งการเปลี่ยนแปลงดังกล่าวเป็นกิจกรรมในพื้นที่ทำงาน

ชื่อทรัพยากรของกิจกรรมในพื้นที่ทำงานใช้รูปแบบต่อไปนี้

spaces/{spaceId}/spaceEvents/{spaceEventId}

พื้นที่ทำงานที่จัดการโดยองค์กรภายนอก

หากการเป็นสมาชิกของผู้ใช้ที่องค์กร Google Workspace ของคุณจัดการมีการเปลี่ยนแปลงในพื้นที่ทำงานที่องค์กรภายนอกจัดการ (เช่น พื้นที่ทำงานภายนอกที่มีชื่อหรือข้อความส่วนตัวที่ผู้ใช้ภายนอกสร้างขึ้น) การสมัครใช้บริการของคุณจะได้รับเหตุการณ์นี้เป็นเหตุการณ์ของผู้ใช้

ชื่อทรัพยากรของเหตุการณ์ของผู้ใช้ใช้รูปแบบต่อไปนี้

users/{userId}/userEvents/{userEventId}