मेज़रमेंट प्रोटोकॉल का रेफ़रंस

इस पेज पर, मेज़रमेंट प्रोटोकॉल के लिए ट्रांसपोर्ट मैकेनिज़्म और डेटा पैरामीटर के बारे में बताया गया है.

परिवहन

पूरा डेटा, एचटीटीपीएस POST अनुरोधों का इस्तेमाल करके सुरक्षित तरीके से भेजा जाना चाहिए.

यहां दिए गए एंडपॉइंट पर अनुरोध भेजें:

https://www.google-analytics.com/mp/collect

अगर आपको ईयू में डेटा इकट्ठा करना है, तो इसके बजाय इस एंडपॉइंट का इस्तेमाल करें:

https://region1.google-analytics.com/mp/collect

यहां POST के अनुरोध का एक सैंपल दिया गया है:

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
PAYLOAD_DATA

PAYLOAD_DATA को अनुरोध के Payload से बदलें.

अगर HTTP अनुरोध मिलता है, तो Measurement Protocol 2xx स्टेटस कोड दिखाता है. अगर पेलोड गलत फ़ॉर्मैट में है या डेटा गलत है या Google Analytics उसे प्रोसेस नहीं कर रहा है, तो Measurement Protocol कोई गड़बड़ी कोड नहीं दिखाता.

पेलोड

पेलोड के दो हिस्से होते हैं:

  1. क्वेरी पैरामीटर.
  2. JSON POST बॉडी.

क्वेरी पैरामीटर

पैरामीटर का नाम ब्यौरा

api_secret

ज़रूरी है. Google Analytics के यूज़र इंटरफ़ेस (यूआई) से मिला एपीआई सीक्रेट.

यह एडमिन > डेटा स्ट्रीम > अपनी स्ट्रीम चुनें > मेज़रमेंट प्रोटोकॉल > बनाएं में जाकर देखा जा सकता है.

आपके संगठन के लिए निजी. इसे समय-समय पर अपडेट किया जाना चाहिए, ताकि स्पैम से बचा जा सके.

JSON POST बॉडी

कुंजी टाइप ब्यौरा

user_id

string

Optional. यह कुकी, उपयोगकर्ता के लिए यूनीक आइडेंटिफ़ायर होती है. इस आइडेंटिफ़ायर के बारे में ज़्यादा जानने के लिए, क्रॉस-प्लैटफ़ॉर्म विश्लेषण के लिए User-ID देखें. इसमें सिर्फ़ utf-8 वर्ण शामिल किए जा सकते हैं.

timestamp_micros

number

Optional. यूनिक्स टाइमस्टैंप, माइक्रोसेकंड में, न कि मिलीसेकंड में. इससे इवेंट के समय के बारे में पता चलता है. इसे सिर्फ़ उन इवेंट को रिकॉर्ड करने के लिए सेट किया जाना चाहिए जो पहले हो चुके हैं. इसे user_property या इवेंट के टाइमस्टैंप से बदला जा सकता है. इवेंट को प्रॉपर्टी के टाइमज़ोन के हिसाब से, तीन कैलेंडर दिनों तक की पिछली तारीख के साथ जोड़ा जा सकता है.

user_properties

object Optional. मेज़रमेंट के लिए उपयोगकर्ता प्रॉपर्टी.

user_data

object Optional. उपयोगकर्ता से मिला डेटा.
object Optional. अनुरोध के लिए सहमति की सेटिंग. ज़्यादा जानकारी के लिए, सहमति वाला सेक्शन देखें.

non_personalized_ads

boolean ज़रूरी नहीं है. इस पैरामीटर को true पर सेट करें. इससे यह पता चलता है कि उपयोगकर्ता के डेटा का इस्तेमाल, दिलचस्पी के मुताबिक विज्ञापन दिखाने के लिए नहीं किया जाना चाहिए.

user_location

object Optional. यह कुकी, अनुरोध के लिए भौगोलिक जानकारी को स्ट्रक्चर्ड फ़ॉर्मैट में सेट करती है.

ip_override

string Optional. Google Analytics, इस आईपी पते का इस्तेमाल करके अनुरोध के लिए भौगोलिक जानकारी का पता लगाता है.

device

object ज़रूरी नहीं. यह कुकी, अनुरोध के लिए डिवाइस की जानकारी को स्ट्रक्चर्ड फ़ॉर्मैट में सेट करती है.

events[]

array ज़रूरी है. event आइटम का कलेक्शन. हर अनुरोध में ज़्यादा से ज़्यादा 25 इवेंट भेजे जा सकते हैं. सभी मान्य इवेंट के लिए, इवेंट रेफ़रंस देखें.

