MetricDefinition

Define uma métrica específica para consulta, incluindo um nome definido pelo usuário, o tipo de métrica de base e filtros opcionais.

Representação JSON 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Campos
name

string

Obrigatório. O nome definido pelo usuário para essa métrica. Esse nome será usado como a chave do valor da métrica na resposta.
baseMetric

object (BaseMetric)

Obrigatório. A métrica subjacente a ser consultada.
filter

string

Opcional. Filtros opcionais a serem aplicados à métrica.

BaseMetric

Especifica a métrica de base a ser consultada, que pode ser uma métrica padrão predefinida ou uma métrica personalizada definida pelo usuário (se compatível no futuro).

Representação JSON 
{

  "standardMetric": enum (StandardMetric)
}
Campos
Campo de união metric. A métrica específica a ser consultada. metric pode ser apenas de um dos tipos a seguir:
standardMetric

enum (StandardMetric)

Uma métrica padrão predefinida.

StandardMetric

Enumera as métricas padrão predefinidas que podem ser consultadas.

Tipos enumerados
STANDARD_METRIC_UNSPECIFIED Métrica padrão não especificada. Esse valor não deve ser usado diretamente.
FEEDBACK_LOOP_ID

Métrica predefinida para o ID do Feedback Loop (FBL). O campo filter permite selecionar o tipo de chave de agregação. Formato compatível: aggregation_key_type = "".

Valores compatíveis:

  • FROM_HEADER: (padrão) a métrica inclui mensagens com o domínio do cabeçalho "De:" correspondente ao domínio solicitado.
  • ALL_DKIM: a métrica inclui mensagens com um dos domínios DKIM assinados correspondentes ao domínio solicitado.
FEEDBACK_LOOP_SPAM_RATE

Métrica predefinida para a taxa de spam do Feedback Loop (FBL). O campo filter exige um feedback_loop_id e, opcionalmente, aceita um aggregation_key_type. Os formatos compatíveis são estes:

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

Se aggregation_key_type for omitido, o padrão será FROM_HEADER.

Valores compatíveis:

  • FROM_HEADER: (padrão) a métrica inclui mensagens com o domínio do cabeçalho "De:" correspondente ao domínio solicitado.
  • ALL_DKIM: a métrica inclui mensagens com um dos domínios DKIM assinados correspondentes ao domínio solicitado.
SPAM_RATE Métrica predefinida para a taxa de spam.
AUTH_SUCCESS_RATE A taxa de sucesso dos mecanismos de autenticação (DKIM, SPF, DMARC). O filtro precisa ser do tipo auth_type = "", em que é um dos seguintes: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT A taxa de mensagens criptografadas com TLS em trânsito. O filtro precisa ser do tipo traffic_direction = "", em que é um dos seguintes: [inbound, outbound]
TLS_ENCRYPTION_RATE A taxa de mensagens criptografadas com TLS em trânsito. O filtro precisa ser do tipo traffic_direction = "", em que é um dos seguintes: [inbound, outbound]
DELIVERY_ERROR_COUNT

A contagem total de erros de entrega encontrados (rejeições temporárias ou permanentes). O campo filter oferece suporte a uma sintaxe limitada. Os formatos compatíveis são estes:

  • Vazio: nenhum filtro é aplicado.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Se um filtro vazio for fornecido, a métrica será agregada em todos os tipos e motivos de erro. Se apenas error_type for especificado, a métrica será agregada em todos os motivos desse tipo.

Valores compatíveis:

  • rejeitar
  • temp_fail

Os valores compatíveis dependem do :

  • Para "rejeitar": [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

Taxa de erro de entrega para o tipo de erro de entrega especificado. O campo filter oferece suporte a uma sintaxe limitada. Os formatos compatíveis são estes:

  • Vazio: nenhum filtro é aplicado.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Se um filtro vazio for fornecido, a métrica será agregada em todos os tipos e motivos de erro. Se apenas error_type for especificado, a métrica será agregada em todos os motivos desse tipo.

Valores compatíveis:

  • rejeitar
  • temp_fail

Os valores compatíveis dependem do :

  • Para "rejeitar": [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]