REST Resource: alerts

แหล่งข้อมูล: การแจ้งเตือน

การแจ้งเตือนที่ส่งผลต่อลูกค้า

การแสดง JSON 
{
  "customerId": string,
  "alertId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "type": string,
  "source": string,
  "data": {
    "@type": string,
    field1: ...,
    ...
  },
  "securityInvestigationToolLink": string,
  "deleted": boolean,
  "metadata": {
    object (AlertMetadata)
  },
  "updateTime": string,
  "etag": string
}
ช่อง
customerId

string

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันของบัญชี Google Workspace ของลูกค้า
alertId

string

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันสำหรับการแจ้งเตือน
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างการแจ้งเตือนนี้
startTime

string (Timestamp format)

ต้องระบุ เวลาที่เหตุการณ์ที่ทำให้เกิดการแจ้งเตือนนี้เริ่มขึ้นหรือตรวจพบ
endTime

string (Timestamp format)

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

string

ต้องระบุ ประเภทของการแจ้งเตือน เอาต์พุตนี้จะปรากฏหลังจากสร้างการแจ้งเตือนแล้วเท่านั้น โปรดดูรายการประเภทการแจ้งเตือนที่ใช้ได้ที่หัวข้อประเภทการแจ้งเตือนของ Google Workspace
source

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันของระบบที่รายงานการแจ้งเตือน เอาต์พุตนี้จะปรากฏหลังจากสร้างการแจ้งเตือนแล้วเท่านั้น

แหล่งที่มาที่รองรับมีดังต่อไปนี้

  • การดำเนินการของ Google
  • การจัดการอุปกรณ์เคลื่อนที่
  • ฟิชชิง Gmail
  • ป้องกันข้อมูลรั่วไหล
  • การถ่ายโอนข้อมูลทั้งโดเมน
  • การโจมตีที่ได้รับการสนับสนุนจากรัฐ
  • Google Identity
  • การหยุดทำงานของแอป
data

object

ไม่บังคับ ข้อมูลที่เชื่อมโยงกับการแจ้งเตือนนี้ เช่น google.apps.alertcenter.type.DeviceCompromised
deleted

boolean

เอาต์พุตเท่านั้น True หากมีการทำเครื่องหมายการแจ้งเตือนนี้ให้ลบ
metadata

object (AlertMetadata)

เอาต์พุตเท่านั้น ข้อมูลเมตาที่เชื่อมโยงกับการแจ้งเตือนนี้
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่การแจ้งเตือนนี้ได้รับการอัปเดตล่าสุด
etag

string

ไม่บังคับ etag ใช้สำหรับการควบคุมการเกิดขึ้นพร้อมกันอย่างมีประสิทธิภาพเพื่อช่วยป้องกันการอัปเดตการแจ้งเตือนพร้อมกันไม่ให้เขียนทับกัน ขอแนะนำให้ระบบใช้ etag ในรอบ Read-modify-Write เพื่ออัปเดตการแจ้งเตือนเพื่อหลีกเลี่ยงเงื่อนไขการแข่งขัน โดยจะส่ง etag กลับไปในการตอบกลับซึ่งมีการแจ้งเตือน และระบบจะต้องใส่ eTag นั้นในการแจ้งเตือนให้อัปเดตเพื่อให้มั่นใจว่าการเปลี่ยนแปลงจะมีผลกับการแจ้งเตือนเวอร์ชันเดียวกัน

หากไม่มีการระบุ etag ในการแจ้งเตือนให้อัปเดต การแจ้งเตือนที่มีอยู่จะถูกเขียนทับแบบตาบอด

AlertMetadata

ข้อมูลเมตาการแจ้งเตือน

การแสดง JSON 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
ช่อง
customerId

string

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันของบัญชี Google Workspace ของลูกค้า
alertId

string

เอาต์พุตเท่านั้น ตัวระบุการแจ้งเตือน
status

string

สถานะปัจจุบันของการแจ้งเตือน ค่าที่รองรับมีดังนี้

  • NOT_STARTED
  • IN_PROGRESS
  • ปิดกิจการ
assignee

string

อีเมลของผู้ใช้ที่กำหนดให้การแจ้งเตือน
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตข้อมูลเมตานี้ครั้งล่าสุด
severity

string

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

  • สูง
  • ปานกลาง
  • ต่ำ
etag

string

ไม่บังคับ etag ใช้สำหรับการควบคุมการเกิดขึ้นพร้อมกันอย่างมีประสิทธิภาพเพื่อช่วยป้องกันการอัปเดตข้อมูลเมตาของการแจ้งเตือนพร้อมกันไม่ให้เขียนทับกัน ขอแนะนำให้ระบบใช้ etag ในรอบ Read-modify-write เพื่ออัปเดตข้อมูลเมตาเพื่อหลีกเลี่ยงเงื่อนไขการแข่งขัน โดยจะส่ง etag กลับไปในการตอบกลับซึ่งมีข้อมูลเมตาของการแจ้งเตือน และระบบจะต้องใส่ eTag นั้นในคำขออัปเดตข้อมูลเมตาของการแจ้งเตือนเพื่อให้มั่นใจว่าการเปลี่ยนแปลงจะมีผลกับข้อมูลเมตาการแจ้งเตือนเวอร์ชันเดียวกัน

หากไม่ได้ระบุ etag ไว้ในการเรียกใช้ให้อัปเดตข้อมูลเมตาของการแจ้งเตือน ระบบจะเขียนทับข้อมูลเมตาการแจ้งเตือนที่มีอยู่แบบปิดบังหน้าเว็บจริง

เมธอด

batchDelete

 ดำเนินการลบแบบกลุ่มกับการแจ้งเตือน

batchUndelete

 ดำเนินการยกเลิกการลบแบบกลุ่มกับการแจ้งเตือน

delete

 ทำเครื่องหมายการแจ้งเตือนการลบที่ระบุไว้

get

 รับการแจ้งเตือนที่ระบุ

getMetadata

 แสดงผลข้อมูลเมตาของการแจ้งเตือน

list

 แสดงการแจ้งเตือน

undelete

 การกู้คืนหรือ "ยกเลิกการลบ" การแจ้งเตือนที่ทำเครื่องหมายให้ลบภายใน 30 วันที่ผ่านมา