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

आइडेंटिफ़ायर. कैलकुलेट की गई इस मेट्रिक का रिसॉर्स नेम. फ़ॉर्मैट: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

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

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

कैलकुलेट की गई किसी एक मेट्रिक को ढूंढता है.

list

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

patch

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