สมัครรับข้อมูลกิจกรรมโดยใช้ Google Workspace Events API

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

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

วิธีที่แอปรับเหตุการณ์

หากต้องการให้แอปได้รับกิจกรรมใน Google Workspace ให้ใช้ Google Workspace Events API สำหรับสร้างการสมัครใช้บริการ Google Workspace ที่ไม่ซับซ้อน

วันที่ ภาพแสดงวิธีที่ Google Workspace Events API นำส่งเหตุการณ์
รูปที่ 1 ตัวอย่างวิธีที่ Google Workspace Events API จะส่งเหตุการณ์ไปยัง แอป Chat

ในตัวอย่างต่อไปนี้ แสดงวิธีที่ Google Workspace Events API ส่งมอบ กิจกรรมในแอป Google Chat ผ่านการสมัครใช้บริการ

  1. แอป Chat จะสมัครใช้บริการพื้นที่ใน Chat
  2. พื้นที่ใน Chat มีการเปลี่ยนแปลง เช่น มีการโพสต์ข้อความใหม่ อยู่ในพื้นที่ทำงาน
  3. Chat จะส่งกิจกรรมให้กับหัวข้อใน Google Cloud Pub/Sub ซึ่งทำหน้าที่เป็นจุดเชื่อมต่อการแจ้งเตือนสำหรับการสมัครใช้บริการ กิจกรรม มีข้อมูลเกี่ยวกับสิ่งที่เปลี่ยนแปลง เช่น สำหรับกิจกรรมเกี่ยวกับ กิจกรรมนี้มีรายละเอียดเกี่ยวกับทรัพยากร Message ที่ สร้าง แล้ว
  4. แอป Chat จะประมวลผล Google Cloud ข้อความ Pub/Sub ที่มีเหตุการณ์ และการดำเนินการหากจำเป็น

คำศัพท์ที่สำคัญ

ต่อไปนี้เป็นรายการคำศัพท์ทั่วไปที่ใช้ใน API กิจกรรม Google Workspace:

กิจกรรมของ Google Workspace

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

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

เอนทิตีที่มีชื่อซึ่งตรวจสอบทรัพยากรจาก Google Workspace แอปพลิเคชัน การสมัครใช้บริการจะแสดงด้วย Subscription ทรัพยากร การสมัครใช้บริการจะมีรายละเอียดดังนี้

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

เหตุการณ์ของ Google Workspace ที่รองรับ

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

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

ดูข้อมูลเพิ่มเติมได้ในคู่มือต่อไปนี้

โครงสร้างของกิจกรรมใน Google Workspace

กิจกรรมใน Google Workspace จะเป็นไปตาม CloudEvents ข้อกำหนดเฉพาะ ซึ่งเป็นวิธีอธิบายข้อมูลเหตุการณ์ตามมาตรฐานอุตสาหกรรม Google Workspace เหตุการณ์ต่างๆ จะมีข้อมูลต่อไปนี้

ส่วนต่อไปนี้จะอธิบายโครงสร้างของแอตทริบิวต์และข้อมูลสำหรับ กิจกรรมใน Google Workspace

แอตทริบิวต์ CloudEvent

กิจกรรมใน Google Workspace ต้องมีข้อมูลต่อไปนี้ แอตทริบิวต์ของ CloudEvents

แอตทริบิวต์ คำอธิบาย ตัวอย่าง

datacontenttype

ประเภทข้อมูลที่ส่งผ่านในเหตุการณ์

application/json

id

ตัวระบุสำหรับ CloudEvent

spaces/AAAABBBBBBB/spaceEvents/ABCDEFGHIJKLMNO

source

แหล่งที่มาของเหตุการณ์ สำหรับกิจกรรมใน Google Workspace นี่คือชื่อทรัพยากรแบบเต็มของการสมัครใช้บริการ //workspaceevents.googleapis.com/subscriptions/chat-spaces-abcdefg

specversion

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

1.0

subject

ทรัพยากร Google Workspace ที่เกิดเหตุการณ์

//chat.googleapis.com/spaces/AAAABBBBBBB

time

การประทับเวลาเมื่อเกิดเหตุการณ์ในรูปแบบ RFC 3339

2023-09-07T21:37:36.260127Z

type

ประเภทเหตุการณ์ของ Google Workspace

google.workspace.chat.message.v1.created

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

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

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

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

  • รวมข้อมูลทรัพยากร: มีช่องของการเปลี่ยนแปลงบางช่องหรือทุกช่อง ทรัพยากร หากคุณเลือกที่จะรวมข้อมูลทรัพยากร การสมัครใช้บริการของคุณ ระยะเวลาจำกัดอยู่ที่ 4 ชั่วโมงหรือ 24 ชั่วโมงหากคุณใช้ทั่วทั้งโดเมน การมอบสิทธิ์
  • ยกเว้นข้อมูลทรัพยากร: มีเฉพาะชื่อของรายการที่เปลี่ยนแปลง ทรัพยากร ระยะเวลาการสมัครใช้บริการสูงสุด 7 วัน หากต้องการดูรายละเอียดเกี่ยวกับ เหตุการณ์นั้น คุณสามารถค้นหาทรัพยากรโดยใช้ชื่อทรัพยากรได้

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

เหตุการณ์เป็นข้อความ Google Cloud Pub/Sub

การสมัครใช้บริการ Google Workspace Events API จะใช้ Google Cloud Pub/Sub เป็นปลายทางการแจ้งเตือนที่ได้รับ Google Workspace กิจกรรม ระบบจะเข้ารหัสเหตุการณ์เป็นข้อความ Google Cloud Pub/Sub แอปของคุณ ประมวลผลข้อความ Google Cloud Pub/Sub เพื่อดำเนินการหรือตอบกลับได้ กิจกรรมนั้น

ตัวอย่างต่อไปนี้แสดงข้อความ Google Cloud Pub/Sub ที่ประกอบด้วย เหตุการณ์เกี่ยวกับข้อความที่อัปเดตในพื้นที่ใน Chat ได้แก่

 {
    "message":
    {
        "attributes":
        {
            "ce-datacontenttype": "application/json",
            "ce-id": "spaces/SPACE_ID/spaceEvents/SPACE_EVENT_ID",
            "ce-source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
            "ce-specversion": "1.0",
            "ce-subject": "//chat.googleapis.com/spaces/SPACE_ID",
            "ce-time": "2023-09-07T21:37:53.274191Z",
            "ce-type": "google.workspace.chat.message.v1.updated"
        },
        "data": "EVENT_DATA",
        "messageId": "PUBSUB_MESSAGE_ID",
        "orderingKey": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
        "publishTime": "2023-09-07T21:37:53.713Z"
    }
}

โปรดทราบช่องต่อไปนี้

  • attributes: แอตทริบิวต์สำหรับ CloudEvent ซึ่งประกอบด้วย ประเภทของเหตุการณ์ ในกรณีนี้ เหตุการณ์จะเกี่ยวกับข้อความที่อัปเดตใน พื้นที่ทำงาน
  • data: ข้อมูลเหตุการณ์ที่มีรายละเอียดเกี่ยวกับ ทรัพยากร spaces.message ซึ่งมีการจัดรูปแบบเป็นสตริงที่เข้ารหัส Base64
  • messageId: ตัวระบุสำหรับข้อความ Google Cloud Pub/Sub

หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีระบุ CloudEvent ใน Google Cloud Pub/Sub โปรดดูการเชื่อมโยงโปรโตคอล Google Cloud Pub/Sub สำหรับ CloudEvents