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 = "" 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 のみが指定されている場合、指標はそのタイプのすべての理由で集計されます。

サポートされている 値:

  • reject
  • 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 = "" AND error_reason = ""

空のフィルタを指定すると、指標はすべてのエラータイプと理由で集計されます。error_type のみが指定されている場合、指標はそのタイプのすべての理由で集計されます。

サポートされている 値:

  • reject
  • 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]