REST Resource: properties.customMetrics

संसाधन: CustomMetric

कस्टम मेट्रिक की डेफ़िनिशन.

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

string

आइडेंटिफ़ायर. CustomMetric संसाधन के लिए संसाधन का नाम. फ़ॉर्मैट: properties/{property}/customMetrics/{customMetric}
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 MeasurementUnit की वैल्यू नहीं दी गई है या मौजूद नहीं है.
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

 यह किसी प्रॉपर्टी पर मौजूद CustomMetric को संग्रहित करता है.

create

 इसकी मदद से CustomMetric बनाया जाता है.

get

 किसी एक CustomMetric के लिए लुकअप.

list

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

patch

 यह किसी प्रॉपर्टी पर मौजूद CustomMetric को अपडेट करता है.