events[].name

string ज़रूरी है. इवेंट का नाम. सभी विकल्पों के लिए, इवेंट देखें.

events[].params

object Optional. इवेंट के पैरामीटर. हर इवेंट के लिए सुझाए गए पैरामीटर और सामान्य इवेंट पैरामीटर देखने के लिए, इवेंट देखें.

सामान्य इवेंट पैरामीटर

मेज़रमेंट प्रोटोकॉल में ये सामान्य इवेंट पैरामीटर होते हैं:

कुंजी टाइप ब्यौरा

session_id

number यह एक पॉज़िटिव नंबर होता है, जिससे उपयोगकर्ता के सेशन की पहचान होती है. कई सामान्य इस्तेमाल के उदाहरणों के लिए ज़रूरी है. यह ^\d+$ रेगुलर एक्सप्रेशन से मेल खाना चाहिए.

engagement_time_msec

number इवेंट के लिए, यूज़र ऐक्टिविटी की अवधि. यह अवधि मिलीसेकंड में होती है. ऐसी वैल्यू का इस्तेमाल करें जिससे पिछले इवेंट के बाद से, उपयोगकर्ता के जुड़ाव के समय का पता चले.

timestamp_micros

number इवेंट का Unix epoch टाइम, माइक्रोसेकंड में. इस पैरामीटर का इस्तेमाल करके, इवेंट के टाइमस्टैंप को बदला जा सकता है.

consent एट्रिब्यूट, सहमति के टाइप और स्थितियों को कॉन्फ़िगर करता है. अगर आपने consent तय नहीं किया है, तो Google Analytics, क्लाइंट या ऐप्लिकेशन इंस्टेंस के लिए, ऑनलाइन इंटरैक्शन से जुड़ी सहमति की सेटिंग का इस्तेमाल करता है.

कुंजी टाइप ब्यौरा

ad_user_data

string

Optional. विज्ञापन दिखाने के मकसद से, Google को उपयोगकर्ता का डेटा भेजने के लिए सहमति सेट करता है. यह डेटा, अनुरोध के इवेंट और उपयोगकर्ता प्रॉपर्टी से मिलता है.

GRANTED या DENIED.

ad_personalization

string

Optional. उपयोगकर्ता को दिलचस्पी के मुताबिक विज्ञापन दिखाने के लिए सहमति.

GRANTED या DENIED.

भौगोलिक जानकारी

user_location और ip_override एट्रिब्यूट से, भौगोलिक जानकारी मिलती है. user_location को ip_override की जगह प्राथमिकता दी जाती है.

यहां user_location फ़ील्ड का स्ट्रक्चर दिया गया है. ज़्यादा से ज़्यादा एट्रिब्यूट की वैल्यू दें. हमारा सुझाव है कि आप कम से कम country_id और region_id का इस्तेमाल करें.

कुंजी टाइप ब्यौरा

city

string Optional. शहर का नाम. अगर शहर अमेरिका में है, तो country_id और region_id भी सेट करें, ताकि Google Analytics शहर के नाम को शहर के आईडी से सही तरीके से मैप कर सके.

region_id

string Optional. ISO 3166 के मुताबिक देश और सबडिविज़न. उदाहरण के लिए, US-CA, US-AR, CA-BC, GB-LND, CN-HK.

country_id

string Optional. ISO 3166-1 alpha-2 फ़ॉर्मैट में देश का कोड. उदाहरण के लिए, US, AU, ES, FR.

subcontinent_id

string Optional. उपमहाद्वीप UN M49 फ़ॉर्मैट में होना चाहिए. उदाहरण के लिए, 011, 021, 030, 039.

continent_id

string Optional. महाद्वीप का नाम UN M49 फ़ॉर्मैट में होना चाहिए. उदाहरण के लिए, 002, 019, 142, 150.

यहां user_location का एक सैंपल दिया गया है:

"user_location": {
  "city": "Mountain View",
  "region_id": "US-CA",
  "country_id": "US",
  "subcontinent_id": "021",
  "continent_id": "019"
}

ip_override, user_location का विकल्प है. अगर आपने ip_override भेजा है, तो Google Analytics, आईपी पते से भौगोलिक जानकारी का पता लगाता है. अगर user_location भेजा जाता है, तो Google Analytics ip_override को अनदेखा कर देता है.

अगर user_location या ip_override नहीं भेजा जाता है, तो Google Analytics, टैग किए गए इवेंट से भौगोलिक जानकारी का पता लगाता है. इसके लिए, वह client_id.

