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>});

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

नीचे दिए गए उदाहरण में ब्लैक फ़्राइडे शॉपिंग इवेंट के लिए कैंपेन का नाम और आईडी सेट करने का तरीका बताया गया है. आपने 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	कोई भी धनात्मक पूर्णांक	सहमति अपडेट कॉल के लिए इंतज़ार का समय, मिलीसेकंड में सेट करता है.