MetricDefinition

ההגדרה מגדירה מדד ספציפי לביצוע שאילתה, כולל שם שהוגדר על ידי המשתמש, סוג מדד הבסיס ומסננים אופציונליים.

ייצוג ב-JSON 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
שדות
name

string

חובה. השם שהמשתמש נתן למדד הזה. השם הזה ישמש כמפתח לערך של המדד הזה בתגובה.
baseMetric

object (BaseMetric)

חובה. מדד הבסיס לשאילתה.
filter

string

אופציונלי. מסננים אופציונליים להחלה על המדד.

BaseMetric

מציין את מדד הבסיס לביצוע שאילתה. יכול להיות שזה מדד רגיל מוגדר מראש או מדד מותאם אישית שהוגדר על ידי המשתמש (אם תהיה תמיכה באפשרות הזו בעתיד).

ייצוג ב-JSON 
{

  // Union field metric can be only one of the following:
  "standardMetric": enum (StandardMetric)
  // End of list of possible types for union field metric.
}
שדות
שדה איחוד metric. המדד הספציפי לשליחת שאילתה. הערך metric יכול להיות רק אחד מהבאים:
standardMetric

enum (StandardMetric)

מדד רגיל שהוגדר מראש.

StandardMetric

רשימה של מדדים רגילים מוגדרים מראש שאפשר להריץ עליהם שאילתות.

טיפוסים בני מנייה (enum)
STANDARD_METRIC_UNSPECIFIED מדד רגיל לא מוגדר. אין להשתמש בערך הזה באופן ישיר.
FEEDBACK_LOOP_ID מדד מוגדר מראש למזהה של לולאת משוב (FBL).
FEEDBACK_LOOP_SPAM_RATE מדד מוגדר מראש לשיעור הספאם של לולאת משוב (FBL). המסנן צריך להיות מסוג feedback_loop_id = "" כאשר הוא אחד ממזהי לולאות המשוב התקינים.
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 תומך בתחביר מוגבל. הפורמטים הנתמכים הם:

  • ריק: לא מוחל מסנן.
  • errorType = ""
  • errorType = "" AND error_reason = ""

אם מספקים מסנן ריק, המדד יצטבר בכל סוגי השגיאות והסיבות. אם מציינים רק את errorType, המדד יצטבר לפי כל הסיבות לסוג הזה.

ערכים נתמכים:

  • דחייה
  • temp_fail

הערכים הנתמכים תלויים ב:

  • עבור 'דחייה': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • ‫For 'temp_fail': [anomalous_traffic_pattern, other]
DELIVERY_ERROR_RATE

שיעור שגיאות המסירה לסוג שגיאת המסירה שצוין. השדה filter תומך בתחביר מוגבל. הפורמטים הנתמכים הם:

  • ריק: לא מוחל מסנן.
  • error_type = ""
  • error_type = "" AND error_reason = ""

אם מספקים מסנן ריק, המדד יצטבר בכל סוגי השגיאות והסיבות. אם מציינים רק את errorType, המדד יצטבר לפי כל הסיבות לסוג הזה.

ערכים נתמכים:

  • דחייה
  • temp_fail

הערכים הנתמכים תלויים ב:

  • עבור 'דחייה': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • ‫For 'temp_fail': [anomalous_traffic_pattern, other]