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
  • انقطاع الخدمة عن التطبيقات
data

object

اختياريّ. البيانات المرتبطة بهذا التنبيه، على سبيل المثال google.apps.alertcenter.type.DeviceCompromised
deleted

boolean

النتائج فقط. True إذا تم وضع علامة على هذا التنبيه لحذفه.
metadata

object (AlertMetadata)

النتائج فقط. البيانات الوصفية المرتبطة بهذا التنبيه
updateTime

string (Timestamp format)

النتائج فقط. وقت آخر تعديل لهذا التنبيه
etag

string

اختياريّ. يُستخدَم 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 يومًا