รับและตอบกลับเหตุการณ์ในวงจรสำหรับการสมัครใช้บริการ Google Workspace

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

Google Workspace Events API จะส่งเหตุการณ์ในวงจรประเภทต่อไปนี้

แอปควรจัดการกับประเภทเหตุการณ์ในวงจรเหล่านี้อย่างชัดแจ้ง และเพิกเฉยต่อเหตุการณ์ประเภทใหม่ๆ ที่อาจปรากฏในอนาคต

เหตุการณ์ในวงจรจาก Google Workspace Events API มีโครงสร้างตามข้อกำหนดของ CloudEvents ดูข้อมูลเพิ่มเติมได้ที่โครงสร้างของเหตุการณ์ใน Google Workspace

เหตุการณ์การระงับ

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

หากต้องการแจ้งให้คุณทราบเกี่ยวกับการระงับ Google Workspace Events API จะส่งเหตุการณ์วงจรที่มีประเภทเหตุการณ์ google.workspace.events.subscription.v1.suspended

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

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

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.suspended",
  "time": "2023-06-08T06:50:43.641299Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "suspension_reason": "ENDPOINT_PERMISSION_DENIED",
      ...
    }
  }
}

เหตุการณ์การช่วยเตือนวันหมดอายุ

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

หากต้องการแจ้งให้คุณทราบเกี่ยวกับการสมัครใช้บริการที่ใกล้จะหมดอายุ Google Workspace Events API จะส่งเหตุการณ์ในวงจร 12 ชั่วโมงและ 1 ชั่วโมงก่อนเวลาหมดอายุ ประเภทเหตุการณ์สำหรับเหตุการณ์ในวงจรคือ google.workspace.events.subscription.v1.expirationReminder

เมื่อได้รับกิจกรรมช่วยเตือนการหมดอายุ คุณจะใช้เมธอด subscriptions.update() เพื่ออัปเดตเวลาหมดอายุได้ โปรดดูรายละเอียดที่หัวข้ออัปเดตหรือต่ออายุการสมัครใช้บริการ Google Workspace

ตัวอย่างต่อไปนี้แสดง CloudEvent สำหรับเหตุการณ์ในวงจรของการสมัครใช้บริการ Google Workspace ที่จะหมดอายุ

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.expirationReminder",
  "time": "2023-06-08T06:50:43.641299Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "expire_time": "2023-06-08T18:50:43.641299Z",
      ...
    }
  }
}

เหตุการณ์การสมัครใช้บริการหมดอายุ

Google Workspace Events API จะส่งเหตุการณ์ในวงจรให้คุณเมื่อการสมัครใช้บริการหมดอายุ ประเภทเหตุการณ์สำหรับเหตุการณ์ในวงจรนี้คือ google.workspace.events.subscription.v1.expired

Google Workspace Events API จะลบการสมัครใช้บริการที่หมดอายุแล้วออกอย่างถาวร หากการสมัครใช้บริการหมดอายุ คุณจะใช้เมธอด subscriptions.create() เพื่อสร้างการสมัครใช้บริการอื่นได้ โปรดดูรายละเอียดที่หัวข้อสร้างการสมัครใช้บริการ Google Workspace

ค่าต่อไปนี้แสดง CloudEvent สำหรับเหตุการณ์ในวงจรเกี่ยวกับการสมัครใช้บริการ Google Workspace ที่หมดอายุแล้ว

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.expired",
  "time": "2023-06-08T07:00:00.000000Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "expire_time": "2023-06-08T07:00:00.000000Z",
      ...
    }
  }
}