MetricDefinition

Xác định một chỉ số cụ thể để truy vấn, bao gồm tên do người dùng xác định, loại chỉ số cơ bản và các bộ lọc không bắt buộc.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Trường
name

string

Bắt buộc. Tên do người dùng xác định cho chỉ số này. Tên này sẽ được dùng làm khoá cho giá trị của chỉ số này trong phản hồi.
baseMetric

object (BaseMetric)

Bắt buộc. Chỉ số cơ bản để truy vấn.
filter

string

Không bắt buộc. Bộ lọc không bắt buộc để áp dụng cho chỉ số.

BaseMetric

Chỉ định chỉ số cơ sở để truy vấn. Đây có thể là chỉ số tiêu chuẩn được xác định trước hoặc chỉ số tuỳ chỉnh do người dùng xác định (nếu được hỗ trợ trong tương lai).

Biểu diễn dưới dạng JSON 
{

  "standardMetric": enum (StandardMetric)
}
Trường
Trường nhóm metric. Chỉ số cụ thể để truy vấn. metric chỉ có thể là một trong những trạng thái sau:
standardMetric

enum (StandardMetric)

Một chỉ số tiêu chuẩn được xác định trước.

StandardMetric

Liệt kê các chỉ số tiêu chuẩn được xác định trước mà bạn có thể truy vấn.

Enum
STANDARD_METRIC_UNSPECIFIED Chỉ số chuẩn không được chỉ định. Bạn không nên sử dụng trực tiếp giá trị này.
FEEDBACK_LOOP_ID

Chỉ số được xác định trước cho mã Vòng hồi tiếp (FBL). Trường filter hỗ trợ việc chọn loại khoá tổng hợp. Định dạng được hỗ trợ: aggregation_key_type = "".

Các giá trị được hỗ trợ:

  • FROM_HEADER: (Mặc định) Chỉ số này bao gồm những thư có miền trong phần đầu thư Từ: khớp với miền được yêu cầu.
  • ALL_DKIM: Chỉ số này bao gồm những thư có một trong các miền DKIM đã ký khớp với miền được yêu cầu.
FEEDBACK_LOOP_SPAM_RATE

Chỉ số được xác định trước cho tỷ lệ thư rác của Vòng hồi tiếp (FBL). Trường filter yêu cầu feedback_loop_id và có thể chấp nhận aggregation_key_type (không bắt buộc). Các định dạng được hỗ trợ là:

  • feedback_loop_id = ""
  • feedback_loop_id = "" VÀ aggregation_key_type = ""

Nếu bạn bỏ qua aggregation_key_type, giá trị mặc định sẽ là FROM_HEADER.

Các giá trị được hỗ trợ:

  • FROM_HEADER: (Mặc định) Chỉ số này bao gồm những thư có miền trong phần đầu thư Từ: khớp với miền được yêu cầu.
  • ALL_DKIM: Chỉ số này bao gồm những thư có một trong các miền DKIM đã ký khớp với miền được yêu cầu.
SPAM_RATE Chỉ số được xác định trước cho tỷ lệ thư rác.
AUTH_SUCCESS_RATE Tỷ lệ thành công của các cơ chế xác thực (DKIM, SPF, DMARC). Bộ lọc phải thuộc loại auth_type = "" trong đó là một trong các loại: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT Bộ lọc tỷ lệ tin nhắn được mã hoá bằng TLS khi truyền phải thuộc loại traffic_direction = "" trong đó là một trong các giá trị: [inbound, outbound]
TLS_ENCRYPTION_RATE Bộ lọc tỷ lệ tin nhắn được mã hoá bằng TLS khi truyền phải thuộc loại traffic_direction = "" trong đó là một trong các giá trị: [inbound, outbound]
DELIVERY_ERROR_COUNT

Tổng số lỗi khi gửi thư gặp phải (từ chối tạm thời hoặc vĩnh viễn). Trường filter chỉ hỗ trợ một cú pháp hạn chế. Các định dạng được hỗ trợ là:

  • Trống: Không áp dụng bộ lọc nào.
  • error_type = ""
  • error_type = "" VÀ error_reason = ""

Nếu bạn cung cấp một bộ lọc trống, chỉ số này sẽ được tổng hợp trên tất cả các loại và lý do gây ra lỗi. Nếu bạn chỉ chỉ định error_type, thì chỉ số sẽ được tổng hợp trên tất cả các lý do cho loại đó.

Các giá trị được hỗ trợ:

  • từ chối
  • temp_fail

Các giá trị được hỗ trợ phụ thuộc vào :

  • Đối với "từ chối": [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Đối với "temp_fail": [anomalous_traffic_pattern, other]
DELIVERY_ERROR_RATE

Tỷ lệ lỗi khi gửi thư cho loại lỗi khi gửi thư được chỉ định. Trường filter chỉ hỗ trợ một cú pháp hạn chế. Các định dạng được hỗ trợ là:

  • Trống: Không áp dụng bộ lọc nào.
  • error_type = ""
  • error_type = "" VÀ error_reason = ""

Nếu bạn cung cấp một bộ lọc trống, chỉ số này sẽ được tổng hợp trên tất cả các loại và lý do gây ra lỗi. Nếu bạn chỉ chỉ định error_type, thì chỉ số sẽ được tổng hợp trên tất cả các lý do cho loại đó.

Các giá trị được hỗ trợ:

  • từ chối
  • temp_fail

Các giá trị được hỗ trợ phụ thuộc vào :

  • Đối với "từ chối": [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
  • Đối với "temp_fail": [anomalous_traffic_pattern, other]