Google टैग API का रेफ़रंस

Google टैग (gtag.js) एपीआई में एक फ़ंक्शन gtag() होता है, जिसमें नीचे दिया गया सिंटैक्स:

gtag(<command>, <command parameters>);

• <command> इनमें से एक है:
  • config
  • get
  • set
  • event
  • consent
• <command parameters> ऐसे पैरामीटर हैं जिन्हें gtag() को पास किया जा सकता है. निर्देश दें कमांड के हिसाब से पैरामीटर अलग-अलग होते हैं; कमांड रेफ़रंस देखें, देखें.

निर्देशों के मुताबिक, पेज पर कहीं भी gtag() कमांड शुरू किए जा सकते हैं ये Google टैग स्निपेट के नीचे दिखते हैं. स्निपेट जोड़ने का तरीका पेज पर, इंस्टॉलेशन गाइड देखें.

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

पैरामीटर की वैल्यू को अलग-अलग इवेंट में जोड़ा जा सकता है. इसके लिए, खास <TARGET_ID> या दुनिया भर में हर इवेंट के लिए. ऐसा करने के लिए, event, config, और set निर्देश.

एक दायरे में सेट की गई पैरामीटर वैल्यू, उसी स्कोप के लिए सेट की गई वैल्यू में बदलाव नहीं करती पैरामीटर को अलग-अलग दायरे में रखते हैं. नीचे दिए गए उदाहरण में, config निर्देश काम करता है campaign_id के लिए, set के साथ पहले असाइन की गई ग्लोबल वैल्यू में बदलाव न करें आदेश. दोनों कमांड के लागू होने के बाद, campaign_id की ग्लोबल वैल्यू अब भी '1234'.

// Set global campaign ID
gtag('set', { 'campaign_id': '1234' });

// Set campaign ID for <TARGET_ID>
gtag('config','<TARGET_ID>', { 'campaign_id': 'ABCD' });

पैरामीटर प्राथमिकता

अगर अलग-अलग दायरे में एक ही पैरामीटर को अलग-अलग वैल्यू असाइन की गई हैं, तो सिर्फ़ किसी सिंगल वैल्यू का इस्तेमाल इवेंट प्रोसेस करते समय किया जाता है. पैरामीटर वैल्यू यहां दी गई हैं event को config और config के दायरे वाले पैरामीटर के मुकाबले प्राथमिकता दी जाएगी set का इस्तेमाल करके, दुनिया भर में इस्तेमाल किए जाने वाले पैरामीटर के मुकाबले, पैरामीटर को प्राथमिकता दी जाती है.

// Set campaign information at the global scope
gtag('set', { 'campaign_name': 'Black Friday Sale' });

// Set currency for <TARGET_ID1> to 'USD'
gtag('config','<TARGET_ID1>', { 'currency': 'USD' });

// Process a conversion event with currency: 'GBP'
gtag('event','conversion', { 'currency': 'GBP', 'send_to': '<TARGET_ID1>' });

// Process a conversion event with currency: 'EUR'
gtag('event','conversion');

// Process a conversion event with currency: 'USD'
gtag('event','conversion', { 'send_to': '<TARGET_ID1>' });

config

इसकी सहायता से आप टारगेट में अतिरिक्त कॉन्फ़िगरेशन जानकारी जोड़ सकते हैं. यह है आम तौर पर, किसी प्रॉडक्ट के लिए एक खास तरह का कॉन्फ़िगरेशन होता है, लेकिन आपको सिर्फ़ अगर Google Ads और Google Analytics, दोनों का इस्तेमाल किया जा रहा है, तो इसे एक बार कॉन्फ़िगर करें.

gtag('config', '<TARGET_ID>', {<additional_config_info>});

<TARGET_ID> एक आइडेंटिफ़ायर है, जो हिट के टारगेट की खास तौर पर पहचान करता है, जैसे कि Google Analytics प्रॉपर्टी या Google Ads खाता. <additional_config_info>, एक या उससे ज़्यादा पैरामीटर-वैल्यू पेयर हैं.

इस उदाहरण में, Google Ads खाते में डेटा भेजने के लिए टैग को कॉन्फ़िगर किया गया है:

gtag('config', 'TAG_ID');

जहां "TAG_ID" यह Google टैग का टैग आईडी है.

कॉन्फ़िगरेशन की अन्य जानकारी भेजने का तरीका बताने के लिए, यहां एक उदाहरण दिया गया है जो टैग को इस तरह से Analytics खाते में डेटा भेजने के लिए कॉन्फ़िगर करता है: send_page_view पैरामीटर, जो false और groups की वैल्यू पास करता है वह पैरामीटर है जो 'agency' की वैल्यू पास करता है.

gtag('config', 'TAG_ID', {
  'send_page_view': false,
  'groups': 'agency'
});

get

आपको gtag.js से कई वैल्यू पाने की सुविधा देता है. इनमें, set निर्देश.

gtag('get', '<target>', '<field_name>', callback)

आर्ग्यूमेंट	टाइप	उदाहरण	ब्यौरा
<target>	string	G-XXXXXXXXXX	वह टारगेट जिससे वैल्यू फ़ेच करनी हैं.
<field_name>	FieldName	client_id	फ़ील्ड का नाम, जिसे आपको पाना है.
कॉलबैक	Function	(field) => console.log(field)	एक फ़ंक्शन जिसे अनुरोध किए गए फ़ील्ड के साथ शुरू किया जाएगा, या अगर नीति सेट नहीं है, तो undefined.

FieldName

फ़ील्ड का नाम, gtag('set') के साथ सेट किए गए कस्टम फ़ील्ड का नाम हो सकता है आदेश या इनमें से किसी एक मान का इस्तेमाल करें:

