REST Resource: properties.calculatedMetrics

रिसॉर्स: CalculatedMetric

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

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

string

सिर्फ़ आउटपुट के लिए. इस CalculatedMetric के लिए संसाधन का नाम. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

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

displayName

string

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

calculatedMetricId

string

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

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

metricUnit

enum (MetricUnit)

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

restrictedMetricType[]

enum (RestrictedMetricType)

सिर्फ़ आउटपुट के लिए. इस मेट्रिक में पाबंदी वाला डेटा किस तरह का है.

formula

string

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

invalidMetricReference

boolean

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

MetricUnit

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

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

RestrictedMetricType

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

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

तरीके

create

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

delete

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

get

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

list

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

patch

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