สมัครรับข้อมูลกิจกรรมโดยใช้ 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 ส่งเหตุการณ์

วิธีที่ Google Workspace Events API ส่งเหตุการณ์ไปยังแอปของคุณผ่านการสมัครใช้บริการ

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

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

รายการต่อไปนี้คือรายการคำศัพท์ทั่วไปที่ใช้ใน Google Workspace Events API

กิจกรรมใน 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
พื้นที่ใน Google Chat //chat.googleapis.com/spaces/SPACE_ID
  • ข้อความ
  • การเป็นสมาชิก
  • รีแอ็กชัน
  • พื้นที่

โปรดดูรายละเอียดที่หัวข้อสมัครรับข้อมูลกิจกรรม Google Chat		 ผู้ใช้ Google Chat ที่ให้สิทธิ์การสมัครใช้บริการต้องเป็นสมาชิกของพื้นที่ทำงานผ่านบัญชี Google Workspace หรือ Google
ผู้ใช้ Google Chat //cloudidentity.googleapis.com/users/USER_ID
  • การเป็นสมาชิก

โปรดดูรายละเอียดที่หัวข้อสมัครรับข้อมูลกิจกรรม Google Chat

การสมัครใช้บริการจะได้รับเหตุการณ์เกี่ยวกับผู้ใช้ที่ให้สิทธิ์การสมัครใช้บริการเท่านั้น ผู้ใช้ให้สิทธิ์การสมัครใช้บริการในนามของผู้ใช้รายอื่นไม่ได้
Google Meet
พื้นที่ประชุม Google Meet //meet.googleapis.com/spaces/SPACE_ID
  • การประชุม
  • เซสชันผู้เข้าร่วม
  • การบันทึก
  • ข้อความถอดเสียง

โปรดดูรายละเอียดที่หัวข้อสมัครรับข้อมูลกิจกรรมของ Google Meet
ผู้ใช้ Google Meet //cloudidentity.googleapis.com/users/USER_ID
  • การประชุม
  • เซสชันผู้เข้าร่วม
  • การบันทึก
  • ข้อความถอดเสียง

โปรดดูรายละเอียดที่หัวข้อสมัครรับข้อมูลกิจกรรมของ Google Meet

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

  • เจ้าของพื้นที่การประชุม
  • ผู้จัดกิจกรรมใน Google ปฏิทินที่เชื่อมโยงกับพื้นที่การประชุม

โครงสร้างของเหตุการณ์ใน 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 ก็จะได้รับกิจกรรมเกี่ยวกับข้อความใหม่ในพื้นที่ทำงาน สำหรับเหตุการณ์เกี่ยวกับข้อความใหม่ ข้อมูลเหตุการณ์จะมีเพย์โหลดที่มีทรัพยากร 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 ที่อัปเดตแล้ว ซึ่งจัดรูปแบบเป็นสตริงที่เข้ารหัสฐาน 64
  • messageId: ตัวระบุสำหรับข้อความ Google Cloud Pub/Sub

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