Référence du Browser SDK
Référence du Browser SDK, window.sdk : comment proposer l'installation d'une PWA depuis la page,
abonner le visiteur aux notifications push, envoyer des événements, et quels paramètres sont nécessaires. Pour une
introduction générale, voir Browser SDK ; pour l'intégrer à votre propre prélanding, voir
SDK sur votre prélanding.
Les paramètres window.pwaConfig
Le SDK lit ses paramètres dans l'objet window.pwaConfig, que vous définissez sur la page
avant la balise script. Sur les pages servies par Qubix, l'objet est rempli automatiquement ;
sur votre propre prélanding, vous le définissez vous-même.
| Champ | Rôle |
|---|---|
pwaId | L'identifiant de la PWA. Requis pour l'installation et pour les push |
domain | Le domaine de la page. Requis pour le manifeste et pour les push |
vapidKey | La clé pour les push. Généralement intégrée automatiquement au chargement de /sdk.js — inutile de la définir manuellement |
offerId | L'offre (si vous avez besoin de la transmettre explicitement) |
campaignId | La campagne (si vous avez besoin de la transmettre explicitement) |
params | Balises de suivi supplémentaires |
previewMode | Mode aperçu : les événements ne sont pas envoyés |
L'identifiant de la PWA (pwaId) est récupéré depuis la fiche application dans la section
PWA Apps.
S'abonner aux push
sdk.subscribePush() demande au navigateur l'autorisation d'envoyer des notifications et crée un
abonnement. Vous devez l'appeler explicitement — par exemple, au clic sur un bouton. Il ne se
déclenche pas de lui-même.
const subscription = await sdk.subscribePush()
if (subscription) {
// le visiteur a autorisé les notifications et est abonné
}
Ce qui se passe en coulisses :
- La demande de permission du navigateur s'affiche.
- Si le visiteur l'accepte, un abonnement est créé et transmis à Qubix.
- Les appels répétés sont sans danger : si le visiteur est déjà abonné, la demande ne s'affiche pas à nouveau.
L'installation de l'application n'est pas requise pour les push — un visiteur peut s'abonner sur une page ordinaire.
Les push ne fonctionnent que sur une connexion sécurisée (HTTPS) et sur un domaine configuré dans Qubix. Pour en savoir plus, consultez SDK sur votre prélanding.
Installer la PWA
Si window.pwaConfig contient un pwaId, le SDK expose les méthodes sdk.pwa :
| Méthode | Ce qu'elle fait |
|---|---|
sdk.pwa.init() | Préparation : enregistre le service worker et attache le manifeste de l'application |
sdk.pwa.install() | Affiche la boîte de dialogue système d'installation de l'application |
sdk.pwa.canInstall() | Indique si l'installation est disponible en ce moment |
sdk.pwa.isInstalled() | Indique si l'application est déjà installée |
sdk.pwa.open() | Ouvre l'application installée |
init, install et isInstalled sont asynchrones — appelez-les avec await. canInstall et open retournent une valeur immédiatement.
if (sdk.pwa && sdk.pwa.canInstall()) {
await sdk.pwa.install()
}
La boîte de dialogue d'installation est affichée par le navigateur lui-même, ses règles s'appliquent donc : HTTPS, un manifeste attaché (le SDK s'en charge pour vous), et généralement une action du visiteur sur la page (un clic, un défilement). C'est pourquoi le bouton d'installation est normalement lié à un tap explicite.
Événements
Le SDK signale automatiquement les moments clés à l'analytique — ils sont visibles dans les rapports et dans le flux d'événements :
| Événement | Quand |
|---|---|
campaign_visit | Une visite sur la page (envoyé automatiquement) |
push_prompt_shown | La demande de permission push a été affichée |
push_allow | Le visiteur a autorisé les push |
push_deny | Le visiteur a refusé les push |
push_ignored | Le visiteur a ignoré la demande sans choisir |
install_accepted | Le visiteur a accepté d'installer l'application |
install_rejected | Le visiteur a refusé l'installation |
Vous pouvez envoyer votre propre événement manuellement :
sdk.sendEvent('my_button_click', { place: 'hero' })
Données de trafic
Méthodes utilitaires pour lire le contexte du clic :
| Méthode | Retourne |
|---|---|
sdk.getOffer() | L'offre courante (identifiant et URL) |
sdk.getPwa() | La PWA courante |
sdk.getPiuid() | L'identifiant du visiteur |
sdk.getTrackingParams() | Les balises du tracker transmises avec le clic |
sdk.buildOfferUrl(url) | Construit une URL d'offre avec les balises reportées |
sdk.showStore() | Accède à la fiche de la PWA dans le store |
Ce que le SDK fait de lui-même
Sans aucun appel de votre part, au chargement de la page le SDK collecte les données de l'appareil, analyse les
balises de suivi depuis l'URL, attache le manifeste de l'application (si pwaId est défini) et envoie l'événement
campaign_visit. L'installation et l'abonnement push ne démarrent pas d'eux-mêmes — vous les déclenchez depuis votre code.