REST Resource: properties.customMetrics

संसाधन: कस्टममेट्रिक

कस्टम मेट्रिक की परिभाषा.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. इस कस्टममेट्रिक संसाधन के लिए संसाधन का नाम. फ़ॉर्मैट: प्रॉपर्टीज़/{property}/customMetrics/{customMetrics}
parameterName

string

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

अगर यह इवेंट के स्कोप वाली मेट्रिक है, तो यह इवेंट पैरामीटर का नाम होगा.

अक्षर से शुरू होने वाले, सिर्फ़ अक्षर और अंक मिलाकर, अंडरस्कोर वाले वर्ण शामिल हो सकते हैं. इवेंट के स्कोप वाली मेट्रिक के लिए, ज़्यादा से ज़्यादा 40 वर्ण इस्तेमाल किए जा सकते हैं.
displayName

string

ज़रूरी है. इस कस्टम मेट्रिक का डिसप्ले नेम, जैसा कि Analytics यूज़र इंटरफ़ेस (यूआई) में दिखाया गया है. ज़्यादा से ज़्यादा 82 वर्ण, अक्षर से शुरू होने वाले अक्षर, और स्पेस, और अंडरस्कोर. सिस्टम से जनरेट किए गए लेगसी डिसप्ले नेम में स्क्वेयर ब्रैकेट हो सकते हैं. हालांकि, इस फ़ील्ड में अपडेट करने पर, कभी भी स्क्वेयर ब्रैकेट की अनुमति नहीं मिलेगी.
description

string

ज़रूरी नहीं. इस कस्टम डाइमेंशन की जानकारी. ज़्यादा से ज़्यादा 150 वर्ण.
measurementUnit

enum (MeasurementUnit)

ज़रूरी है. कस्टम मेट्रिक की वैल्यू का टाइप.
scope

enum (MetricScope)

ज़रूरी है. इम्यूटेबल. इस कस्टम मेट्रिक का स्कोप.
restrictedMetricType[]

enum (RestrictedMetricType)

ज़रूरी नहीं. इस मेट्रिक में शामिल सीमित डेटा के टाइप. CURRENCY मेज़रमेंट यूनिट वाली मेट्रिक के लिए ज़रूरी है. गैर-CURRENCY माप इकाई वाली मेट्रिक के लिए खाली होना चाहिए.

MeasurementUnit

कस्टम मेट्रिक की वैल्यू दिखाने के संभावित टाइप.

आने वाले समय में, मुद्रा में बदलाव हो सकता है. इस वजह से, एपीआई में डेटा में बदलाव की ज़रूरत होगी.

Enums
MEASUREMENT_UNIT_UNSPECIFIED मेज़रमेंट यूनिट की जानकारी नहीं है या मौजूद नहीं है.
STANDARD इस मेट्रिक में, डिफ़ॉल्ट यूनिट का इस्तेमाल किया जाता है.
CURRENCY यह मेट्रिक किसी मुद्रा को मेज़र करती है.
FEET यह मेट्रिक, फ़ीट मापती है.
METERS यह मेट्रिक मीटर को मापती है.
KILOMETERS यह मेट्रिक किलोमीटर को मापती है.
MILES यह मेट्रिक मील मापती है.
MILLISECONDS इस मेट्रिक का इस्तेमाल, मिलीसेकंड में किया जाता है.
SECONDS इस मेट्रिक की मदद से, सेकंड का आकलन किया जाता है.
MINUTES यह मेट्रिक मिनट मापती है.
HOURS इस मेट्रिक से कारोबार के खुले होने के समय का पता चलता है.

MetricScope

इस मेट्रिक का स्कोप.

Enums
METRIC_SCOPE_UNSPECIFIED दायरा अज्ञात है या तय नहीं किया गया है.
EVENT किसी इवेंट के दायरे में आने वाली मेट्रिक.

RestrictedMetricType

इस कस्टम मेट्रिक के डेटा को ऐसे डेटा के तौर पर मार्क करने वाले लेबल जिसे चुनिंदा उपयोगकर्ताओं तक ही सीमित किया जाना चाहिए.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED टाइप की जानकारी नहीं है या जानकारी नहीं दी गई है.
COST_DATA मेट्रिक, लागत डेटा को रिपोर्ट करती है.
REVENUE_DATA मेट्रिक, रेवेन्यू का डेटा रिपोर्ट करती है.

तरीके

archive

 किसी प्रॉपर्टी का कस्टममेट्रिक संग्रहित करता है.

create

 कस्टममेट्रिक बनाता है.

get

 एक कस्टममेट्रिक खोजें.

list

 यह किसी प्रॉपर्टी पर कस्टममेट्रिक्स की सूची बनाता है.

patch

 किसी प्रॉपर्टी की कस्टममेट्रिक अपडेट करता है.