หน้านี้ได้รับการแปลโดย Cloud Translation API

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

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

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

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

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

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