Browser SDK reference

เอกสารอ้างอิงสำหรับ Browser SDK คือ window.sdk: วิธีเสนอการติดตั้ง PWA จากหน้าเว็บ, สมัครให้ผู้เข้าชมรับ push, ส่งอีเวนต์ และการตั้งค่าที่จำเป็น สำหรับภาพรวมเบื้องต้น ดูที่ Browser SDK; สำหรับการเชื่อมต่อกับหน้า prelanding ของคุณเอง ดูที่ SDK on your prelanding.

การตั้งค่า window.pwaConfig

SDK อ่านการตั้งค่าจากออบเจกต์ window.pwaConfig ซึ่งคุณกำหนดไว้ในหน้าเว็บ ก่อน แท็ก script สำหรับหน้าที่ให้บริการโดย Qubix ออบเจกต์นี้จะถูกกรอกโดยอัตโนมัติ; บนหน้า prelanding ของคุณเอง คุณต้องกำหนดค่าเอง

ฟิลด์	วัตถุประสงค์
pwaId	ตัวระบุ PWA จำเป็นสำหรับการติดตั้งและ push
domain	โดเมนของหน้าเว็บ จำเป็นสำหรับ manifest และ push
vapidKey	คีย์สำหรับ push โดยปกติจะถูกฝังโดยอัตโนมัติเมื่อโหลด /sdk.js — ไม่จำเป็นต้องกำหนดด้วยตนเอง
offerId	ออฟเฟอร์ (หากต้องการส่งอย่างชัดเจน)
campaignId	แคมเปญ (หากต้องการส่งอย่างชัดเจน)
params	แท็กการติดตามเพิ่มเติม
previewMode	โหมดพรีวิว: อีเวนต์จะไม่ถูกส่ง

ตัวระบุ PWA (pwaId) นำมาจากการ์ดแอปในส่วน PWA Apps

สมัครรับ push

sdk.subscribePush() ขอสิทธิ์การแจ้งเตือนจากเบราว์เซอร์และสร้างการสมัครสมาชิก คุณต้องเรียกใช้ อย่างชัดเจน — เช่น เมื่อผู้ใช้คลิกปุ่ม โดยจะไม่ทำงานเองโดยอัตโนมัติ

JavaScript

const subscription = await sdk.subscribePush()
if (subscription) {
  // ผู้เข้าชมอนุญาตการแจ้งเตือนและสมัครสมาชิกแล้ว
}

สิ่งที่เกิดขึ้นภายใน:

1. เบราว์เซอร์แสดงกล่องขอสิทธิ์การแจ้งเตือน
2. หากผู้เข้าชมอนุญาต การสมัครสมาชิกจะถูกสร้างและส่งไปยัง Qubix
3. การเรียกซ้ำปลอดภัย: หากผู้เข้าชมสมัครสมาชิกแล้ว กล่องขอสิทธิ์จะไม่แสดงอีก

ไม่จำเป็นต้องติดตั้งแอปเพื่อรับ push — ผู้เข้าชมสามารถสมัครสมาชิกจากหน้าเว็บธรรมดาได้

note

Push ใช้งานได้เฉพาะผ่านการเชื่อมต่อที่ปลอดภัย (HTTPS) และบนโดเมนที่ตั้งค่าใน Qubix เพิ่มเติมได้ที่ SDK on your prelanding.

ติดตั้ง PWA

หาก window.pwaConfig มี pwaId SDK จะเปิดเผยเมธอด sdk.pwa:

เมธอด	การทำงาน
sdk.pwa.init()	การเตรียมการ: ลงทะเบียน service worker และแนบ manifest ของแอป
sdk.pwa.install()	แสดงกล่องติดตั้งแอปของระบบ
sdk.pwa.canInstall()	ตรวจสอบว่าสามารถติดตั้งได้ในขณะนี้หรือไม่
sdk.pwa.isInstalled()	ตรวจสอบว่าแอปได้รับการติดตั้งแล้วหรือไม่
sdk.pwa.open()	เปิดแอปที่ติดตั้งแล้ว

init, install และ isInstalled เป็น asynchronous — เรียกใช้ด้วย await ส่วน canInstall และ open คืนค่าทันที

JavaScript

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

กล่องติดตั้งจะแสดงโดยเบราว์เซอร์เอง ดังนั้นกฎของเบราว์เซอร์จะใช้บังคับ ได้แก่: HTTPS, manifest ที่แนบแล้ว (SDK แนบให้คุณ) และโดยทั่วไปต้องมีการกระทำของผู้เข้าชมบนหน้าเว็บ (การคลิก, การเลื่อน) นั่นคือเหตุผลที่ปุ่มติดตั้งมักผูกกับการแตะอย่างชัดเจน

อีเวนต์

SDK รายงานช่วงเวลาสำคัญไปยังระบบวิเคราะห์โดยอัตโนมัติ — ปรากฏในรายงานและใน event stream:

อีเวนต์	เมื่อไหร่
campaign_visit	การเข้าชมหน้าเว็บ (ส่งโดยอัตโนมัติ)
push_prompt_shown	กล่องขอสิทธิ์ push ถูกแสดง
push_allow	ผู้เข้าชมอนุญาต push
push_deny	ผู้เข้าชมปฏิเสธ push
push_ignored	ผู้เข้าชมปิดกล่องโดยไม่เลือก
install_accepted	ผู้เข้าชมยอมรับการติดตั้งแอป
install_rejected	ผู้เข้าชมปฏิเสธการติดตั้ง

คุณสามารถส่งอีเวนต์ของคุณเองได้ด้วยตนเอง:

JavaScript

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

ข้อมูลการรับส่งทราฟฟิก

เมธอดช่วยเหลือสำหรับอ่านบริบทของคลิก:

เมธอด	คืนค่า
sdk.getOffer()	ออฟเฟอร์ปัจจุบัน (id และ URL)
sdk.getPwa()	PWA ปัจจุบัน
sdk.getPiuid()	รหัสผู้เข้าชม
sdk.getTrackingParams()	แท็กของ tracker ที่มาพร้อมกับคลิก
sdk.buildOfferUrl(url)	สร้าง URL ออฟเฟอร์พร้อมแท็กที่พ่วงมา
sdk.showStore()	ไปยังการ์ดร้านค้า PWA

สิ่งที่ SDK ทำโดยอัตโนมัติ

โดยไม่ต้องเรียกใช้จากฝั่งคุณ เมื่อโหลดหน้าเว็บ SDK จะเก็บข้อมูลอุปกรณ์, แยกวิเคราะห์แท็กการติดตามจาก URL, แนบ manifest ของแอป (หาก pwaId ถูกกำหนด) และส่งอีเวนต์ campaign_visit การติดตั้งและการสมัครสมาชิก push จะไม่เริ่มต้นเอง — คุณต้องเรียกใช้จากโค้ด

ขั้นตอนถัดไป

SDK on your prelanding

Connect the SDK and install directly.

Push campaigns

Sending notifications to subscribers.

Tables for sql

Where the SDK events show up in the data.