ติดตามกิจกรรมใน Google Chat

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

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

เหตุการณ์ใน Chat ที่รองรับ

การสมัครใช้บริการ Google Workspace ช่วยให้คุณรับเหตุการณ์เกี่ยวกับการเปลี่ยนแปลงประเภทต่อไปนี้ใน Chat ได้

• ข้อความใหม่ ข้อความที่อัปเดต หรือข้อความที่ลบในพื้นที่ทำงาน
• รีแอ็กชันใหม่หรือรีแอ็กชันที่ถูกนำออกในข้อความ
• สมาชิกใหม่ ที่อัปเดต หรือที่ถูกนำออกในพื้นที่ทำงาน
• การเปลี่ยนแปลงในพื้นที่ทำงานที่คุณสมัครรับข้อมูล เช่น ชื่อหรือคำอธิบายพื้นที่ทำงานที่อัปเดต
• การเปลี่ยนแปลงเวลาว่างของผู้ใช้
• การเปลี่ยนแปลง spaceReadState หรือ threadReadState ของผู้ใช้

ทรัพยากรที่คุณตรวจสอบเหตุการณ์ได้

หากต้องการรับเหตุการณ์ คุณต้องระบุทรัพยากร Chat ที่จะตรวจสอบ ซึ่งเรียกว่าทรัพยากรเป้าหมายของการสมัครใช้บริการ

Google Workspace Events API รองรับทรัพยากรเป้าหมายต่อไปนี้สำหรับ Chat

ประเภทเหตุการณ์สำหรับการสร้างการสมัครใช้บริการ

เมื่อสร้างการสมัครใช้บริการ ให้ใช้ช่อง eventTypes[] เพื่อระบุประเภทเหตุการณ์ที่ต้องการรับ ประเภทเหตุการณ์จะจัดรูปแบบตามข้อกำหนดเฉพาะของ CloudEvents เช่น google.workspace.APPLICATION.RESOURCE.VERSION.ACTION

ตัวอย่างเช่น หากต้องการรับเหตุการณ์เกี่ยวกับผู้ใช้ที่เข้าร่วมพื้นที่ทำงานใน Chat ให้ระบุพื้นที่ทำงานเป็นทรัพยากรเป้าหมาย และประเภทเหตุการณ์เป็น google.workspace.chat.membership.v1.created หากต้องการรับเหตุการณ์เกี่ยวกับผู้ใช้ที่ระบุซึ่งเข้าร่วมพื้นที่ทำงานใดก็ตาม ให้ระบุผู้ใช้เป็นทรัพยากรเป้าหมาย และประเภทเหตุการณ์เป็น google.workspace.chat.membership.v1.created ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีการทำงานของเหตุการณ์ได้ที่หัวข้อโครงสร้างของเหตุการณ์ Google Workspace

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

ประเภทเหตุการณ์แบบกลุ่ม (เอาต์พุตเท่านั้น)

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

ตัวอย่างเช่น หากผู้ใช้เพิ่มผู้ใช้ 20 คนไปยังพื้นที่ทำงานพร้อมกัน แอปใน Chat ของคุณอาจได้รับเหตุการณ์แบบกลุ่ม (google.workspace.chat.membership.v1.batchCreated) เพย์โหลดของเหตุการณ์จะมีรายการทรัพยากร Membership ใหม่ทั้งหมดที่สร้างขึ้นเมื่อผู้ใช้เพิ่มสมาชิกลงในพื้นที่ทำงาน

คุณจะได้รับเหตุการณ์แบบกลุ่มสำหรับเหตุการณ์ประเภทใดก็ตามที่คุณสมัครรับข้อมูล ดังนั้นคุณจึงไม่จำเป็นต้องระบุเหตุการณ์แบบกลุ่มเมื่อสร้างการสมัครรับข้อมูล ตัวอย่างเช่น หากคุณสมัครรับข้อมูลรีแอ็กชันใหม่ (google.workspace.chat.reaction.v1.created) ระบบจะกำหนดค่าแอป Chat ให้รับเหตุการณ์รีแอ็กชันแบบกลุ่ม (google.workspace.chat.reaction.v1.batchCreated) โดยอัตโนมัติ

ตารางต่อไปนี้แสดงเหตุการณ์แบบกลุ่มที่เป็นไปได้สำหรับการสมัครใช้บริการ

ข้อมูลเหตุการณ์

ส่วนนี้จะอธิบายข้อมูลเหตุการณ์และเพย์โหลดตัวอย่างสำหรับเหตุการณ์ใน Chat

