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

सिर्फ़ आउटपुट के लिए. इस कस्टम मेट्रिक रिसॉर्स का नाम. फ़ॉर्मैट: 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

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

create

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

get

 किसी एक कस्टम मेट्रिक के लिए लुकअप.

list

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

patch

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