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

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

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

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

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

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

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

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

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

ทรัพยากรเป้าหมาย รูปแบบ ข้อจำกัด
Space

//chat.googleapis.com/spaces/SPACE

โดยที่ SPACE คือรหัสใน ชื่อทรัพยากรของทรัพยากร Chat API space คุณสามารถดูรหัสจาก URL ของพื้นที่ทำงานหรือใช้ spaces.list()

 ผู้ใช้ Chat ที่อนุญาตให้มีการสมัครใช้บริการจะต้อง ได้เป็นสมาชิกพื้นที่ทำงานผ่าน Google Workspace หรือ Google บัญชี
พื้นที่ทำงานทั้งหมดสำหรับผู้ใช้

//chat.googleapis.com/spaces/-

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

//cloudidentity.googleapis.com/users/USER

โดยที่ USER คือรหัสใน ชื่อทรัพยากรของทรัพยากร Chat API user โปรดดูรายละเอียดที่หัวข้อ ระบุและระบุ ผู้ใช้ Google Chat

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

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

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

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

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

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

google.workspace.chat.message.v1.created

space.message
อัปเดตข้อความแล้ว

google.workspace.chat.message.v1.updated

space.message
ข้อความถูกลบ

google.workspace.chat.message.v1.deleted

space.message
สร้างรีแอ็กชันแล้ว

google.workspace.chat.reaction.v1.created

space.message.reaction
ลบรีแอ็กชันแล้ว

google.workspace.chat.reaction.v1.deleted

space.message.reaction
เพิ่มสมาชิกไปยังพื้นที่ทำงานแล้ว

google.workspace.chat.membership.v1.created

space.membership
อัปเดตสมาชิกในพื้นที่ทำงานแล้ว

google.workspace.chat.membership.v1.updated

space.membership
ระบบนำสมาชิกออกจากพื้นที่ทำงาน

google.workspace.chat.membership.v1.deleted

space.membership
อัปเดตพื้นที่ทำงานแล้ว

google.workspace.chat.space.v1.updated

space
ลบพื้นที่ทำงานแล้ว

google.workspace.chat.space.v1.deleted

space
การสมัครใช้บริการให้กับผู้ใช้  
ผู้ใช้จะกลายเป็นสมาชิกของพื้นที่ทำงาน

สมาชิกใหม่บางรายจะเรียกใช้เหตุการณ์ไม่ได้ ดูรายละเอียดได้ที่ข้อจำกัด

google.workspace.chat.membership.v1.created

space.membership
อัปเดตการเป็นสมาชิกพื้นที่ทำงานของผู้ใช้แล้ว

google.workspace.chat.membership.v1.updated

space.membership
นำผู้ใช้ออกจากการเป็นสมาชิกโดยตรงของพื้นที่ทำงานแล้ว

google.workspace.chat.membership.v1.deleted

space.membership

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

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

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

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

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

ประเภทเหตุการณ์แบบกลุ่ม รูปแบบ
มีการโพสต์ข้อความหลายข้อความ

google.workspace.chat.message.v1.batchCreated
มีการอัปเดตข้อความหลายรายการ

google.workspace.chat.message.v1.batchUpdated
ลบข้อความหลายรายการ

google.workspace.chat.message.v1.batchDeleted
มีการสร้างความรู้สึกหลายรายการ

google.workspace.chat.reaction.v1.batchCreated
ลบความรู้สึกหลายรายการแล้ว

google.workspace.chat.reaction.v1.batchDeleted
ระบบจะเพิ่มสมาชิกหลายคนไปยังพื้นที่ทำงานที่สมัครใช้บริการ หรือมีการเพิ่มผู้ใช้ที่สมัครใช้บริการไปยังพื้นที่ทำงานหลายแห่ง

google.workspace.chat.membership.v1.batchCreated
มีการอัปเดตการเป็นสมาชิกหลายรายการในพื้นที่ที่สมัครใช้บริการหรือสำหรับผู้ใช้ที่สมัครใช้บริการ

google.workspace.chat.membership.v1.batchUpdated
ระบบนำสมาชิกหลายคนออกจากพื้นที่ทำงานที่สมัครรับข้อมูลหรือผู้ใช้ที่สมัครรับข้อมูลถูกนำออกจากพื้นที่ทำงานหลายแห่ง

