REST Resource: properties.customMetrics

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

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

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

string

सिर्फ़ आउटपुट के लिए. इस कस्टम मेट्रिक संसाधन के लिए संसाधन का नाम. फ़ॉर्मैट: प्रॉपर्टी/{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 मेज़रमेंट यूनिट की जानकारी नहीं दी गई है या मौजूद नहीं है.
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

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