Method: properties.getMetadata

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

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

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

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

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

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

पैरामीटर
name

string

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

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

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

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

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

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

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

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

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

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

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

object (ComparisonMetadata)

तुलना के ब्यौरे.

अनुमति के दायरे

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

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

ComparisonMetadata

एक तुलना के लिए मेटाडेटा.

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

string

इस तुलना के संसाधन का नाम. Comparison के comparison फ़ील्ड में इस्तेमाल किया जा सकता है. उदाहरण के लिए, 'Compares/1234'.
uiName

string

Google Analytics के यूज़र इंटरफ़ेस में इस तुलना का नाम.
description

string

इस तुलना का ब्यौरा.