MetricDefinition

Определяет конкретную метрику для запроса, включая заданное пользователем имя, базовый тип метрики и необязательные фильтры.

JSON-представление 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Поля
name

string

Обязательно. Пользовательское имя для этой метрики. Это имя будет использоваться в качестве ключа для значения этой метрики в ответе.

baseMetric

object ( BaseMetric )

Обязательно. Базовый показатель для запроса.

filter

string

Необязательно. Дополнительные фильтры для применения к метрике.

Базовая метрика

Указывает базовую метрику для запроса, которая может быть предопределенной стандартной метрикой или пользовательской метрикой (если это будет поддерживаться в будущем).

JSON-представление 
{

  "standardMetric": enum (StandardMetric)
}
Поля
metric поля объединения. Конкретная метрика для запроса. metric может быть только одной из следующих:
standardMetric

enum ( StandardMetric )

Заранее определенная стандартная метрика.

Стандартметр

Перечисляет предопределенные стандартные метрики, к которым можно обращаться с запросами.

Перечисления
STANDARD_METRIC_UNSPECIFIED Неуказанный стандартный показатель. Это значение не следует использовать напрямую.
FEEDBACK_LOOP_ID

Предопределенная метрика для идентификатора петли обратной связи (FBL). Поле filter позволяет выбрать тип ключа агрегации. Поддерживаемый формат: aggregation_key_type = " «.

Поддерживается ценности:

  • FROM_HEADER : (По умолчанию) Метрика включает сообщения с доменом заголовка From:, соответствующим запрошенному домену.
  • ALL_DKIM : Метрика включает сообщения, в которых один из подписанных доменов DKIM соответствует запрошенному домену.
FEEDBACK_LOOP_SPAM_RATE

Предопределенная метрика для оценки уровня спама в цикле обратной связи (FBL). Поле filter требует указания feedback_loop_id и может дополнительно принимать aggregation_key_type . Поддерживаемые форматы:

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

Если aggregation_key_type опущен, по умолчанию используется значение FROM_HEADER .

Поддерживается ценности:

  • FROM_HEADER : (По умолчанию) Метрика включает сообщения с доменом заголовка From:, соответствующим запрошенному домену.
  • ALL_DKIM : Метрика включает сообщения, в которых один из подписанных доменов DKIM соответствует запрошенному домену.
SPAM_RATE Заранее заданная метрика для оценки уровня спама.
AUTH_SUCCESS_RATE Показатель успешности механизмов аутентификации (DKIM, SPF, DMARC). Фильтр должен иметь тип auth_type = " " где является одним из следующих: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT Фильтр должен иметь тип traffic_direction = " " где является одним из: [входящий, исходящий]
TLS_ENCRYPTION_RATE Фильтр должен иметь тип traffic_direction = " " где является одним из: [входящий, исходящий]
DELIVERY_ERROR_COUNT

Общее количество обнаруженных ошибок доставки (временные или постоянные отказы). Поле filter поддерживает ограниченный синтаксис. Поддерживаемые форматы:

  • Пусто: Фильтр не применен.
  • error_type = " "
  • error_type = " " AND error_reason = " "

Если указан пустой фильтр, метрика будет агрегирована по всем типам ошибок и причинам. Если указан только error_type , метрика будет агрегирована по всем причинам для этого типа.

Поддерживается ценности:

  • отклонять
  • temp_fail

Поддерживается значения зависят от :

  • Для 'reject': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Для 'temp_fail': [anomalous_traffic_pattern, other]
DELIVERY_ERROR_RATE

Показатель частоты ошибок доставки для указанного типа ошибок доставки. Поле filter поддерживает ограниченный синтаксис. Поддерживаемые форматы:

  • Пусто: Фильтр не применен.
  • error_type = " "
  • error_type = " " AND error_reason = " "

Если указан пустой фильтр, метрика будет агрегирована по всем типам ошибок и причинам. Если указан только error_type , метрика будет агрегирована по всем причинам для этого типа.

Поддерживается ценности:

  • отклонять
  • temp_fail

Поддерживается значения зависят от :

  • Для 'reject': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Для 'temp_fail': [anomalous_traffic_pattern, other]