Method: properties.getMetadata

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
name

string

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

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

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

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

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

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

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

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

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

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

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

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

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

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