REST Resource: properties.calculatedMetrics

संसाधन: कैलकुलेट की गई मेट्रिक

कैलकुलेट की गई मेट्रिक की परिभाषा.

जेएसओएन के काेड में दिखाना
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. इस कैलकुलेट की गई मेट्रिक के लिए संसाधन का नाम. फ़ॉर्मैट: 'properties/{property_id}/कैलकुलेट की गईमेट्रिकs/{selectedMetricId}'

description

string

ज़रूरी नहीं. कैलकुलेट की गई इस मेट्रिक की जानकारी. ज़्यादा से ज़्यादा 4,096 वर्ण इस्तेमाल किए जा सकते हैं.

displayName

string

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

calculatedMetricId

string

सिर्फ़ आउटपुट के लिए. कैलकुलेट की गई मेट्रिक के लिए इस्तेमाल किया जाने वाला आईडी. यूज़र इंटरफ़ेस (यूआई) में, इसे "एपीआई का नाम" कहा जाता है.

कैलकुलेट की गई मेट्रिक का इस्तेमाल तब किया जाता है, जब बाहरी एपीआई से कैलकुलेट की गई इस मेट्रिक का रेफ़रंस दिया जाता है. उदाहरण के लिए, "calcMetric:{ खोजेंMetricId}".

metricUnit

enum (MetricUnit)

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

restrictedMetricType[]

enum (RestrictedMetricType)

सिर्फ़ आउटपुट के लिए. इस मेट्रिक में शामिल सीमित डेटा के टाइप.

formula

string

ज़रूरी है. कैलकुलेट की गई मेट्रिक की परिभाषा. रेफ़र की गई यूनीक कस्टम मेट्रिक की ज़्यादा से ज़्यादा संख्या पांच है. फ़ॉर्मूला इन कार्रवाइयों के साथ काम करते हैं: + (जोड़), - (घटाना), - (नेगेटिव), * (गुणा), / (भाग), () (ब्रैकेट). कोई भी मान्य वास्तविक संख्या, लंबे (64 बिट पूर्णांक) या डबल (64 बिट फ़्लोटिंग पॉइंट नंबर) में फ़िट हो सकती है. फ़ॉर्मूला का उदाहरण: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

सिर्फ़ आउटपुट के लिए. अगर सही है, तो कैलकुलेट की गई मेट्रिक की मेट्रिक का रेफ़रंस अमान्य है. अमान्य मेट्रिक रेफ़रंस को 'सही है' पर सेट करने के बाद, कैलकुलेट की गई मेट्रिक का इस्तेमाल करने वाली कोई भी चीज़ फ़ेल हो सकती है, चेतावनी दे सकती है या अनचाहे नतीजे दे सकती है.

MetricUnit

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

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

RestrictedMetricType

वे लेबल जो कैलकुलेट की गई मेट्रिक में, डेटा को मार्क करने के लिए इस्तेमाल किए जाते हैं. साथ ही, इन्हें उपयोगकर्ता की भूमिकाओं के साथ इस्तेमाल किया जाता है. ये लेबल, लागत और/या आय की मेट्रिक के ऐक्सेस को प्रतिबंधित करते हैं.

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

तरीके

create

कैलकुलेट की गई मेट्रिक बनाता है.

delete

यह किसी प्रॉपर्टी से कैलकुलेट की गई मेट्रिक को मिटाता है.

get

किसी एक आकलन की गई मेट्रिक को खोजें.

list

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

patch

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