Browser SDK रेफ़रेंस

Browser SDK, window.sdk, का संदर्भ: पेज से PWA इंस्टॉल का प्रस्ताव कैसे दें, आगंतुक को पुश के लिए सब्सक्राइब करें, इवेंट भेजें, और इसके लिए कौन-सी सेटिंग्स चाहिए। सामान्य परिचय के लिए Browser SDK देखें; इसे अपने प्रीलैंडिंग से जोड़ने के लिए प्रीलैंडिंग पर SDK देखें।

window.pwaConfig सेटिंग्स

SDK अपनी सेटिंग्स window.pwaConfig ऑब्जेक्ट से पढ़ता है, जिसे आप स्क्रिप्ट टैग से पहले पेज पर सेट करते हैं। Qubix द्वारा परोसे जाने वाले पेजों पर ऑब्जेक्ट स्वचालित रूप से भरा जाता है; अपने प्रीलैंडिंग पर आप इसे स्वयं सेट करते हैं।

फ़ील्ड	उद्देश्य
pwaId	PWA पहचानकर्ता। इंस्टॉल और पुश के लिए आवश्यक
domain	पेज का डोमेन। मैनिफ़ेस्ट और पुश के लिए आवश्यक
vapidKey	पुश के लिए की। आमतौर पर /sdk.js लोड होने पर स्वचालित रूप से इनलाइन होती है — इसे हाथ से सेट करने की आवश्यकता नहीं
offerId	ऑफ़र (यदि आपको इसे स्पष्ट रूप से पास करना हो)
campaignId	कैंपेन (यदि आपको इसे स्पष्ट रूप से पास करना हो)
params	अतिरिक्त ट्रैकिंग टैग
previewMode	प्रीव्यू मोड: इवेंट नहीं भेजे जाते

PWA पहचानकर्ता (pwaId) PWA Apps सेक्शन में ऐप कार्ड से लिया जाता है।

पुश सब्सक्राइब करें

sdk.subscribePush() ब्राउज़र से नोटिफ़िकेशन अनुमति माँगता है और एक सब्सक्रिप्शन बनाता है। आपको इसे स्पष्ट रूप से कॉल करना होगा — उदाहरण के लिए, बटन क्लिक पर। यह अपने आप नहीं चलता।

JavaScript

const subscription = await sdk.subscribePush()
if (subscription) {
  // आगंतुक ने नोटिफ़िकेशन की अनुमति दी और सब्सक्राइब हो गया
}

अंदर क्या होता है:

1. ब्राउज़र का अनुमति प्रॉम्प्ट दिखाया जाता है।
2. यदि आगंतुक अनुमति देता है, तो एक सब्सक्रिप्शन बनाया जाता है और Qubix को भेजा जाता है।
3. बार-बार कॉल सुरक्षित हैं: यदि आगंतुक पहले से सब्सक्राइब है, तो प्रॉम्प्ट दोबारा नहीं दिखाया जाता।

पुश के लिए ऐप इंस्टॉल करना आवश्यक नहीं है — एक आगंतुक सामान्य पेज पर सब्सक्राइब कर सकता है।

note

पुश केवल एक सुरक्षित कनेक्शन (HTTPS) पर और Qubix में सेट अप किए गए डोमेन पर काम करता है। इस बारे में अधिक जानकारी प्रीलैंडिंग पर SDK में है।

PWA इंस्टॉल करें

यदि window.pwaConfig में pwaId है, तो SDK sdk.pwa मेथड उपलब्ध कराता है:

मेथड	यह क्या करता है
sdk.pwa.init()	तैयारी: सर्विस वर्कर रजिस्टर करता है और ऐप मैनिफ़ेस्ट जोड़ता है
sdk.pwa.install()	सिस्टम ऐप-इंस्टॉल प्रॉम्प्ट दिखाता है
sdk.pwa.canInstall()	क्या अभी इंस्टॉल उपलब्ध है
sdk.pwa.isInstalled()	क्या ऐप पहले से इंस्टॉल है
sdk.pwa.open()	इंस्टॉल किया हुआ ऐप खोलता है

init, install, और isInstalled असंकालिक हैं — इन्हें await के साथ कॉल करें। canInstall और open तुरंत मान लौटाते हैं।

JavaScript

if (sdk.pwa && sdk.pwa.canInstall()) {
  await sdk.pwa.install()
}

इंस्टॉल प्रॉम्प्ट ब्राउज़र स्वयं दिखाता है, इसलिए उसके नियम लागू होते हैं: HTTPS, एक जुड़ा हुआ मैनिफ़ेस्ट (SDK आपके लिए यह जोड़ता है), और आमतौर पर पेज पर आगंतुक की कोई क्रिया (क्लिक, स्क्रॉल)। इसीलिए इंस्टॉल बटन आमतौर पर एक स्पष्ट टैप से जुड़ा होता है।

इवेंट

SDK एनालिटिक्स को प्रमुख क्षण स्वयं रिपोर्ट करता है — ये रिपोर्ट में और इवेंट स्ट्रीम में दिखते हैं:

इवेंट	कब
campaign_visit	पेज पर एक विज़िट (स्वचालित रूप से भेजी जाती है)
push_prompt_shown	पुश अनुमति प्रॉम्प्ट दिखाया गया
push_allow	आगंतुक ने पुश की अनुमति दी
push_deny	आगंतुक ने पुश से इनकार किया
push_ignored	आगंतुक ने बिना चुने प्रॉम्प्ट को बंद कर दिया
install_accepted	आगंतुक ने ऐप इंस्टॉल करने पर सहमति दी
install_rejected	आगंतुक ने इंस्टॉल से इनकार किया

आप अपना इवेंट मैन्युअल रूप से भेज सकते हैं:

JavaScript

sdk.sendEvent('my_button_click', { place: 'hero' })

ट्रैफ़िक डेटा

क्लिक संदर्भ पढ़ने के सहायक मेथड:

मेथड	लौटाता है
sdk.getOffer()	वर्तमान ऑफ़र (ID और URL)
sdk.getPwa()	वर्तमान PWA
sdk.getPiuid()	आगंतुक ID
sdk.getTrackingParams()	क्लिक के साथ आए ट्रैकर टैग
sdk.buildOfferUrl(url)	ले जाए गए टैग के साथ ऑफ़र URL बनाएँ
sdk.showStore()	PWA स्टोर कार्ड पर जाएँ

SDK अपने आप क्या करता है

आपकी ओर से बिना किसी कॉल के, पेज लोड होने पर SDK डिवाइस डेटा एकत्र करता है, URL से ट्रैकिंग टैग पार्स करता है, ऐप मैनिफ़ेस्ट जोड़ता है (यदि pwaId सेट है), और campaign_visit इवेंट भेजता है। इंस्टॉल और पुश सब्सक्रिप्शन अपने आप शुरू नहीं होते — आप इन्हें कोड से ट्रिगर करते हैं।

आगे क्या

प्रीलैंडिंग पर SDK

SDK जोड़ें और सीधे इंस्टॉल करें।

पुश कैंपेन

सब्सक्राइबर को नोटिफ़िकेशन भेजना।

sql के लिए टेबल

SDK इवेंट डेटा में कहाँ दिखते हैं।