Method: properties.getMetadata

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
name

string

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

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

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

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

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

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

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

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

JSON के काेड में दिखाना 
{
  "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

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

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

string

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

string

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

string

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