MetricDefinition

Définit une métrique spécifique à interroger, y compris un nom défini par l'utilisateur, le type de métrique de base et des filtres facultatifs.

Représentation JSON 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Champs
name

string

Obligatoire. Nom défini par l'utilisateur pour cette métrique. Ce nom sera utilisé comme clé pour la valeur de cette métrique dans la réponse.
baseMetric

object (BaseMetric)

Obligatoire. Métrique sous-jacente à interroger.
filter

string

Facultatif. Filtres facultatifs à appliquer à la métrique.

BaseMetric

Spécifie la métrique de base à interroger, qui peut être une métrique standard prédéfinie ou une métrique personnalisée définie par l'utilisateur (si elle est compatible à l'avenir).

Représentation JSON 
{

  "standardMetric": enum (StandardMetric)
}
Champs
Champ d'union metric. Métrique spécifique à interroger. metric ne peut être qu'un des éléments suivants :
standardMetric

enum (StandardMetric)

Métrique standard prédéfinie.

StandardMetric

Énumère les métriques standards prédéfinies qui peuvent être interrogées.

Enums
STANDARD_METRIC_UNSPECIFIED Métrique standard non spécifiée. Cette valeur ne doit pas être utilisée directement.
FEEDBACK_LOOP_ID

Métrique prédéfinie pour l'ID de la boucle de rétroaction (FBL). Le champ filter permet de sélectionner le type de clé d'agrégation. Format compatible : aggregation_key_type = "".

Valeurs compatibles :

  • FROM_HEADER : (par défaut) la métrique inclut les messages dont le domaine d'en-tête "From:" correspond au domaine demandé.
  • ALL_DKIM : la métrique inclut les messages dont l'un des domaines DKIM signés correspond au domaine demandé.
FEEDBACK_LOOP_SPAM_RATE

Métrique prédéfinie pour le taux de spam de la boucle de rétroaction (FBL). Le champ filter nécessite un feedback_loop_id et accepte éventuellement un aggregation_key_type. Formats compatibles :

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

Si aggregation_key_type est omis, la valeur par défaut est FROM_HEADER.

Valeurs compatibles :

  • FROM_HEADER : (par défaut) la métrique inclut les messages dont le domaine d'en-tête "From:" correspond au domaine demandé.
  • ALL_DKIM : la métrique inclut les messages dont l'un des domaines DKIM signés correspond au domaine demandé.
SPAM_RATE Métrique prédéfinie pour le taux de spam.
AUTH_SUCCESS_RATE Taux de réussite des mécanismes d'authentification (DKIM, SPF, DMARC). Le filtre doit être de type auth_type = "", où est l'un des éléments suivants : [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT Taux de messages chiffrés avec TLS en transit. Le filtre doit être de type traffic_direction = "", où est l'un des éléments suivants : [inbound, outbound]
TLS_ENCRYPTION_RATE Taux de messages chiffrés avec TLS en transit. Le filtre doit être de type traffic_direction = "", où est l'un des éléments suivants : [inbound, outbound]
DELIVERY_ERROR_COUNT

Nombre total d'erreurs de remise rencontrées (rejets temporaires ou permanents). Le champ filter est compatible avec une syntaxe limitée. Formats compatibles :

  • Vide : aucun filtre n'est appliqué.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Si un filtre vide est fourni, la métrique est agrégée sur tous les types et motifs d'erreur. Si seul error_type est spécifié, la métrique est agrégée sur tous les motifs de ce type.

Valeurs compatibles :

  • reject
  • temp_fail

Les valeurs compatibles dépendent du :

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

Taux d'erreurs de remise pour le type d'erreur de remise spécifié. Le champ filter est compatible avec une syntaxe limitée. Formats compatibles :

  • Vide : aucun filtre n'est appliqué.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Si un filtre vide est fourni, la métrique est agrégée sur tous les types et motifs d'erreur. Si seul error_type est spécifié, la métrique est agrégée sur tous les motifs de ce type.

Valeurs compatibles :

  • reject
  • temp_fail

Les valeurs compatibles dépendent du :

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