Browser SDK referansı

Browser SDK'nın, yani window.sdk'nın referans belgesidir: sayfadan PWA kurulum teklifi sunma, ziyaretçiyi push bildirimlerine abone etme, etkinlik gönderme ve bunların gerektirdiği ayarlar. Genel bir giriş için Browser SDK sayfasına; kendi ön sayfanıza bağlamak için Kendi ön sayfanızda SDK sayfasına bakın.

window.pwaConfig ayarları

SDK, ayarlarını sayfada script etiketinden önce tanımladığınız window.pwaConfig nesnesinden okur. Qubix tarafından sunulan sayfalarda bu nesne otomatik olarak doldurulur; kendi ön sayfanızda ise bunu kendiniz ayarlarsınız.

Alan	Amaç
pwaId	PWA tanımlayıcısı. Kurulum ve push için zorunludur
domain	Sayfanın alan adı. Manifest ve push için zorunludur
vapidKey	Push için anahtar. /sdk.js yüklendiğinde genellikle otomatik olarak eklenir — elle ayarlamaya gerek yoktur
offerId	Teklif (açıkça geçirmeniz gerekiyorsa)
campaignId	Kampanya (açıkça geçirmeniz gerekiyorsa)
params	Ek izleme etiketleri
previewMode	Önizleme modu: etkinlikler gönderilmez

PWA tanımlayıcısı (pwaId), PWA Uygulamaları bölümündeki uygulama kartından alınır.

Push bildirimine abone olma

sdk.subscribePush(), tarayıcıdan bildirim izni ister ve bir abonelik oluşturur. Bu yöntemi açıkça çağırmanız gerekir — örneğin bir düğmeye tıklandığında. Kendiliğinden tetiklenmez.

JavaScript

const subscription = await sdk.subscribePush()
if (subscription) {
  // ziyaretçi bildirimlere izin verdi ve abone oldu
}

Arka planda neler olur:

1. Tarayıcının izin istemi gösterilir.
2. Ziyaretçi izin verirse bir abonelik oluşturulur ve Qubix'e gönderilir.
3. Tekrar çağrılar güvenlidir: ziyaretçi zaten abone ise istem tekrar gösterilmez.

Push için uygulamanın kurulu olması gerekmez — ziyaretçi sıradan bir sayfada da abone olabilir.

Push yalnızca güvenli bir bağlantı (HTTPS) üzerinden ve Qubix'te yapılandırılmış bir alan adında çalışır. Daha fazla bilgi için Kendi ön sayfanızda SDK sayfasına bakın.

PWA kurulumu

window.pwaConfig içinde pwaId varsa SDK, sdk.pwa yöntemlerini sunar:

Yöntem	Ne yapar
sdk.pwa.init()	Hazırlık: service worker'ı kaydeder ve uygulama manifestini ekler
sdk.pwa.install()	Sistemin uygulama kurulum istemini gösterir
sdk.pwa.canInstall()	Kurulumun şu an kullanılabilir olup olmadığı
sdk.pwa.isInstalled()	Uygulamanın zaten kurulu olup olmadığı
sdk.pwa.open()	Kurulu uygulamayı açar

init, install ve isInstalled zaman uyumsuz çalışır — await ile çağırın. canInstall ve open değeri anında döndürür.

JavaScript

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

Kurulum istemi tarayıcının kendisi tarafından gösterilir, dolayısıyla tarayıcının kuralları geçerlidir: HTTPS, eklenmiş bir manifest (SDK bunu sizin için ekler) ve genellikle sayfada ziyaretçi tarafından gerçekleştirilen bir eylem (tıklama, kaydırma). Bu nedenle kurulum düğmesi normalde açık bir dokunuşa bağlanır.

Etkinlikler

SDK, temel anları otomatik olarak analizlere bildirir — bunlar raporlarda ve etkinlik akışında görünür:

Etkinlik	Ne zaman
campaign_visit	Sayfaya ziyaret (otomatik olarak gönderilir)
push_prompt_shown	Push izin istemi gösterildi
push_allow	Ziyaretçi push iznine onay verdi
push_deny	Ziyaretçi push iznini reddetti
push_ignored	Ziyaretçi bir seçim yapmadan istemi kapattı
install_accepted	Ziyaretçi uygulamayı kurmayı kabul etti
install_rejected	Ziyaretçi kurulumu reddetti

Kendi etkinliğinizi manuel olarak gönderebilirsiniz:

JavaScript

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

Trafik verileri

Tıklama bağlamını okumak için yardımcı yöntemler:

Yöntem	Döndürdüğü değer
sdk.getOffer()	Mevcut teklif (id ve URL)
sdk.getPwa()	Mevcut PWA
sdk.getPiuid()	Ziyaretçi kimliği
sdk.getTrackingParams()	Tıklamayla gelen izleyici etiketleri
sdk.buildOfferUrl(url)	Etiketleri taşıyarak teklif URL'si oluşturur
sdk.showStore()	PWA mağaza kartına gider

SDK'nın kendiliğinden yaptıkları

Tarafınızdan herhangi bir çağrı yapılmaksızın, sayfa yüklendiğinde SDK cihaz verilerini toplar, URL'deki izleme etiketlerini ayrıştırır, uygulama manifestini ekler (pwaId ayarlıysa) ve campaign_visit etkinliğini gönderir. Kurulum ve push aboneliği kendiliğinden başlamaz — bunları koddan siz tetiklersiniz.

Sırada ne var

Kendi ön sayfanızda SDK

SDK'yı bağlayın ve doğrudan kurulum yapın.

Push kampanyaları

Abonelere bildirim gönderme.

SQL için tablolar

SDK etkinliklerinin veride nerede göründüğü.