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

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

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

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

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

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

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

एक स्कोप में सेट की गई पैरामीटर वैल्यू, दूसरे स्कोप में उसी पैरामीटर के लिए सेट की गई वैल्यू में बदलाव नहीं करती हैं. इस उदाहरण में, config कमांड, set कमांड से पहले असाइन की गई campaign_id की ग्लोबल वैल्यू में बदलाव नहीं करती है. दोनों कमांड के लागू होने के बाद भी, 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.js को इवेंट डेटा कहां भेजना चाहिए. यह Google Analytics प्रॉपर्टी या Google Ads खाते जैसा कोई डेस्टिनेशन हो सकता है. इसके अलावा, यह ऐसा Google टैग भी हो सकता है जिसके कई डेस्टिनेशन हों. <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)

FieldName

फ़ील्ड का नाम, gtag('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

सेट कमांड की मदद से, ऐसे पैरामीटर तय किए जा सकते हैं जो पेज पर होने वाले हर इवेंट से जुड़े होंगे.

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

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

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

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

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

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