สมัครรับข้อมูลกิจกรรมโดยใช้ 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 Chat ผ่านการสมัครใช้บริการดังนี้

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

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

ต่อไปนี้คือรายการคำศัพท์ทั่วไปที่ใช้ใน 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 การสมัครใช้บริการแต่ละรายการจะตรวจสอบได้เพียงทรัพยากรเดียว หากต้องการดูว่า Google Workspace Events API รองรับทรัพยากรใดของ Google Workspace โปรดดูกิจกรรม 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 ไดรฟ์
• สมัครรับข้อมูลกิจกรรมของ Google Meet

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

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

• แอตทริบิวต์ของ CloudEvent
• ข้อมูล เกี่ยวกับทรัพยากร Google Workspace ที่เปลี่ยนแปลงอันเป็นผลมาจาก เหตุการณ์

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

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

เหตุการณ์ใน Google Workspace มีแอตทริบิวต์ CloudEvents ที่จำเป็นต่อไปนี้

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

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

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

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

หัวข้อที่เกี่ยวข้อง

• เลือกขอบเขต Google Workspace Events API
• สร้างการสมัครใช้บริการ Google Workspace