MetricDefinition

Menentukan metrik tertentu untuk dikueri, termasuk nama yang ditentukan pengguna, jenis metrik dasar, dan filter opsional.

Representasi JSON 
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
Kolom
name

string

Wajib. Nama yang ditentukan pengguna untuk metrik ini. Nama ini akan digunakan sebagai kunci untuk nilai metrik ini dalam respons.
baseMetric

object (BaseMetric)

Wajib. Metrik dasar yang akan dikueri.
filter

string

Opsional. Filter opsional yang akan diterapkan ke metrik.

BaseMetric

Menentukan metrik dasar yang akan dikueri, yang dapat berupa metrik standar yang telah ditentukan atau metrik kustom yang ditentukan pengguna (jika didukung di masa mendatang).

Representasi JSON 
{

  "standardMetric": enum (StandardMetric)
}
Kolom
Kolom union metric. Metrik tertentu yang akan dikueri. metric hanya dapat berupa salah satu dari berikut:
standardMetric

enum (StandardMetric)

Metrik standar yang telah ditentukan.

StandardMetric

Menghitung metrik standar yang telah ditentukan yang dapat dikueri.

Enum
STANDARD_METRIC_UNSPECIFIED Metrik standar yang tidak ditentukan. Nilai ini tidak boleh digunakan secara langsung.
FEEDBACK_LOOP_ID

Metrik yang telah ditentukan untuk ID Feedback Loop (FBL). Kolom filter mendukung pemilihan jenis kunci agregasi. Format yang didukung: aggregation_key_type = "".

Nilai yang didukung:

  • FROM_HEADER: (Default) Metrik ini mencakup pesan dengan domain header Dari: yang cocok dengan domain yang diminta.
  • ALL_DKIM: Metrik ini mencakup pesan dengan salah satu domain DKIM yang ditandatangani yang cocok dengan domain yang diminta.
FEEDBACK_LOOP_SPAM_RATE

Metrik yang telah ditentukan untuk rasio spam Feedback Loop (FBL). Kolom filter memerlukan feedback_loop_id dan secara opsional menerima aggregation_key_type. Format yang didukung adalah:

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

Jika aggregation_key_type dihilangkan, nilai defaultnya adalah FROM_HEADER.

Nilai yang didukung:

  • FROM_HEADER: (Default) Metrik ini mencakup pesan dengan domain header Dari: yang cocok dengan domain yang diminta.
  • ALL_DKIM: Metrik ini mencakup pesan dengan salah satu domain DKIM yang ditandatangani yang cocok dengan domain yang diminta.
SPAM_RATE Metrik yang telah ditentukan untuk rasio spam.
AUTH_SUCCESS_RATE Rasio keberhasilan mekanisme autentikasi (DKIM, SPF, DMARC). Filter harus berjenis auth_type = "" dengan adalah salah satu dari: [spf, dkim, dmarc]
TLS_ENCRYPTION_MESSAGE_COUNT Rasio pesan yang dienkripsi TLS saat transit Filter harus berjenis traffic_direction = "" dengan adalah salah satu dari: [inbound, outbound]
TLS_ENCRYPTION_RATE Rasio pesan yang dienkripsi TLS saat transit Filter harus berjenis traffic_direction = "" dengan adalah salah satu dari: [inbound, outbound]
DELIVERY_ERROR_COUNT

Jumlah total error pengiriman yang terjadi (penolakan sementara atau permanen). Kolom filter mendukung sintaksis terbatas. Format yang didukung adalah:

  • Kosong: Tidak ada filter yang diterapkan.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Jika filter kosong diberikan, metrik akan diagregasi di semua jenis dan alasan error. Jika hanya error_type yang ditentukan, metrik akan diagregasi di semua alasan untuk jenis tersebut.

Nilai yang didukung:

  • tolak
  • temp_fail

Nilai yang didukung bergantung pada :

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

Rasio error pengiriman untuk jenis error pengiriman yang ditentukan. Kolom filter mendukung sintaksis terbatas. Format yang didukung adalah:

  • Kosong: Tidak ada filter yang diterapkan.
  • error_type = ""
  • error_type = "" AND error_reason = ""

Jika filter kosong diberikan, metrik akan diagregasi di semua jenis dan alasan error. Jika hanya error_type yang ditentukan, metrik akan diagregasi di semua alasan untuk jenis tersebut.

Nilai yang didukung:

  • tolak
  • temp_fail

Nilai yang didukung bergantung pada :

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