Method: properties.getMetadata

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
name

string

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

उदाहरण: properties/1234/metadata

सभी प्रॉपर्टी में मौजूद डाइमेंशन और मेट्रिक के लिए, प्रॉपर्टी आईडी को 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 फ़ील्ड में इस्तेमाल किया जा सकता है. उदाहरण के लिए, 'comparisons/1234'.
uiName

string

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

string

इस तुलना के बारे में जानकारी.