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

खास जानकारी

मेज़रमेंट प्रोटोकॉल का इस्तेमाल करके, Google Analytics को डेटा भेजने के दो तरीके हैं:

  1. ट्रांसपोर्ट - डेटा कहां और कैसे भेजा जाता है
  2. पेलोड - आपका भेजा जाने वाला डेटा

इस दस्तावेज़ में बताया गया है कि ट्रांसपोर्ट और पेलोड को कैसे फ़ॉर्मैट किया जाता है.

परिवहन

यूआरएल एंडपॉइंट

मेज़रमेंट प्रोटोकॉल का इस्तेमाल करके डेटा भेजने के लिए, इस एंडपॉइंट पर एचटीटीपी पोस्ट अनुरोध भेजें:

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

कोई इवेंट भेजने के लिए, यह POST अनुरोध करें:

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

रिस्पॉन्स कोड

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

पेलोड

मेज़रमेंट प्रोटोकॉल डेटा का इस्तेमाल करके, Google Analytics को डेटा दो हिस्सों में भेजा जाता है:

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

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

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

api_secret

ज़रूरी है. Google Analytics के यूज़र इंटरफ़ेस (यूआई) से जनरेट किया गया API Secret.

नया सीक्रेट बनाने के लिए, Google Analytics के यूज़र इंटरफ़ेस (यूआई) में इन पर जाएं:
एडमिन > डेटा स्ट्रीम > अपनी स्ट्रीम चुनें > मेज़रमेंट प्रोटोकॉल > बनाएं

हमारा सुझाव है कि आप इन्हें अपने संगठन के लिए निजी रखें. अगर आपने मेज़रमेंट प्रोटोकॉल को क्लाइंट-साइड पर डिप्लॉय किया है, तो आपको ज़्यादा स्पैम से बचने के लिए, api_secret को नियमित तौर पर रोटेट करना चाहिए.

JSON फ़ाइल का मुख्य हिस्सा

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

user_id

 string

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

timestamp_micros

 number

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

user_properties

 object ज़रूरी नहीं. मेज़रमेंट के लिए उपयोगकर्ता प्रॉपर्टी. ज़्यादा जानकारी के लिए, उपयोगकर्ता प्रॉपर्टी देखें.

user_data

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

non_personalized_ads

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

events[]

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

events[].name

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

events[].params

 object ज़रूरी नहीं. इवेंट के पैरामीटर. हर इवेंट के लिए सुझाए गए पैरामीटर के बारे में जानने के लिए, इवेंट देखें.

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

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

ad_user_data

 string

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

यह GRANTED या DENIED होनी चाहिए.

ad_personalization

 string

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

यह GRANTED या DENIED होनी चाहिए.

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

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

  • उपयोगकर्ता के स्कोप वाले कस्टम पैरामीटर को, पेलोड के 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_