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) ID 的预定义指标。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 = "" 且 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 = "" 且 error_reason = ""

如果提供的是空过滤条件，则系统将汇总所有错误类型和原因的指标。如果仅指定了 error_type，则系统将针对相应类型的所有原因汇总指标。

支持的 值：

  • 拒绝
  • temp_fail

支持的 值取决于 ：

  • 对于“reject”：[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 = "" 且 error_reason = ""

如果提供的是空过滤条件，则系统将汇总所有错误类型和原因的指标。如果仅指定了 error_type，则系统将针对相应类型的所有原因汇总指标。

支持的 值：

  • 拒绝
  • temp_fail

支持的 值取决于 ：

  • 对于“reject”：[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]