REST Resource: properties.calculatedMetrics

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

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

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

string

सिर्फ़ आउटपुट के लिए. इस परिकलित मेट्रिक के लिए संसाधन का नाम. फ़ॉर्मैट: 'प्रॉपर्टी/{property_id}/calMetrics/{calMetricId}'
description

string

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

string

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

string

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

बाहरी एपीआई से कैलकुलेट की गई इस मेट्रिक का रेफ़रंस देने के लिए, परिकलित मेट्रिकId का इस्तेमाल किया जाता है. उदाहरण के लिए, "calcMetric:{कैलकेटेड मेट्रिकId}".
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

 यह किसी प्रॉपर्टी के लिए आपके दिए गए फ़ॉर्मूले के आधार पर तैयार की गई मेट्रिक को अपडेट करता है.