MetricDefinition

Definiert einen bestimmten Messwert für die Abfrage, einschließlich eines benutzerdefinierten Namens, des Basismesswerttyps und optionaler Filter.

JSON-Darstellung 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Felder
name

string

Erforderlich. Der benutzerdefinierte Name für diesen Messwert. Dieser Name wird in der Antwort als Schlüssel für den Wert dieses Messwerts verwendet.
baseMetric

object (BaseMetric)

Erforderlich. Der zugrunde liegende Messwert für die Abfrage.
filter

string

Optional. Optionale Filter, die auf den Messwert angewendet werden sollen.

BaseMetric

Gibt den Basismesswert für die Abfrage an. Dabei kann es sich um einen vordefinierten Standardmesswert oder einen benutzerdefinierten Messwert handeln (falls in Zukunft unterstützt).

JSON-Darstellung 
{

  "standardMetric": enum (StandardMetric)
}
Felder
Union-Feld metric. Der spezifische Messwert für die Abfrage. Für metric ist nur einer der folgenden Werte zulässig:
standardMetric

enum (StandardMetric)

Ein vordefinierter Standardmesswert.

StandardMetric

Listet die vordefinierten Standardmesswerte auf, die abgefragt werden können.

Enums
STANDARD_METRIC_UNSPECIFIED Nicht angegebener Standardmesswert. Dieser Wert sollte nicht direkt verwendet werden.
FEEDBACK_LOOP_ID

Vordefinierter Messwert für die Feedback Loop-ID (FBL). Das Feld filter unterstützt die Auswahl des Aggregationsschlüsseltyps. Unterstütztes Format: aggregation_key_type = "".

Unterstützte Werte:

  • FROM_HEADER: (Standard) Der Messwert umfasst Nachrichten, deren „From:“-Header-Domain mit der angeforderten Domain übereinstimmt.
  • ALL_DKIM: Der Messwert umfasst Nachrichten, bei denen eine der signierten DKIM-Domains mit der angeforderten Domain übereinstimmt.
FEEDBACK_LOOP_SPAM_RATE

Vordefinierter Messwert für die Feedback Loop-Spamrate (FBL). Für das Feld filter ist eine feedback_loop_id erforderlich und optional kann ein aggregation_key_type angegeben werden. Unterstützte Formate sind:

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

Wenn aggregation_key_type nicht angegeben ist, wird standardmäßig FROM_HEADER verwendet.

Unterstützte Werte:

  • FROM_HEADER: (Standard) Der Messwert umfasst Nachrichten, deren „From:“-Header-Domain mit der angeforderten Domain übereinstimmt.
  • ALL_DKIM: Der Messwert umfasst Nachrichten, bei denen eine der signierten DKIM-Domains mit der angeforderten Domain übereinstimmt.
SPAM_RATE Vordefinierter Messwert für die Spamrate.
AUTH_SUCCESS_RATE Die Erfolgsrate der Authentifizierungsmechanismen (DKIM, SPF, DMARC). Der Filter muss vom Typ „auth_type = ""“ sein, wobei einer der folgenden Werte ist: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT Die Rate der Nachrichten, die bei der Übertragung mit TLS verschlüsselt wurden. Der Filter muss vom Typ „traffic_direction = „““ sein, wobei einer der folgenden Werte ist: [inbound, outbound]
TLS_ENCRYPTION_RATE Die Rate der Nachrichten, die bei der Übertragung mit TLS verschlüsselt wurden. Der Filter muss vom Typ „traffic_direction = „““ sein, wobei einer der folgenden Werte ist: [inbound, outbound]
DELIVERY_ERROR_COUNT

Die Gesamtzahl der Zustellungsfehler (vorübergehende oder dauerhafte Ablehnungen). Das Feld filter unterstützt eine eingeschränkte Syntax. Unterstützte Formate sind:

  • Leer: Ohne Filter.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Wenn ein leerer Filter angegeben wird, wird der Messwert für alle Fehlertypen und ‑gründe aggregiert. Wenn nur error_type angegeben ist, wird der Messwert für alle Gründe für diesen Typ aggregiert.

Unterstützte Werte:

  • ablehnen
  • temp_fail

Die unterstützten Werte hängen vom ab:

  • Für „ablehnen“: [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Für „temp_fail“: [anomalous_traffic_pattern, other]
DELIVERY_ERROR_RATE

Zustellungsfehlerrate für den angegebenen Zustellungsfehlertyp. Das Feld filter unterstützt eine eingeschränkte Syntax. Unterstützte Formate sind:

  • Leer: Ohne Filter.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Wenn ein leerer Filter angegeben wird, wird der Messwert für alle Fehlertypen und ‑gründe aggregiert. Wenn nur error_type angegeben ist, wird der Messwert für alle Gründe für diesen Typ aggregiert.

Unterstützte Werte:

  • ablehnen
  • temp_fail

Die unterstützten Werte hängen vom ab:

  • Für „ablehnen“: [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Für „temp_fail“: [anomalous_traffic_pattern, other]