Method: properties.getMetadata

यह फ़ंक्शन, रिपोर्टिंग के तरीकों में मौजूद डाइमेंशन और मेट्रिक का मेटाडेटा दिखाता है. इस डेटा का इस्तेमाल, डाइमेंशन और मेट्रिक के बारे में जानने के लिए किया जाता है. इस तरीके में, अनुरोध में Google Analytics GA4 प्रॉपर्टी आइडेंटिफ़ायर की जानकारी दी जाती है. साथ ही, मेटाडेटा के रिस्पॉन्स में कस्टम डाइमेंशन और मेट्रिक के साथ-साथ Universal मेटाडेटा भी शामिल होता है.

उदाहरण के लिए, levels_unlocked पैरामीटर नाम वाली कस्टम मेट्रिक अगर किसी प्रॉपर्टी में रजिस्टर है, तो मेटाडेटा के रिस्पॉन्स में customEvent:levels_unlocked शामिल होगा. यूनिवर्सल मेटाडेटा, country और totalUsers जैसी किसी भी प्रॉपर्टी पर लागू होने वाले डाइमेंशन और मेट्रिक होते हैं.

एचटीटीपी अनुरोध

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
name

string

ज़रूरी है. फिर से हासिल किए जाने वाले मेटाडेटा का संसाधन नाम. नाम वाले इस फ़ील्ड की जानकारी यूआरएल पाथ में दी जाती है, न कि यूआरएल पैरामीटर में. प्रॉपर्टी, अंकों वाली Google Analytics GA4 प्रॉपर्टी आइडेंटिफ़ायर है. ज़्यादा जानने के लिए, देखें कि प्रॉपर्टी आईडी कहां मिलेगा.

उदाहरण: प्रॉपर्टीज़/1234/मेटाडेटा

सभी प्रॉपर्टी में इस्तेमाल होने वाले डाइमेंशन और मेट्रिक के लिए, प्रॉपर्टी आईडी को 0 पर सेट करें. इस खास मोड में यह तरीका, कस्टम डाइमेंशन और मेट्रिक नहीं दिखाएगा.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

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

रिपोर्टिंग के तरीकों में फ़िलहाल स्वीकार किए जाने वाले डाइमेंशन और मेट्रिक.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
फ़ील्ड
name

string

इस मेटाडेटा के संसाधन का नाम.
dimensions[]

object (DimensionMetadata)

डाइमेंशन की जानकारी.
metrics[]

object (MetricMetadata)

मेट्रिक की जानकारी.

अनुमति पाने के लिंक

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

DimensionMetadata

डाइमेंशन के बारे में बताता है.

जेएसओएन के काेड में दिखाना 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
फ़ील्ड
apiName

string

इस डाइमेंशन का नाम. डाइमेंशन की name में इस्तेमाल किया जा सकता है. उदाहरण के लिए, eventName.
uiName

string

Google Analytics के यूज़र इंटरफ़ेस में इस डाइमेंशन का नाम. उदाहरण के लिए, Event name.
description

string

इस डाइमेंशन का इस्तेमाल और हिसाब कैसे किया जाता है, इस बारे में जानकारी.
deprecatedApiNames[]

string

इस डाइमेंशन के लिए अब भी इस्तेमाल किए जा सकते हैं, लेकिन ये नाम काम नहीं करते. अपने-आप जानकारी भरने पर, यह डाइमेंशन apiName या कुछ समय के लिए deprecatedApiNames में से किसी एक के लिए उपलब्ध रहेगा. बंद किए जाने की अवधि के बाद, डाइमेंशन सिर्फ़ apiName तक उपलब्ध होगा.
customDefinition

boolean

अगर डाइमेंशन इस प्रॉपर्टी के लिए कस्टम डाइमेंशन है, तो वैल्यू 'सही' होगी.

MetricMetadata

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

जेएसओएन के काेड में दिखाना 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
फ़ील्ड
apiName

string

मेट्रिक का नाम. मेट्रिक की name में इस्तेमाल की जा सकती है. उदाहरण के लिए, eventCount.
uiName

string

Google Analytics के यूज़र इंटरफ़ेस में इस मेट्रिक का नाम. उदाहरण के लिए, Event count.
description

string

इस मेट्रिक को इस्तेमाल करने और कैलकुलेट करने के तरीके की जानकारी.
deprecatedApiNames[]

string

इस मेट्रिक के लिए अब भी इस्तेमाल किए जा सकते हैं, लेकिन ये नाम काम नहीं करते. अगर अपने-आप जानकारी भरी जाती है, तो यह मेट्रिक कुछ समय के लिए apiName या deprecatedApiNames में से किसी एक के लिए उपलब्ध रहेगी. बंद किए जाने की अवधि के बाद, मेट्रिक सिर्फ़ apiName तक उपलब्ध होगी.
type

enum (MetricType)

यह मेट्रिक किस तरह की है.
expression

string

इस डिराइव्ड मेट्रिक का मैथमैटिकल एक्सप्रेशन. मिलती-जुलती रिपोर्ट के लिए, मेट्रिक के expression फ़ील्ड में इस्तेमाल किया जा सकता है. ज़्यादातर मेट्रिक, एक्सप्रेशन नहीं होती हैं. साथ ही, नॉन-एक्सप्रेशन के लिए यह फ़ील्ड खाली होता है.
customDefinition

boolean

अगर मेट्रिक इस प्रॉपर्टी के लिए एक कस्टम मेट्रिक है, तो वैल्यू 'सही' होगी.