เมื่อการสมัครใช้บริการ Google Workspace ได้รับเหตุการณ์จาก Chat ช่อง data จะมีเพย์โหลดสำหรับเหตุการณ์นั้น เพย์โหลดนี้มีข้อมูลเกี่ยวกับทรัพยากร Google Workspace ที่มีการเปลี่ยนแปลง ตัวอย่างเช่น หากคุณสมัครรับข้อมูลกิจกรรมการเป็นสมาชิกในพื้นที่ทำงาน เพย์โหลดสำหรับกิจกรรมเหล่านี้จะมีข้อมูลเกี่ยวกับทรัพยากร spaces.membership ที่เปลี่ยนแปลง

ข้อมูลทรัพยากรในเพย์โหลดของเหตุการณ์

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

ตารางต่อไปนี้แสดงตัวอย่างเพย์โหลด JSON สำหรับการสมัครรับข้อมูลพื้นที่ทำงานใน Chat spaces/AAAABBBBBB สำหรับแต่ละเหตุการณ์ที่การสมัครใช้บริการได้รับ เพย์โหลดจะปรากฏในช่อง data ของเหตุการณ์ ดังนี้

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID",
        "sender":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "2023-09-07T21:37:36.260127Z",
        "text": "Hello world",
        "thread":
        {
            "name": "spaces/SPACE_ID/threads/THREAD_ID"
        },
        "space":
        {
            "name": "spaces/SPACE_ID"
        },
        "argumentText": "Hello world"
    }
}
      

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID"
    }
}
      

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID",
        "state": "JOINED",
        "member":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "1970-01-01T00:00:00Z",
        "role": "ROLE_MANAGER"
    }
}
      

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID"
    }
}
      

{
    "space":
    {
        "name": "spaces/SPACE_ID",
        "displayName": "Cymbal Sales",
        "spaceThreadingState": "THREADED_MESSAGES",
        "spaceType": "SPACE",
        "spaceDetails":
        {
            "description": "Sales team for Cymbal Labs."
        },
        "spaceHistoryState": "HISTORY_ON"
    }
}
      

{
    "space":
    {
        "name": "spaces/SPACE_ID"
    }
}
      

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        }
    ]
}
      

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        }
    ]
}
      

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        "user":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "emoji":
        {
            "unicode": "😊"
        }
    }
}
      

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
    }
}
      

{
    "reactions": [
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😊"
            }
          }
        },
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😸"
            }
          }
        }
    ]
}
      

{
    "reactions": [
      {
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
        },
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        }
      }
    ]
}
      

{
  "spaceReadState": {
    "name": "users/USER_ID/spaces/SPACE_ID/spaceReadState",
    "lastReadTime": "2026-04-14T14:03:46.431760Z"
  }
}
      

{
  "spaceReadState": {
    "name": "users/USER_ID/spaces/SPACE_ID/spaceReadState"
  }
}
      

{
  "threadReadState": {
    "name": "users/USER_ID/spaces/SPACE_ID/threads/THREAD_ID/threadReadState",
    "lastReadTime": "2026-04-14T14:03:46.431760Z"
  }
}
      

{
  "threadReadState": {
    "name": "users/USER_ID/spaces/SPACE_ID/threads/THREAD_ID/threadReadState"
  }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
        "state": "ACTIVE"
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
        "state": "IDLE",
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
        "state": "AWAY",
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
        "state": "DO_NOT_DISTURB",
        "doNotDisturbMetadata": {
          "expirationTime": "2026-03-24T18:36:31.337Z"
        }
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
        "state": "ACTIVE",
        "customStatus": {
          "text": "Be right back",
          "emoji": {
            "unicode": "👟"
          },
          "expireTime": "2026-03-24T18:38:05.583655Z"
        }
    }
}
      

{
    "availability":
    {
        "name": "users/USER_ID/availability",
    }
}
      

ข้อจำกัดทั่วไป

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

การสมัครใช้บริการของผู้ใช้

• สำหรับการสมัครใช้บริการของผู้ใช้ เหตุการณ์เกี่ยวกับสมาชิกใหม่ในข้อความส่วนตัวหรือแชทเป็นกลุ่มที่ไม่มีชื่อ (google.workspace.chat.membership.v1.created) จะทริกเกอร์หลังจากโพสต์ข้อความแรกเท่านั้น

การสมัครใช้บริการของลูกค้า

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

• องค์กร Google Workspace ต้องมีใบอนุญาต SKU ของ Enterprise อย่างน้อย 1 ใบ
• แอปใน Chat จะสร้างการสมัครใช้บริการของลูกค้าได้เพียงรายการเดียวสำหรับองค์กร 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
• เลือกขอบเขต OAuth
• สร้างการสมัครใช้บริการเพื่อรับเหตุการณ์ใน Chat