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

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

gtag(<command>, <command parameters>);
  • <command>, इनमें से कोई एक निर्देश है:
  • <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> के बारे में खास जानकारी:

  • gtag('config', <TARGET_ID>, ...) कमांड में मौजूद <TARGET_ID>, एक टैग आईडी है. इससे पता चलता है कि gtag.js को इवेंट डेटा कहां भेजना चाहिए. यह कोई डेस्टिनेशन हो सकता है, जैसे कि Google Analytics प्रॉपर्टी, Google Ads खाता, Floodlight कॉन्फ़िगरेशन या ऐसा Google टैग जिसमें कई डेस्टिनेशन हों.

  • टैग आईडी, आपके Google टैग का आइडेंटिफ़ायर होता है. जैसे, GT-XXXXXX, G-XXXXXX या AW-YYYYYY. Google टैग लोड करने के लिए, इस आईडी को अपनी वेबसाइट के कोड में जोड़ा जाता है.

  • एक Google टैग (इसके टैग आईडी से पहचाना जाता है) को एक से ज़्यादा डेस्टिनेशन पर डेटा भेजने के लिए कॉन्फ़िगर किया जा सकता है. कुछ टैग आईडी, डेस्टिनेशन आईडी जैसे दिख सकते हैं. जैसे, Google Analytics प्रॉपर्टी के लिए G-XXXXXX या Google Ads खाते के लिए AW-YYYYYY. हालांकि, config कमांड में मौजूद <TARGET_ID>, पेज पर लोड किए गए Google टैग के खास इंस्टेंस को दिखाता है.

  • gtag('config', ...) कमांड, उस खास <TARGET_ID> से जुड़े Google टैग के व्यवहार को कॉन्फ़िगर करता है. स्क्रिप्ट src में शामिल टैग आईडी, आम तौर पर Google टैग को लोड करता है. हालांकि, gtag('config') कमांड में अपने खाते से जुड़े किसी भी मान्य टैग आईडी का इस्तेमाल किया जा सकता है.

  • एक Google टैग में, कई टैग आईडी हो सकते हैं. ऐसा अक्सर टैग मर्ज करने की वजह से होता है. Google टैग को लोड करने के लिए, स्क्रिप्ट src पैरामीटर में, इनमें से किसी भी आईडी का इस्तेमाल किया जा सकता है.

  • अगर आपको एक से ज़्यादा डेस्टिनेशन पर डेटा भेजना है या एक से ज़्यादा टैग इस्तेमाल करने हैं, तो आपको स्क्रिप्ट src में सिर्फ़ एक टैग आईडी वाला Google टैग स्निपेट शामिल करना होगा. इसके बाद, हर अतिरिक्त टैग आईडी या डेस्टिनेशन के लिए, gtag('config') कमांड शामिल करें.

<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
session_id
  • Google Analytics 4
session_number
  • Google Analytics 4
gclid
  • Google Ads
  • Floodlight

उदाहरण

प्रॉमिस में वैल्यू पाना 

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 कमांड की मदद से, ऐसे पैरामीटर तय किए जा सकते हैं जो पेज पर होने वाले हर इवेंट से जुड़े होंगे.

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

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