फ़ील्ड का नाम	इस्तेमाल किए जा सकने वाले टारगेट
client_id	Google Analytics 4 Google Analytics यूनिवर्सल Analytics
session_id	Google Analytics 4
gclid	Google Ads फ़्लडलाइट

ध्यान दें: अगर इन फ़ील्ड के नामों के साथ set कमांड का इस्तेमाल किया जाता है, तो आपने जो वैल्यू सेट की है को प्राथमिकता दी जाएगी.

उदाहरण

ऑफ़र की वैल्यू पाएं

const gclidPromise = new Promise(resolve => {
  gtag('get', 'DC-XXXXXXXX', 'gclid', resolve)
});

gclidPromise.then((gclid) => {
  // Do something with gclid...
})

मेज़रमेंट प्रोटोकॉल को इवेंट भेजना

gtag('get', 'G-XXXXXXXXXX', 'client_id', (clientID) => {
  sendOfflineEvent(clientID, "tutorial_begin")
});

function sendOfflineEvent(clientID, eventName, eventData) {
  // Send necessary data to your server...
}

अपनी सेट की गई वैल्यू पाना

gtag('set', {campaign_name: 'Spring_Sale'});

gtag('get', 'G-XXXXXXXXXX', 'campaign_name', (campaign_name) => {
  // Do something with currency value you set earlier.
})

set

सेट आदेश आपको ऐसे पैरामीटर परिभाषित करने देता है, जो प्रत्येक पर क्लिक करें.

ध्यान दें: हमारा सुझाव है कि जहां भी मुमकिन हो, config या event निर्देशों का इस्तेमाल करें.

gtag('set', {<parameter-value-pair>, <parameter-value-pair>});

उदाहरण के लिए, कैंपेन शेयर किया जा सकता है पैरामीटर का इस्तेमाल करें, ताकि उन्हें एक ही पेज पर मौजूद कई टैग से ऐक्सेस किया जा सके.

नीचे दिए गए उदाहरण में ब्लैक फ़्राइडे के लिए कैंपेन का नाम और आईडी सेट करने के बारे में बताया गया है शॉपिंग इवेंट. क्योंकि आपने set का इस्तेमाल किया है, इसलिए उदाहरण के लिए अन्य सभी टैग GA4 इवेंट टैग या Google Ads रीमार्केटिंग टैग, इस डेटा को ऐक्सेस कर सकते हैं.

gtag('set', 'campaign', {
  'id': 'abc',
  'source': 'google',
  'name': 'black_friday_promotion',
  'term': 'running+shoes',
});

event

इवेंट का डेटा भेजने के लिए, event कमांड का इस्तेमाल करें.

gtag('event', '<event_name>', {<event_params>});

<event_name> में से कोई एक है:

• सुझाया गया इवेंट. सुझाए गए हर इवेंट में सुझाए गए पैरामीटर.
• कस्टम इवेंट. कस्टम इवेंट, आपके बनाए गए इवेंट का एक आर्बिट्रेरी नाम होता है, का इस्तेमाल करें. उदाहरण के लिए, देखें Google Analytics में कस्टम इवेंट का इस्तेमाल कैसे किया जाता है.

<event_params>, एक या उससे ज़्यादा पैरामीटर-वैल्यू पेयर हैं. हर जोड़ी को कॉमा.

यह event निर्देश, सुझाए गए इवेंट screen_view को दो के साथ ट्रिगर करता है पैरामीटर: app_name और screen_name.

gtag('event', 'screen_view', {
  'app_name': 'myAppName',
  'screen_name': 'Home'
});

अहम जानकारी: Google टैग स्निपेट, ऊपर दिए गए पेज पर ही होना चाहिए event के निर्देशों का पालन न करने पर, आपका डेटा भेजा नहीं जाएगा.

consent

सहमति को कॉन्फ़िगर करने के लिए, consent निर्देश का इस्तेमाल करें.

gtag('consent', {<consent_arg>}, {<consent_params>});

इन व्यवहार के बारे में ज़्यादा जानकारी के लिए, सहायता केंद्र में सहमति देखें पैरामीटर कॉन्फ़िगर करते हैं.

<consent_arg>, 'default' या 'update' में से एक है. 'default' का इस्तेमाल सेट करने के लिए किया जाता है सहमति के डिफ़ॉल्ट पैरामीटर इस्तेमाल किए जाने चाहिए. साथ ही, 'update' का इस्तेमाल इन कामों के लिए किया जाता है जब कोई उपयोगकर्ता अपनी सहमति देता है, तो इन पैरामीटर को अपडेट किया जा सकता है.

ये <consent_params> इस्तेमाल किए जा सकते हैं:

फ़ील्ड का नाम	अनुमति वाली वैल्यू	ब्यौरा
ad_storage	'granted' | 'denied'	विज्ञापन से जुड़ी कुकी (वेब) या डिवाइस आइडेंटिफ़ायर (ऐप्लिकेशन) जैसी मेमोरी को चालू करता है.
ad_user_data	'granted' | 'denied'	विज्ञापन दिखाने के मकसद से, Google को उपयोगकर्ता का डेटा भेजने के लिए सहमति सेट करता है.
ad_personalization	'granted' | 'denied'	लोगों के हिसाब से विज्ञापन दिखाने के लिए सहमति सेट करता है.
analytics_storage	'granted' | 'denied'	आंकड़ों से जुड़ी मेमोरी, जैसे कि कुकी (वेब) या ऐप्लिकेशन आइडेंटिफ़ायर (ऐप्लिकेशन) को चालू करता है. उदाहरण के लिए, विज़िट की अवधि.
wait_for_update	कोई भी धनात्मक पूर्णांक	सहमति के अपडेट के लिए कॉल के इंतज़ार का समय, मिलीसेकंड में सेट करता है.