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

object

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

boolean

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

object (AlertMetadata)

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

string (Timestamp format)

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

string

ไม่บังคับ etag ใช้สำหรับการควบคุมการทํางานพร้อมกันแบบมองโลกในแง่ดีเพื่อช่วยป้องกันไม่ให้การอัปเดตการแจ้งเตือนพร้อมกันเขียนทับกัน เราขอแนะนําอย่างยิ่งให้ระบบใช้ etag ในรอบการอ่าน แก้ไข และเขียนเพื่อทำการอัปเดตการแจ้งเตือนเพื่อหลีกเลี่ยงเงื่อนไขการแข่งขัน: ระบบจะแสดงผล 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 ในรอบการอ่าน แก้ไข และเขียนเพื่อทำการอัปเดตข้อมูลเมตาเพื่อหลีกเลี่ยงเงื่อนไขการแข่งขัน: ระบบจะแสดงผล etag ในการตอบกลับซึ่งมีข้อมูลเมตาการแจ้งเตือน และระบบควรใส่ etag นั้นในคำขอเพื่ออัปเดตข้อมูลเมตาการแจ้งเตือนเพื่อให้แน่ใจว่าการเปลี่ยนแปลงจะมีผลกับข้อมูลเมตาการแจ้งเตือนเวอร์ชันเดียวกัน

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

เมธอด

batchDelete

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

batchUndelete

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

delete

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

get

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

getMetadata

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

list

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

undelete

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