MetricDefinition

Define una métrica específica para consultar, incluido un nombre definido por el usuario, el tipo de métrica base y filtros opcionales.

Representación JSON 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Campos
name

string

Obligatorio. Es el nombre definido por el usuario para esta métrica. Este nombre se usará como clave para el valor de esta métrica en la respuesta.
baseMetric

object (BaseMetric)

Obligatorio. Es la métrica subyacente para consultar.
filter

string

Es opcional. Son filtros opcionales para aplicar a la métrica.

BaseMetric

Especifica la métrica base para consultar, que puede ser una métrica estándar predefinida o una métrica personalizada definida por el usuario (si se admite en el futuro).

Representación JSON 
{

  "standardMetric": enum (StandardMetric)
}
Campos
Campo de unión metric. Es la métrica específica para consultar. metric puede ser solo uno de los parámetros siguientes:
standardMetric

enum (StandardMetric)

Es una métrica estándar predefinida.

StandardMetric

Enumera las métricas estándar predefinidas que se pueden consultar.

Enums
STANDARD_METRIC_UNSPECIFIED Es una métrica estándar no especificada. Este valor no se debe usar directamente.
FEEDBACK_LOOP_ID

Es una métrica predefinida para el ID del Ciclo de reacción (FBL). El campo filter admite la selección del tipo de clave de agregación. Formato admitido: aggregation_key_type = "".

Valores admitidos :

  • FROM_HEADER: (Predeterminado) La métrica incluye mensajes con el dominio del encabezado De que coincide con el dominio solicitado.
  • ALL_DKIM: La métrica incluye mensajes con uno de los dominios DKIM firmados que coinciden con el dominio solicitado.
FEEDBACK_LOOP_SPAM_RATE

Es una métrica predefinida para el porcentaje de spam del Ciclo de reacción (FBL). El campo filter requiere un feedback_loop_id y, de manera opcional, acepta un aggregation_key_type. Los formatos admitidos son los siguientes:

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

Si se omite aggregation_key_type, el valor predeterminado es FROM_HEADER.

Valores admitidos :

  • FROM_HEADER: (Predeterminado) La métrica incluye mensajes con el dominio del encabezado De que coincide con el dominio solicitado.
  • ALL_DKIM: La métrica incluye mensajes con uno de los dominios DKIM firmados que coinciden con el dominio solicitado.
SPAM_RATE Es una métrica predefinida para el porcentaje de spam.
AUTH_SUCCESS_RATE Es el porcentaje de éxito de los mecanismos de autenticación (DKIM, SPF, DMARC). El filtro debe ser del tipo auth_type = "", donde es uno de los siguientes: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT Es el porcentaje de mensajes que se encriptaron con TLS en tránsito. El filtro debe ser del tipo traffic_direction = "", donde es uno de los siguientes: [inbound, outbound].
TLS_ENCRYPTION_RATE Es el porcentaje de mensajes que se encriptaron con TLS en tránsito. El filtro debe ser del tipo traffic_direction = "", donde es uno de los siguientes: [inbound, outbound].
DELIVERY_ERROR_COUNT

Es el recuento total de errores de entrega encontrados (rechazos temporales o permanentes). El campo filter admite una sintaxis limitada. Los formatos admitidos son los siguientes:

  • Vacío: No se aplica ningún filtro.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Si se proporciona un filtro vacío, la métrica se agregará en todos los tipos y motivos de error. Si solo se especifica error_type, la métrica se agregará en todos los motivos de ese tipo.

Valores admitidos :

  • rechazar
  • temp_fail

Los valores admitidos dependen de :

  • Para 'rechazar': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Para "temp_fail": [anomalous_traffic_pattern, other]
DELIVERY_ERROR_RATE

Es el porcentaje de errores de entrega para el tipo de error de entrega especificado. El campo filter admite una sintaxis limitada. Los formatos admitidos son los siguientes:

  • Vacío: No se aplica ningún filtro.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Si se proporciona un filtro vacío, la métrica se agregará en todos los tipos y motivos de error. Si solo se especifica error_type, la métrica se agregará en todos los motivos de ese tipo.

Valores admitidos :

  • rechazar
  • temp_fail

Los valores admitidos dependen de :

  • Para 'rechazar': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Para "temp_fail": [anomalous_traffic_pattern, other]