MetricDefinition

Definisce una metrica specifica da interrogare, inclusi un nome definito dall'utente, il tipo di metrica di base e filtri facoltativi.

Rappresentazione JSON
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Campi
name

string

Obbligatorio. Il nome definito dall'utente per questa metrica. Questo nome verrà utilizzato come chiave per il valore di questa metrica nella risposta.

baseMetric

object (BaseMetric)

Obbligatorio. La metrica sottostante da interrogare.

filter

string

Facoltativo. Filtri facoltativi da applicare alla metrica.

BaseMetric

Specifica la metrica di base da interrogare, che può essere una metrica standard predefinita o una metrica personalizzata definita dall'utente (se supportata in futuro).

Rappresentazione JSON
{

  "standardMetric": enum (StandardMetric)
}
Campi
Campo unione metric. La metrica specifica da interrogare. metric può essere solo uno dei seguenti tipi:
standardMetric

enum (StandardMetric)

Una metrica standard predefinita.

StandardMetric

Enumera le metriche standard predefinite che possono essere interrogate.

Enum
STANDARD_METRIC_UNSPECIFIED Metrica standard non specificata. Questo valore non deve essere utilizzato direttamente.
FEEDBACK_LOOP_ID

Metrica predefinita per l'ID Feedback Loop (FBL). Il campo filter supporta la selezione del tipo di chiave di aggregazione. Formato supportato: aggregation_key_type = "".

Valori supportati:

  • FROM_HEADER: (valore predefinito) la metrica include i messaggi con il dominio dell'intestazione From: corrispondente al dominio richiesto.
  • ALL_DKIM: la metrica include i messaggi con uno dei domini DKIM firmati corrispondenti al dominio richiesto.
FEEDBACK_LOOP_SPAM_RATE

Metrica predefinita per il tasso di spam di Feedback Loop (FBL). Il campo filter richiede un feedback_loop_id e accetta facoltativamente un aggregation_key_type. I formati supportati sono:

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

Se aggregation_key_type viene omesso, il valore predefinito è FROM_HEADER.

Valori supportati:

  • FROM_HEADER: (valore predefinito) la metrica include i messaggi con il dominio dell'intestazione From: corrispondente al dominio richiesto.
  • ALL_DKIM: la metrica include i messaggi con uno dei domini DKIM firmati corrispondenti al dominio richiesto.
SPAM_RATE Metrica predefinita per il tasso di spam.
AUTH_SUCCESS_RATE Il tasso di successo dei meccanismi di autenticazione (DKIM, SPF, DMARC). Il filtro deve essere di tipo auth_type = "" dove è uno dei seguenti: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT La percentuale di messaggi criptati con TLS in transito. Il filtro deve essere di tipo traffic_direction = "" dove è uno dei seguenti: [inbound, outbound]
TLS_ENCRYPTION_RATE La percentuale di messaggi criptati con TLS in transito. Il filtro deve essere di tipo traffic_direction = "" dove è uno dei seguenti: [inbound, outbound]
DELIVERY_ERROR_COUNT

Il conteggio totale degli errori di recapito riscontrati (rifiuti temporanei o permanenti). Il campo filter supporta una sintassi limitata. I formati supportati sono:

  • Vuoto: non viene applicato alcun filtro.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Se viene fornito un filtro vuoto, la metrica verrà aggregata in base a tutti i tipi e i motivi di errore. Se viene specificato solo error_type, la metrica verrà aggregata in base a tutti i motivi per quel tipo.

Valori supportati:

  • rifiuta
  • temp_fail

I valori supportati dipendono da :

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

Tasso di errori di recapito per il tipo di errore di recapito specificato. Il campo filter supporta una sintassi limitata. I formati supportati sono:

  • Vuoto: non viene applicato alcun filtro.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Se viene fornito un filtro vuoto, la metrica verrà aggregata in base a tutti i tipi e i motivi di errore. Se viene specificato solo error_type, la metrica verrà aggregata in base a tutti i motivi per quel tipo.

Valori supportati:

  • rifiuta
  • temp_fail

I valori supportati dipendono da :

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