MetricDefinition

यह क्वेरी के लिए किसी खास मेट्रिक को तय करता है. इसमें उपयोगकर्ता के तय किए गए नाम, बेस मेट्रिक टाइप, और वैकल्पिक फ़िल्टर शामिल होते हैं.

JSON के काेड में दिखाना
{
  "name": string,
  "baseMetric": {
    object (BaseMetric)
  },
  "filter": string
}
फ़ील्ड
name

string

ज़रूरी है. इस मेट्रिक के लिए, उपयोगकर्ता की ओर से तय किया गया नाम. इस नाम का इस्तेमाल, रिस्पॉन्स में इस मेट्रिक की वैल्यू के लिए कुंजी के तौर पर किया जाएगा.

baseMetric

object (BaseMetric)

ज़रूरी है. क्वेरी के लिए इस्तेमाल की जाने वाली मेट्रिक.

filter

string

ज़रूरी नहीं. मेट्रिक पर लागू करने के लिए वैकल्पिक फ़िल्टर.

BaseMetric

यह क्वेरी करने के लिए, बुनियादी मेट्रिक तय करता है. यह पहले से तय की गई स्टैंडर्ड मेट्रिक या उपयोगकर्ता की ओर से तय की गई कस्टम मेट्रिक हो सकती है. हालांकि, यह सुविधा आने वाले समय में उपलब्ध हो सकती है.

JSON के काेड में दिखाना
{

  "standardMetric": enum (StandardMetric)
}
फ़ील्ड
यूनियन फ़ील्ड metric. क्वेरी करने के लिए मेट्रिक. metric इनमें से सिर्फ़ एक हो सकता है:
standardMetric

enum (StandardMetric)

पहले से तय की गई स्टैंडर्ड मेट्रिक.

StandardMetric

पहले से तय की गई उन स्टैंडर्ड मेट्रिक की सूची बनाता है जिनके लिए क्वेरी की जा सकती है.

Enums
STANDARD_METRIC_UNSPECIFIED स्टैंडर्ड मेट्रिक के बारे में नहीं बताया गया है. इस वैल्यू का सीधे तौर पर इस्तेमाल नहीं किया जाना चाहिए.
FEEDBACK_LOOP_ID फ़ीडबैक लूप (एफ़बीएल) आईडी के लिए पहले से तय की गई मेट्रिक.
FEEDBACK_LOOP_SPAM_RATE फ़ीडबैक लूप (FBL) की स्पैम रेट के लिए पहले से तय की गई मेट्रिक. फ़िल्टर का टाइप feedback_loop_id = "" होना चाहिए. इसमें , फ़ीडबैक लूप का कोई मान्य आईडी है.
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]