MetricDefinition

تحدّد هذه السمة مقياسًا معيّنًا للبحث عنه، بما في ذلك اسم يحدّده المستخدم ونوع المقياس الأساسي والفلاتر الاختيارية.

تمثيل JSON 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
الحقول
name

string

الحقل مطلوب. اسم المقياس الذي يحدّده المستخدم سيتم استخدام هذا الاسم كمفتاح لقيمة هذا المقياس في الردّ.
baseMetric

object (BaseMetric)

الحقل مطلوب. المقياس الأساسي المطلوب الاستعلام عنه.
filter

string

اختياريّ. فلاتر اختيارية لتطبيقها على المقياس

BaseMetric

تحدّد هذه السمة المقياس الأساسي المطلوب البحث عنه، ويمكن أن يكون مقياسًا عاديًا محدّدًا مسبقًا أو مقياسًا مخصّصًا يحدّده المستخدم (إذا كان متاحًا في المستقبل).

تمثيل JSON 
{

  "standardMetric": enum (StandardMetric)
}
الحقول
حقل الربط metric المقياس المحدّد المطلوب البحث عنه. يمكن أن يكون التعليق metric إحدى القيم التالية فقط:
standardMetric

enum (StandardMetric)

مقياس موحّد محدّد مسبقًا

StandardMetric

تعدّد المقاييس العادية المحدّدة مسبقًا التي يمكن طلب البحث عنها.

عمليات التعداد
STANDARD_METRIC_UNSPECIFIED مقياس عادي غير محدّد يجب عدم استخدام هذه القيمة مباشرةً.
FEEDBACK_LOOP_ID

مقياس محدّد مسبقًا لرقم تعريف "تقرير الملاحظات والآراء" (FBL) يتيح الحقل filter اختيار نوع مفتاح التجميع. التنسيق المتوافق: aggregation_key_type = "".

القيم المسموح بها:

  • FROM_HEADER: (الإعداد التلقائي) يتضمّن المقياس الرسائل التي يتطابق فيها نطاق الرأس "من:" مع النطاق المطلوب.
  • ALL_DKIM: يتضمّن المقياس الرسائل التي يتطابق فيها أحد نطاقات DKIM الموقَّعة مع النطاق المطلوب.
FEEDBACK_LOOP_SPAM_RATE

مقياس محدّد مسبقًا لمعدّل الرسائل غير المرغوب فيها في "تقرير الملاحظات والآراء" يتطلّب الحقل filter feedback_loop_id ويمكنه اختياريًا قبول aggregation_key_type. التنسيقات المتوافقة هي:

  • feedback_loop_id = ""
  • ‫feedback_loop_id = "" AND aggregation_key_type = ""

في حال عدم توفّر aggregation_key_type، يتم ضبط القيمة التلقائية على FROM_HEADER.

القيم المسموح بها:

  • FROM_HEADER: (الإعداد التلقائي) يتضمّن المقياس الرسائل التي يتطابق فيها نطاق الرأس "من:" مع النطاق المطلوب.
  • ALL_DKIM: يتضمّن المقياس الرسائل التي يتطابق فيها أحد نطاقات DKIM الموقَّعة مع النطاق المطلوب.
SPAM_RATE مقياس محدّد مسبقًا لمعدل الرسائل غير المرغوب فيها
AUTH_SUCCESS_RATE معدّل نجاح آليات المصادقة (DKIM وSPF وDMARC) يجب أن يكون نوع الفلتر auth_type = "" حيث هو أحد القيم التالية: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT يجب أن يكون فلتر معدّل الرسائل المشفّرة باستخدام بروتوكول أمان طبقة النقل (TLS) أثناء النقل من النوع traffic_direction = "" حيث هي إحدى القيم التالية: [inbound, outbound]
TLS_ENCRYPTION_RATE يجب أن يكون فلتر معدّل الرسائل المشفّرة باستخدام بروتوكول أمان طبقة النقل (TLS) أثناء النقل من النوع traffic_direction = "" حيث هي إحدى القيم التالية: [inbound, outbound]
DELIVERY_ERROR_COUNT

إجمالي عدد أخطاء التسليم التي حدثت (عمليات رفض مؤقتة أو دائمة) يتيح الحقل filter استخدام بنية محدودة. التنسيقات المتوافقة هي:

  • قيمة فارغة: بدون فلتر.
  • error_type = ""
  • ‫error_type = "" AND error_reason = ""

في حال توفير فلتر فارغ، سيتم تجميع المقياس على مستوى جميع أنواع الأخطاء وأسبابها. في حال تحديد error_type فقط، سيتم تجميع المقياس على مستوى جميع أسباب هذا النوع.

القيم المسموح بها:

  • رفض
  • temp_fail

تعتمد القيم المسموح بها على :

  • بالنسبة إلى "رفض": [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • بالنسبة إلى الخطأ temp_fail: [anomalous_traffic_pattern, other]
DELIVERY_ERROR_RATE

معدّل أخطاء التسليم لنوع خطأ التسليم المحدّد يتيح الحقل filter استخدام بنية محدودة. التنسيقات المتوافقة هي:

  • قيمة فارغة: بدون فلتر.
  • error_type = ""
  • ‫error_type = "" AND error_reason = ""

في حال توفير فلتر فارغ، سيتم تجميع المقياس على مستوى جميع أنواع الأخطاء وأسبابها. في حال تحديد error_type فقط، سيتم تجميع المقياس على مستوى جميع أسباب هذا النوع.

القيم المسموح بها:

  • رفض
  • temp_fail

تعتمد القيم المسموح بها على :

  • بالنسبة إلى "رفض": [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • بالنسبة إلى الخطأ temp_fail: [anomalous_traffic_pattern, other]