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. Il peut s'agir d'une métrique standard prédéfinie ou d'une métrique personnalisée définie par l'utilisateur (si elle est prise en charge à 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 pouvant ê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 accepté : aggregation_key_type = "".

Valeurs acceptées :

  • FROM_HEADER : (par défaut) la métrique inclut les messages dont le domaine de l'en-tête "De" 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 par boucle de rétroaction (FBL). Le champ filter nécessite un feedback_loop_id et accepte éventuellement un aggregation_key_type. Les formats compatibles sont les suivants :

  • 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 acceptées :

  • FROM_HEADER : (par défaut) la métrique inclut les messages dont le domaine de l'en-tête "De" 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ù correspond à l'une des valeurs suivantes : [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT Le filtre "Taux de messages chiffrés par TLS en transit" doit être de type traffic_direction = "", où est l'une des valeurs suivantes : [inbound, outbound]
TLS_ENCRYPTION_RATE Le filtre "Taux de messages chiffrés par TLS en transit" doit être de type traffic_direction = "", où est l'une des valeurs suivantes : [inbound, outbound]
DELIVERY_ERROR_COUNT

Nombre total d'erreurs de distribution rencontrées (rejets temporaires ou permanents). Le champ filter est compatible avec une syntaxe limitée. Les formats compatibles sont les suivants :

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

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

Valeurs acceptées :

  • reject
  • temp_fail

Les valeurs acceptées dépendent de  :

  • 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 diffusion pour le type d'erreurs de diffusion spécifié. Le champ filter est compatible avec une syntaxe limitée. Les formats compatibles sont les suivants :

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

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

Valeurs acceptées :

  • reject
  • temp_fail

Les valeurs acceptées dépendent de  :

  • 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]