Browser SDK Referenz

Eine Referenz für das Browser SDK, window.sdk: wie Sie eine PWA-Installation von der Seite anbieten, den Besucher für Push abonnieren, Events senden und welche Einstellungen dafür benötigt werden. Eine allgemeine Einführung finden Sie unter Browser SDK; zur Einbindung in Ihre eigene Vorlandingpage siehe SDK auf Ihrer Vorlandingpage.

Die window.pwaConfig Einstellungen

Das SDK liest seine Einstellungen aus dem window.pwaConfig-Objekt, das Sie auf der Seite vor dem Script-Tag setzen. Auf von Qubix ausgelieferten Seiten wird das Objekt automatisch befüllt; auf Ihrer eigenen Vorlandingpage setzen Sie es selbst.

Feld	Zweck
pwaId	Die PWA-Kennung. Erforderlich für Installation und Push
domain	Die Domain der Seite. Erforderlich für das Manifest und für Push
vapidKey	Der Schlüssel für Push. Wird beim Laden von /sdk.js in der Regel automatisch eingebettet — kein manuelles Setzen erforderlich
offerId	Das Angebot (falls Sie es explizit übergeben müssen)
campaignId	Die Kampagne (falls Sie sie explizit übergeben müssen)
params	Zusätzliche Tracking-Tags
previewMode	Vorschaumodus: Events werden nicht gesendet

Die PWA-Kennung (pwaId) wird aus der App-Karte im Bereich PWA Apps entnommen.

Push abonnieren

sdk.subscribePush() fordert die Benachrichtigungsberechtigung vom Browser an und erstellt ein Abonnement. Sie müssen es explizit aufrufen — zum Beispiel bei einem Button-Klick. Es wird nicht von selbst ausgelöst.

JavaScript

const subscription = await sdk.subscribePush()
if (subscription) {
  // der Besucher hat Benachrichtigungen erlaubt und ist abonniert
}

Was dabei passiert:

1. Die Berechtigungsabfrage des Browsers wird angezeigt.
2. Wenn der Besucher zustimmt, wird ein Abonnement erstellt und an Qubix übermittelt.
3. Wiederholte Aufrufe sind sicher: Wenn der Besucher bereits abonniert ist, wird die Abfrage nicht erneut angezeigt.

Die App-Installation ist für Push nicht erforderlich — ein Besucher kann sich auf einer gewöhnlichen Seite abonnieren.

hinweis

Push funktioniert nur über eine sichere Verbindung (HTTPS) und auf einer Domain, die in Qubix eingerichtet ist. Mehr dazu unter SDK auf Ihrer Vorlandingpage.

PWA installieren

Wenn window.pwaConfig eine pwaId enthält, stellt das SDK die sdk.pwa-Methoden bereit:

Methode	Was sie bewirkt
sdk.pwa.init()	Vorbereitung: registriert den Service Worker und fügt das App-Manifest hinzu
sdk.pwa.install()	Zeigt die systemseitige App-Installationsaufforderung an
sdk.pwa.canInstall()	Ob die Installation gerade verfügbar ist
sdk.pwa.isInstalled()	Ob die App bereits installiert ist
sdk.pwa.open()	Öffnet die installierte App

init, install und isInstalled sind asynchron — rufen Sie diese mit await auf. canInstall und open geben einen Wert sofort zurück.

JavaScript

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

Die Installationsaufforderung wird vom Browser selbst angezeigt, daher gelten dessen Regeln: HTTPS, ein eingebundenes Manifest (das SDK bindet es für Sie ein) und in der Regel eine Aktion des Besuchers auf der Seite (ein Klick, ein Scrollen). Deshalb wird der Installationsbutton normalerweise an einen expliziten Tap gebunden.

Events

Das SDK meldet wichtige Momente selbstständig an die Analyse — sie sind in Berichten und im Event-Stream sichtbar:

Event	Wann
campaign_visit	Ein Besuch der Seite (wird automatisch gesendet)
push_prompt_shown	Die Push-Berechtigungsabfrage wurde angezeigt
push_allow	Der Besucher hat Push erlaubt
push_deny	Der Besucher hat Push abgelehnt
push_ignored	Der Besucher hat die Abfrage ohne Auswahl geschlossen
install_accepted	Der Besucher hat der App-Installation zugestimmt
install_rejected	Der Besucher hat die Installation abgelehnt

Sie können manuell ein eigenes Event senden:

JavaScript

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

Traffic-Daten

Hilfsmethoden zum Lesen des Klick-Kontexts:

Methode	Gibt zurück
sdk.getOffer()	Das aktuelle Angebot (ID und URL)
sdk.getPwa()	Die aktuelle PWA
sdk.getPiuid()	Die Besucher-ID
sdk.getTrackingParams()	Die Tracker-Tags, die mit dem Klick übermittelt wurden
sdk.buildOfferUrl(url)	Erstellt eine Angebots-URL mit den übertragenen Tags
sdk.showStore()	Zur PWA-Store-Karte wechseln

Was das SDK selbstständig erledigt

Ohne Aufrufe Ihrerseits erfasst das SDK beim Seitenaufruf Gerätedaten, parst die Tracking-Tags aus der URL, fügt das App-Manifest hinzu (sofern pwaId gesetzt ist) und sendet das campaign_visit-Event. Installation und Push-Abonnement starten nicht von selbst — Sie lösen diese aus dem Code heraus aus.

Nächste Schritte

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.