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

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

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

วิธีที่แอปได้รับกิจกรรม

หากต้องการให้แอปได้รับกิจกรรมใน Google Workspace ให้ใช้ Google Workspace Events API เพื่อสร้างการสมัครรับข้อมูลทรัพยากรของ Google Workspace

รูปที่ 1 ตัวอย่างวิธีที่ Google Workspace Events API ส่งกิจกรรมไปยัง แอป Google Chat

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

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

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

คำที่ใช้กันทั่วไปใน Google Workspace Events API ได้แก่

กิจกรรมใน Google Workspace

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

กิจกรรมการสมัครรับข้อมูล

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

กิจกรรมในวงจร

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

การสมัครใช้บริการ Google Workspace

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

ทรัพยากรเป้าหมาย

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

ประเภทกิจกรรม

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

ปลายทางการแจ้งเตือน

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

ตัวเลือกเพย์โหลด

ข้อมูลกิจกรรมที่คุณต้องการรับเกี่ยวกับทรัพยากรที่เปลี่ยนแปลง

กิจกรรมใน Google Workspace ที่รองรับ

กิจกรรมที่แอปได้รับจะขึ้นอยู่กับทรัพยากรเป้าหมายของการสมัครรับข้อมูล ตารางต่อไปนี้แสดงกิจกรรมที่รองรับสำหรับทรัพยากรเป้าหมายที่เป็นไปได้แต่ละรายการ

ทรัพยากรเป้าหมาย	กิจกรรมที่รองรับ
พื้นที่ใน Chat	ข้อความ การเป็นสมาชิก รีแอ็กชัน พื้นที่
ผู้ใช้ Chat	การเป็นสมาชิก SpaceReadState ThreadReadState
ไฟล์ Google ไดรฟ์หรือไฟล์ไดรฟ์ที่แชร์	ข้อเสนอการเข้าถึง การอนุมัติ ความคิดเห็น ไฟล์ การตอบกลับ
พื้นที่การประชุมและผู้ใช้ Google Meet	การประชุม เซสชันของผู้เข้าร่วม การบันทึก โน้ตอัจฉริยะ ข้อความถอดเสียง

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

• สมัครรับข้อมูลกิจกรรมใน Chat
• สมัครรับข้อมูลกิจกรรมในไดรฟ์
• สมัครรับข้อมูลกิจกรรมใน 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 คุณจะได้รับกิจกรรมเกี่ยวกับข้อความใหม่ในพื้นที่ สำหรับกิจกรรมเกี่ยวกับข้อความใหม่ ข้อมูลกิจกรรมจะมีเพย์โหลดที่มีทรัพยากร spaces.message ของ Chat ที่สร้างขึ้น

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

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีระบุ CloudEvents ในข้อความ Google Cloud Pub/Sub ได้ที่ Google Cloud Pub/Sub Protocol Binding for CloudEvents

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

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