Method: properties.getMetadata

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
name

string

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

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

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

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

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

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

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
फ़ील्ड
name

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

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

object (ComparisonMetadata)

तुलना करने के लिए दी गई जानकारी.
conversions[]

object (ConversionMetadata)

कन्वर्ज़न की जानकारी.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
फ़ील्ड
apiName

string

इस डाइमेंशन का नाम. डाइमेंशन के name में इस्तेमाल किया जा सकता है. उदाहरण के लिए, eventName.
uiName

string

Google Analytics के यूज़र इंटरफ़ेस में इस डाइमेंशन का नाम. उदाहरण के लिए, Event name.
description

string

इस डाइमेंशन का इस्तेमाल कैसे किया जाता है और इसकी गिनती कैसे की जाती है, इसके बारे में जानकारी.
deprecatedApiNames[]

string

इस डाइमेंशन के लिए, अब भी इस्तेमाल किए जा सकने वाले नाम, लेकिन अब इस्तेमाल नहीं किए जाते. अगर इस डाइमेंशन में डेटा मौजूद है, तो यह कुछ समय के लिए apiName या deprecatedApiNames में से किसी एक के हिसाब से उपलब्ध होता है. डेटा कलेक्शन बंद होने के बाद, यह डाइमेंशन सिर्फ़ apiName के ज़रिए उपलब्ध होगा.
customDefinition

boolean

अगर डाइमेंशन इस प्रॉपर्टी के लिए कस्टम है, तो वैल्यू 'सही' होती है. इनमें उपयोगकर्ता, इवेंट, और आइटम के स्कोप वाले कस्टम डाइमेंशन शामिल हैं. कस्टम डाइमेंशन के बारे में ज़्यादा जानने के लिए, https://support.google.com/analytics/answer/14240153 पर जाएं. इसमें कस्टम चैनल ग्रुप भी शामिल हैं. कस्टम चैनल ग्रुप के बारे में ज़्यादा जानने के लिए, https://support.google.com/analytics/answer/13051316 पर जाएं.
category

string

उस कैटगरी का डिसप्ले नेम जिससे यह डाइमेंशन जुड़ा है. मिलते-जुलते डाइमेंशन और मेट्रिक को एक साथ कैटगरी में रखा जाता है.
sections[]

enum (Section)

इससे पता चलता है कि यह डाइमेंशन, Google Analytics के किन सेक्शन पर लागू होता है.

MetricMetadata

किसी मेट्रिक के बारे में बताता है.

JSON के काेड में दिखाना 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
फ़ील्ड
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

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

enum (BlockedReason)

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

ज़्यादा जानने के लिए, ऐक्सेस और डेटा के इस्तेमाल से जुड़ी पाबंदियों को मैनेज करना लेख पढ़ें.
category

string

उस कैटगरी का डिसप्ले नेम जिससे यह मेट्रिक जुड़ी है. मिलते-जुलते डाइमेंशन और मेट्रिक को एक साथ कैटगरी में रखा जाता है.
sections[]

enum (Section)

इससे उन Google Analytics सेक्शन के बारे में पता चलता है जिन पर यह मेट्रिक लागू होती है.

BlockedReason

इस मेट्रिक को ब्लॉक करने की वजहें.

Enums
BLOCKED_REASON_UNSPECIFIED इसे एपीआई रिस्पॉन्स में कभी नहीं बताया जाएगा.
NO_REVENUE_METRICS अगर यह मौजूद है, तो इस प्रॉपर्टी के लिए रेवेन्यू से जुड़ी मेट्रिक का ऐक्सेस ब्लॉक कर दिया जाता है. साथ ही, यह मेट्रिक रेवेन्यू से जुड़ी होती है.
NO_COST_METRICS अगर यह मौजूद है, तो इस प्रॉपर्टी के लिए लागत से जुड़ी मेट्रिक को ऐक्सेस करने की आपकी अनुमति ब्लॉक कर दी जाती है. साथ ही, यह मेट्रिक लागत से जुड़ी होती है.

ComparisonMetadata

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

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

string

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

string

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

string

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

ConversionMetadata

किसी एक कन्वर्ज़न के लिए मेटाडेटा.

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

string

कन्वर्ज़न ऐक्शन का यूनीक आइडेंटिफ़ायर. इस आईडी का इस्तेमाल यह तय करने के लिए किया जाता है कि किसी रिपोर्ट में कौनसे कन्वर्ज़न शामिल करने हैं. इसके लिए, रिपोर्ट के अनुरोध के ConversionsSpec में conversionActions फ़ील्ड को भरा जाता है. उदाहरण के लिए, 'conversionActions/1234'.
displayName

string

Google Analytics के यूज़र इंटरफ़ेस में इस कन्वर्ज़न का नाम.