google.workspace.chat.membership.v1.batchDeleted
พื้นที่ทำงานมีการอัปเดตหลายรายการ

google.workspace.chat.space.v1.batchUpdated

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

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

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

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

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

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

ตัวอย่าง ประเภทเหตุการณ์ เพย์โหลด JSON

ผู้ใช้โพสต์ข้อความในพื้นที่ทำงานว่า "สวัสดีโลก"

google.workspace.chat.message.v1.created

รวมข้อมูลทรัพยากร
{
    "message":
    {
        "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD",
        "sender":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "createTime": "2023-09-07T21:37:36.260127Z",
        "text": "Hello world",
        "thread":
        {
            "name": "spaces/AAAABBBBBB/threads/EEEEEEEEEEEE"
        },
        "space":
        {
            "name": "spaces/AAAABBBBBB"
        },
        "argumentText": "Hello world"
    }
}
ไม่รวมข้อมูลทรัพยากร
{
    "message":
    {
        "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD"
    }
}
ผู้ใช้จะกลายเป็นผู้จัดการพื้นที่ทำงาน

google.workspace.chat.membership.v1.updated

รวมข้อมูลทรัพยากร
{
    "membership":
    {
        "name": "spaces/AAAABBBBBB/members/1234567890987654321",
        "state": "JOINED",
        "member":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "createTime": "1970-01-01T00:00:00Z",
        "role": "ROLE_MANAGER"
    }
}
ไม่รวมข้อมูลทรัพยากร
{
    "membership":
    {
        "name": "spaces/AAAABBBBBB/members/1234567890987654321"
    }
}
ผู้ใช้อัปเดตคำอธิบายของพื้นที่ทำงานเป็น "ทีมขายสำหรับ Cymbal Labs" google.workspace.chat.space.v1.updated
รวมข้อมูลทรัพยากร
{
    "space":
    {
        "name": "spaces/AAAABBBBBB",
        "displayName": "Cymbal Sales",
        "spaceThreadingState": "THREADED_MESSAGES",
        "spaceType": "SPACE",
        "spaceDetails":
        {
            "description": "Sales team for Cymbal Labs."
        },
        "spaceHistoryState": "HISTORY_ON"
    }
}
ไม่รวมข้อมูลทรัพยากร
{
    "space":
    {
        "name": "spaces/AAAABBBBBB"
    }
}
เพิ่มผู้ใช้ Chat 2 คนไปยังพื้นที่ทำงานพร้อมกัน google.workspace.chat.membership.v1.batchCreated
รวมข้อมูลทรัพยากร
{
    "memberships": [
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/1234567890987654321",
            "state": "JOINED",
            "member":
            {
                "name": "users/1234567890987654321",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        },
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/987654321234567890",
            "state": "JOINED",
            "member":
            {
                "name": "users/987654321234567890",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        }
    ]
}
ไม่รวมข้อมูลทรัพยากร
{
    "memberships": [
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/1234567890987654321"
          }
        },
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/98765432123456789019"
          }
        }
    ]
}
ผู้ใช้รีแอ็กต่อข้อความด้วยอีโมจิ 😊 google.workspace.chat.reaction.v1.created
รวมข้อมูลทรัพยากร
{
    "reaction":
    {
        "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
        "user":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "emoji":
        {
            "unicode": "😊"
        }
    }
}
ละเว้นข้อมูลทรัพยากร
{
    "reaction":
    {
        "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
    }
}
ผู้ใช้แสดงความรู้สึกต่อข้อความด้วยอีโมจิ 😊 และอีโมจิ 😸 google.workspace.chat.reaction.v1.batchCreated
รวมข้อมูลทรัพยากร
{
    "reactions": [
        {
          "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
            "user":
            {
                "name": "users/1234567890987654321",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😊"
            }
          }
        },
        {
          "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
            "user":
            {
                "name": "users/98765431234564321",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😸"
            }
          }
        }
    ]
}
ละเว้นข้อมูลทรัพยากร
{
    "reactions": [
      {
        "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
        },
        "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
        }
      }
    ]
}

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