หน้านี้แสดงภาพรวมของ 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 ผ่านการสมัครใช้บริการมีดังนี้
- แอป Chat จะสมัครใช้บริการพื้นที่ใน Chat
- พื้นที่ใน Chat มีการเปลี่ยนแปลง เช่น มีการโพสต์ข้อความใหม่ในพื้นที่ทำงาน
- Chat จะส่งกิจกรรมไปยังหัวข้อใน
Google Cloud Pub/Sub ซึ่งทำหน้าที่เป็นปลายทางการแจ้งเตือนสำหรับการสมัครใช้บริการ เหตุการณ์ดังกล่าวมีข้อมูลเกี่ยวกับสิ่งที่เปลี่ยนแปลง ตัวอย่างเช่น สำหรับกิจกรรมเกี่ยวกับข้อความใหม่ กิจกรรมจะมีรายละเอียดเกี่ยวกับทรัพยากร
Message
ที่สร้างขึ้น - แอป Chat จะประมวลผลข้อความ 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 |
วิธีสมัครใช้บริการพื้นที่ทำงานที่ต้องการ
วิธีสมัครใช้บริการพื้นที่ทำงานทั้งหมดที่ผู้ใช้เป็นสมาชิก
|
โปรดดูรายละเอียดที่หัวข้อสมัครใช้บริการกิจกรรมใน 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 Workspace
เหตุการณ์ของ Google Workspace เป็นไปตามข้อกำหนด Cloud Events ซึ่งเป็นวิธีการอธิบายข้อมูลเหตุการณ์ตามมาตรฐานอุตสาหกรรม เหตุการณ์ Google Workspace ประกอบด้วยข้อมูลต่อไปนี้
- แอตทริบิวต์ของ CloudEvent
- ข้อมูลเกี่ยวกับทรัพยากร Google Workspace ที่เปลี่ยนแปลงไปเนื่องจากเหตุการณ์
ส่วนต่อไปนี้จะอธิบายโครงสร้างของแอตทริบิวต์และข้อมูลสำหรับเหตุการณ์ Google Workspace
แอตทริบิวต์ CloudEvent
เหตุการณ์ใน Google Workspace จะมีแอตทริบิวต์ CloudEvents ที่จำเป็นดังต่อไปนี้
แอตทริบิวต์ | คำอธิบาย | ตัวอย่าง |
---|---|---|
|
ประเภทข้อมูลที่ส่งผ่านในเหตุการณ์ |
|
|
ตัวระบุสำหรับ CloudEvent |
|
|
แหล่งที่มาของเหตุการณ์ สำหรับกิจกรรม Google Workspace นี่คือชื่อแหล่งข้อมูลแบบเต็มของการสมัครใช้บริการ |
//workspaceevents.googleapis.com/subscriptions/chat-spaces-abcdefg
|
|
เวอร์ชันข้อมูลจำเพาะของ CloudEvents ที่ใช้สำหรับเหตุการณ์นี้ |
|
|
ทรัพยากร Google Workspace ที่เกิดเหตุการณ์ |
|
|
การประทับเวลาเมื่อเกิดเหตุการณ์ในรูปแบบ RFC 3339 |
|
|
ประเภทเหตุการณ์ของ Google Workspace |
|
ข้อมูลเหตุการณ์
ข้อมูลเหตุการณ์คือเพย์โหลดที่แสดงถึงการเปลี่ยนแปลงทรัพยากรเป้าหมายของการสมัครใช้บริการ ซึ่งรวมถึงทรัพยากรย่อยของทรัพยากรเป้าหมาย ในการสมัครใช้บริการ คุณระบุได้ว่าต้องการให้เพย์โหลดมีข้อมูลเกี่ยวกับทรัพยากรที่เปลี่ยนแปลง หรือแค่ชื่อของทรัพยากรที่มีการเปลี่ยนแปลง
เช่น หากสมัครใช้บริการพื้นที่ใน 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
ที่อัปเดตแล้ว ซึ่งอยู่ในรูปแบบสตริงที่เข้ารหัส Base64messageId
: ตัวระบุสำหรับข้อความ Google Cloud Pub/Sub
ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีระบุ CloudEvents ในข้อความ Google Cloud Pub/Sub ได้ที่การเชื่อมโยงโปรโตคอลของ Google Cloud Pub/Sub สำหรับ CloudEvents
หัวข้อที่เกี่ยวข้อง
- สมัครรับข้อมูลกิจกรรมใน Google Chat
- เหตุการณ์ในวงจร ของการสมัครใช้บริการ Google Workspace
- เลือกขอบเขต Google Workspace Events API
- สร้างการสมัครใช้บริการ Google Workspace