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

खास जानकारी

मेज़रमेंट प्रोटोकॉल का इस्तेमाल करके, 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>

• अनुरोध का BODY. पेलोड देखें.

उत्तर कोड

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

अहम जानकारी: अगर आपको 2xx स्टेटस कोड नहीं मिलता है, तो आपको फिर से अनुरोध नहीं करना चाहिए. इसके बजाय, आपको अपने एचटीटीपी अनुरोध में मौजूद गड़बड़ियों को रोकना और उन्हें ठीक करना चाहिए.

पेलोड

Firebase gtag.js

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

1. क्वेरी पैरामीटर
2. JSON POST का मुख्य भाग

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

पैरामीटर का नाम	ब्यौरा
api_secret	ज़रूरी है. एक API Secret, जिसे Google Analytics के यूज़र इंटरफ़ेस (यूआई) से जनरेट किया जाता है. नया सीक्रेट बनाने के लिए, Google Analytics के यूज़र इंटरफ़ेस (यूआई) में जाकर: एडमिन > डेटा स्ट्रीम > अपनी स्ट्रीम चुनें > मेज़रमेंट प्रोटोकॉल > बनाएं हमारा सुझाव है कि आप इन्हें अपने संगठन के लिए निजी रखें. अगर मेज़रमेंट प्रोटोकॉल क्लाइंट-साइड का इस्तेमाल किया जाता है, तो ज़्यादा स्पैम से बचने के लिए, आपको समय-समय पर api_secrets को रोटेट करना चाहिए.
firebase_app_id	ज़रूरी है. Firebase का ऐप्लिकेशन आईडी. Firebase ऐप्लिकेशन का आइडेंटिफ़ायर. यह Firebase कंसोल में यहां मिलता है: प्रोजेक्ट सेटिंग > सामान्य > आपके ऐप्लिकेशन > ऐप्लिकेशन आईडी
measurement_id	मेज़रमेंट आईडी. डेटा स्ट्रीम के लिए आइडेंटिफ़ायर. Google Analytics के यूज़र इंटरफ़ेस (यूआई) में यह जानकारी मिलती है: एडमिन > डेटा स्ट्रीम > अपनी स्ट्रीम चुनें > मेज़रमेंट आईडी

JSON पोस्ट का मुख्य हिस्सा

सुरक्षा कुंजी	टाइप	ब्यौरा
app_instance_id	string	ज़रूरी है. यह खास तौर पर, किसी Firebase ऐप्लिकेशन के खास इंस्टॉलेशन की पहचान करता है. इस वैल्यू को Firebase SDK टूल से वापस लाना होगा. Android - getAppEventId() Kotlin - getAppExampleId() Swift - appइंस्टेंसID() Objective-C - appऐप्लिकेशन का आईडी C++ - GetAnalyticsInsightsId() Unity - GetAnalyticsAnalyticsIdAsync() यह वेब से अलग है client_id
client_id	string	ज़रूरी है. किसी वेब क्लाइंट के उपयोगकर्ता इंस्टेंस की अलग-अलग पहचान करता है. मेज़रमेंट प्रोटोकॉल को इवेंट भेजना लेख पढ़ें.
user_id	string	ज़रूरी नहीं. उपयोगकर्ता के लिए यूनीक आइडेंटिफ़ायर. इस आइडेंटिफ़ायर के बारे में ज़्यादा जानने के लिए, क्रॉस-प्लैटफ़ॉर्म विश्लेषण के लिए User-ID देखें. user_id में सिर्फ़ utf-8 वर्ण शामिल हो सकते हैं.
timestamp_micros	number	ज़रूरी नहीं. इवेंट से जोड़े जाने के समय के लिए, यूनिक्स टाइमस्टैंप (माइक्रोसेकंड में). इसे सिर्फ़ उन इवेंट को रिकॉर्ड करने के लिए सेट किया जाना चाहिए जो पहले हुए हैं. इस वैल्यू को user_property या इवेंट के टाइमस्टैंप से बदला जा सकता है. प्रॉपर्टी के टाइमज़ोन के आधार पर, इवेंट की तारीख ज़्यादा से ज़्यादा तीन कैलेंडर दिनों तक के लिए सेट की जा सकती है. यह वैल्यू माइक्रोसेकंड में होनी चाहिए, मिलीसेकंड सेकंड में नहीं.
user_properties	object	ज़रूरी नहीं. मेज़रमेंट के लिए उपयोगकर्ता प्रॉपर्टी. ज़्यादा जानकारी के लिए, उपयोगकर्ता प्रॉपर्टी देखें.
consent	object	ज़रूरी नहीं. अनुरोध के लिए सहमति की सेटिंग सेट करता है. ज़्यादा जानकारी के लिए, सहमति सेक्शन देखें.
non_personalized_ads	boolean	ज़रूरी नहीं. इसे true पर सेट करें, ताकि यह बताया जा सके कि लोगों के डेटा का इस्तेमाल, दिलचस्पी के मुताबिक विज्ञापन दिखाने के लिए नहीं किया जाना चाहिए. पुराना: इस फ़ील्ड के बजाय, consent के ad_personalization फ़ील्ड का इस्तेमाल करें. Google Analytics इनमें से किसी भी फ़ील्ड को स्वीकार करता है, लेकिन ad_personalization का सुझाव दिया जाता है.
events[]	array	ज़रूरी है. इवेंट आइटम का कलेक्शन. हर अनुरोध के लिए, ज़्यादा से ज़्यादा 25 इवेंट भेजे जा सकते हैं. सभी मान्य इवेंट के लिए, इवेंट रेफ़रंस देखें.
events[].name	string	ज़रूरी है. इवेंट का नाम. सभी विकल्पों के लिए, इवेंट रेफ़रंस देखें.
events[].params	object	ज़रूरी नहीं. इवेंट के पैरामीटर. हर इवेंट के लिए सुझाए गए पैरामीटर के लिए, इवेंट देखें.

सहमति

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_