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:（デフォルト）指標には、リクエストされたドメインと一致する送信元ヘッダーのドメインを含むメッセージが含まれます。
  • 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:（デフォルト）指標には、リクエストされたドメインと一致する送信元ヘッダーのドメインを含むメッセージが含まれます。
  • 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]