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

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