MetricDefinition

กำหนดเมตริกที่เฉพาะเจาะจงที่จะค้นหา รวมถึงชื่อที่ผู้ใช้กำหนด ประเภทเมตริกพื้นฐาน และตัวกรองที่ไม่บังคับ

การแสดง JSON
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
ช่อง
name

string

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

baseMetric

object (BaseMetric)

ต้องระบุ เมตริกพื้นฐานที่จะค้นหา

filter

string

ไม่บังคับ ตัวกรองที่ไม่บังคับที่จะใช้กับเมตริก

BaseMetric

ระบุเมตริกพื้นฐานที่จะค้นหา ซึ่งอาจเป็นเมตริกมาตรฐานที่กำหนดไว้ล่วงหน้าหรือเมตริกที่กำหนดเองซึ่งผู้ใช้กำหนด (หากรองรับในอนาคต)

การแสดง JSON
{

  "standardMetric": enum (StandardMetric)
}
ช่อง
ฟิลด์ Union metric เมตริกที่เฉพาะเจาะจงที่จะค้นหา metric สามารถเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
standardMetric

enum (StandardMetric)

เมตริกมาตรฐานที่กำหนดไว้ล่วงหน้า

StandardMetric

แสดงรายการเมตริกมาตรฐานที่กำหนดไว้ล่วงหน้าซึ่งสามารถค้นหาได้

Enum
STANDARD_METRIC_UNSPECIFIED เมตริกมาตรฐานที่ไม่ได้ระบุ ไม่ควรใช้ค่านี้โดยตรง
FEEDBACK_LOOP_ID

เมตริกที่กำหนดไว้ล่วงหน้าสำหรับรหัสรายงานความคิดเห็น (FBL) ช่อง filter รองรับการเลือกประเภทคีย์การรวมข้อมูล รูปแบบที่รองรับ: aggregation_key_type = ""

ค่าที่รองรับ

  • FROM_HEADER: (ค่าเริ่มต้น) เมตริกรวมข้อความที่มีโดเมนส่วนหัว From: ตรงกับโดเมนที่ขอ
  • ALL_DKIM: เมตริกรวมข้อความที่มีโดเมน DKIM ที่ลงชื่อโดเมนใดโดเมนหนึ่งตรงกับโดเมนที่ขอ
FEEDBACK_LOOP_SPAM_RATE

เมตริกที่กำหนดไว้ล่วงหน้าสำหรับอัตราจดหมายขยะของรายงานความคิดเห็น (FBL) ช่อง filter ต้องมี feedback_loop_id และเลือกรับ aggregation_key_type ได้ รูปแบบที่รองรับมีดังนี้

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

หากละเว้น aggregation_key_type ระบบจะใช้ FROM_HEADER เป็นค่าเริ่มต้น

ค่าที่รองรับ

  • FROM_HEADER: (ค่าเริ่มต้น) เมตริกรวมข้อความที่มีโดเมนส่วนหัว From: ตรงกับโดเมนที่ขอ
  • 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]