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

FieldName

फ़ील्ड का नाम, gtag('set') कमांड के साथ सेट किए गए कस्टम फ़ील्ड का नाम हो सकता है. इसके अलावा, इनमें से कोई भी वैल्यू इस्तेमाल की जा सकती है:

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

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

उदाहरण

Promise में वैल्यू पाना

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

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> इनमें से कोई एक है:

• सुझाया गया इवेंट. सुझाए गए हर इवेंट में सुझाए गए पैरामीटर हो सकते हैं.
• कस्टम इवेंट. कस्टम इवेंट, ऐसा इवेंट होता है जिसका नाम और पैरामीटर आपने खुद से तय किए हों. ज़्यादा जानकारी के लिए, इवेंट सेट अप करना लेख पढ़ें.

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