Google Analytics, अनुरोध पर प्रॉपर्टी की जगह की सटीक जानकारी के डेटा की सेटिंग लागू करता है. भले ही, भौगोलिक जानकारी भेजी गई हो या नहीं.

डिवाइस की जानकारी

डिवाइस की जानकारी भेजने के लिए, device फ़ील्ड का इस्तेमाल करें. यहां device फ़ील्ड का स्ट्रक्चर दिया गया है. ज़्यादा से ज़्यादा एट्रिब्यूट की वैल्यू दें. हमारा सुझाव है कि कम से कम category का टारगेट सेट करें.

कुंजी टाइप ब्यौरा

category

string ज़रूरी नहीं. डिवाइस की कैटगरी. उदाहरण के लिए, desktop, tablet, mobile, smart TV.

language

string ज़रूरी नहीं. ISO 639-1 फ़ॉर्मैट में भाषा. उदाहरण के लिए, en, en-US.

screen_resolution

string ज़रूरी नहीं. डिवाइस का रिज़ॉल्यूशन, जिसे WIDTHxHEIGHT के तौर पर फ़ॉर्मैट किया गया है. उदाहरण के लिए, 1280x2856, 1080x2340.

operating_system

string ज़रूरी नहीं. ऑपरेटिंग सिस्टम या प्लैटफ़ॉर्म. उदाहरण के लिए, MacOS.

operating_system_version

string ज़रूरी नहीं. ऑपरेटिंग सिस्टम या प्लैटफ़ॉर्म का वर्शन. उदाहरण के लिए, 13.5.

model

string ज़रूरी नहीं. डिवाइस का मॉडल. उदाहरण के लिए, Pixel 9 Pro, Samsung Galaxy S24.

brand

string ज़रूरी नहीं. डिवाइस का ब्रैंड. उदाहरण के लिए, Google, Samsung.

browser

string ज़रूरी नहीं. ब्राउज़र का ब्रैंड या टाइप. उदाहरण के लिए, Chrome, Firefox.

browser_version

string ज़रूरी नहीं. ब्राउज़र का वर्शन. उदाहरण के लिए, 136.0.7103.60, 5.0.

यहां दिए गए स्निपेट में, device की सेटिंग का एक उदाहरण दिखाया गया है:

"device": {
  "category": "mobile",
  "language": "en",
  "screen_resolution": "1280x2856",
  "operating_system": "Android",
  "operating_system_version": "14",
  "model": "Pixel 9 Pro",
  "brand": "Google",
  "browser": "Chrome",
  "browser_version": "136.0.7103.60"
}

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

कस्टम पैरामीटर

मेज़रमेंट प्रोटोकॉल के पेलोड में, उपयोगकर्ता के स्कोप वाले, इवेंट के स्कोप वाले, और आइटम के स्कोप वाले कस्टम पैरामीटर शामिल किए जा सकते हैं.

  • user_properties में उपयोगकर्ता के स्कोप वाले कस्टम पैरामीटर शामिल किए जा सकते हैं.
  • इवेंट के स्कोप वाले कस्टम पैरामीटर को events[].params में शामिल किया जा सकता है.
  • आइटम के स्कोप वाले कस्टम पैरामीटर को items में शामिल किया जा सकता है.

कुछ इवेंट के लिए, सुझाए गए पैरामीटर होते हैं. सभी इवेंट के लिए सुझाए गए पैरामीटर देखने के लिए, इवेंट देखें.

रिज़र्व किए गए नाम

कुछ इवेंट, पैरामीटर, और उपयोगकर्ता प्रॉपर्टी के नाम रिज़र्व किए गए हैं. इनका इस्तेमाल नहीं किया जा सकता:

इवेंट के रिज़र्व किए गए नाम

नीचे दिए गए इवेंट के नाम रिज़र्व हैं. इनका इस्तेमाल नहीं किया जा सकता:

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • session_start
  • user_engagement

पैरामीटर के रिज़र्व किए गए नाम

नीचे दिए गए पैरामीटर के नाम रिज़र्व हैं. इनका इस्तेमाल नहीं किया जा सकता:

  • firebase_conversion

पैरामीटर के नाम, इनसे शुरू नहीं हो सकते:

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

उपयोगकर्ता प्रॉपर्टी के रिज़र्व किए गए नाम

नीचे दी गई उपयोगकर्ता प्रॉपर्टी के नाम रिज़र्व हैं. इनका इस्तेमाल नहीं किया जा सकता:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

इसके अलावा, उपयोगकर्ता प्रॉपर्टी के नाम इनसे शुरू नहीं हो सकते:

  • _ (underscore)
  • firebase_
  • ga_
  • google_