MetricDefinition

Definiert einen bestimmten Messwert für die Abfrage, einschließlich eines benutzerdefinierten Namens, des zugrunde liegenden Messwerttyps 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 als Schlüssel für den Wert dieses Messwerts in der Antwort verwendet.

baseMetric

object (BaseMetric)

Erforderlich. Der zugrunde liegende Messwert, der abgefragt werden soll.

filter

string

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

BaseMetric

Gibt den abzufragenden Basismesswert an. Das kann ein vordefinierter Standardmesswert oder ein benutzerdefinierter Messwert sein (sofern in Zukunft unterstützt).

JSON-Darstellung
{

  "standardMetric": enum (StandardMetric)
}
Felder
Union-Feld metric. Der spezifische Messwert, der abgefragt werden soll. 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-ID). Im Feld filter kann der Aggregationsschlüsseltyp ausgewählt werden. 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 Spamrate des Feedback Loop (FBL). Für das Feld filter ist ein 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 weggelassen wird, 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 von 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 Der Filter für die Rate der Nachrichten, die während der Übertragung TLS-verschlüsselt wurden, muss vom Typ traffic_direction = "" sein, wobei einer der folgenden Werte ist: [inbound, outbound].
TLS_ENCRYPTION_RATE Der Filter für die Rate der Nachrichten, die während der Übertragung TLS-verschlüsselt wurden, muss vom Typ traffic_direction = "" sein, wobei einer der folgenden Werte ist: [inbound, outbound].
DELIVERY_ERROR_COUNT

Die Gesamtzahl der aufgetretenen Zustellungsfehler (vorübergehende oder dauerhafte Ablehnungen). Das Feld filter unterstützt eine begrenzte 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 zusammengefasst. Wenn nur error_type angegeben ist, wird der Messwert für alle Gründe dieses Typs aggregiert.

Unterstützte -Werte:

  • ablehnen
  • temp_fail

Die unterstützten -Werte hängen von der ab:

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

Zustellungsfehlerrate für den angegebenen Zustellungsfehlertyp. Das Feld filter unterstützt eine begrenzte 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 zusammengefasst. Wenn nur error_type angegeben ist, wird der Messwert für alle Gründe dieses Typs aggregiert.

Unterstützte -Werte:

  • ablehnen
  • temp_fail

Die unterstützten -Werte hängen von der ab:

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