Guide d'intégration de base du SDK Cordova
Cette section contient des informations sur la manière d’intégrer le SDK Cordova de Pushwoosh dans votre application.
Prérequis
Anchor link toPour intégrer le SDK Cordova de Pushwoosh dans votre application, vous aurez besoin des éléments suivants :
Étapes d’intégration
Anchor link to1. Ajouter la dépendance du SDK Cordova de Pushwoosh
Anchor link toAjoutez la dépendance du SDK Cordova de Pushwoosh à votre projet :
cordova plugin add pushwoosh-cordova-plugin
2. Initialisation du SDK Cordova
Anchor link toDans le composant racine de votre fichier index.js
:
- Initialisez le SDK Pushwoosh.
- Appelez
registerDevice()
dans votre logique d’initialisation pour vous inscrire aux notifications push.
function onDeviceReady() { var pushwoosh = cordova.require("pushwoosh-cordova-plugin.PushNotification");
pushwoosh.onDeviceReady({ appid: "__VOTRE_ID_APPLICATION__", projectid: "__VOTRE_ID_EXPÉDITEUR_FCM__" });
pushwoosh.registerDevice( function(status) { var pushToken = status.pushToken; // Gérer l'enregistrement réussi }, function(status) { // Gérer l'erreur d'enregistrement });
Où :
__VOTRE_ID_APPLICATION__
est le code d’application du Panneau de Contrôle Pushwoosh.__VOTRE_ID_EXPÉDITEUR_FCM__
est le numéro de projet Firebase de la console Firebase.
3. Configuration native iOS
Anchor link to3.1 Capacités
Anchor link toPour activer les notifications push dans votre projet, vous devez ajouter certaines capacités.
Dans la section Signature et Capacités, ajoutez les capacités suivantes :
Notifications Push
Modes d'arrière-plan
. Après avoir ajouté cette capacité, cochez la caseNotifications à distance
.
Si vous avez l’intention d’utiliser les notifications urgentes (iOS 15+), ajoutez également la capacité Notifications urgentes
.
3.2 Info.plist
Anchor link toDans votre fichier Runner/Info.plist
, définissez la clé __PUSHWOOSH_DEVICE_API_TOKEN__
avec le Jeton d’API de l’appareil Pushwoosh :
<key>Pushwoosh_API_TOKEN</key><string>__PUSHWOOSH_DEVICE_API_TOKEN__</string>
3.3 Suivi de la livraison des messages
Anchor link toVous devez ajouter une cible d’extension de service de notification à votre projet. Ceci est essentiel pour un suivi précis de la livraison et pour des fonctionnalités comme le Rich Media sur iOS.
Suivez les étapes du guide natif pour ajouter la cible d’extension et le code Pushwoosh nécessaire à l’intérieur.
4. Configuration native Android
Anchor link to4.1 Installer les dépendances
Anchor link toAssurez-vous que les dépendances et les plugins requis sont ajoutés à vos scripts Gradle :
Ajoutez le plugin Gradle des services Google aux dépendances de votre build.gradle
au niveau du projet :
buildscript { dependencies { classpath 'com.google.gms:google-services:4.3.15' }}
Appliquez le plugin dans votre fichier build.gradle
au niveau de l’application :
apply plugin: 'com.google.gms.google-services'
4.2 Ajouter le fichier de configuration Firebase
Anchor link toPlacez le fichier google-services.json
dans le dossier android/app
de votre répertoire de projet.
4.3 Ajouter les métadonnées Pushwoosh
Anchor link toDans votre main/AndroidManifest.xml
, ajoutez le Jeton d’API de l’appareil Pushwoosh à l’intérieur de la balise <application>
:
<meta-data android:name="com.pushwoosh.apitoken" android:value="__VOTRE_JETON_API_APPAREIL__" />
Important : Assurez-vous de donner au jeton l’accès à la bonne application dans votre Panneau de Contrôle Pushwoosh. En savoir plus
5. Exécuter le projet
Anchor link to- Compilez et exécutez le projet.
- Allez dans le Panneau de Contrôle Pushwoosh et envoyez une notification push.
- Vous devriez voir la notification dans l’application.
Intégration étendue
Anchor link toÀ ce stade, vous avez déjà intégré le SDK et pouvez envoyer et recevoir des notifications push. Explorons maintenant les fonctionnalités principales.
Écouteurs d’événements de notification push
Anchor link toDans le SDK Pushwoosh, il y a deux écouteurs d’événements, conçus pour gérer les notifications push :
- L’événement
onPushReceived
est déclenché lorsqu’une notification push est reçue - L’événement
onPushAccepted
est déclenché lorsqu’un utilisateur ouvre une notification
Vous devez configurer ces écouteurs d’événements juste après l’initialisation du SDK au démarrage de l’application :
class PushwooshNotificationHandler { setupPushListeners() {
document.addEventListener('push-receive', function(event) { console.log("Push received: " + event.notification.message); } );
document.addEventListener('push-notification', function(event) { console.log("Push accepted: " + event.notification.message); } ); }}
Configuration de l’utilisateur
Anchor link toEn vous concentrant sur le comportement et les préférences de chaque utilisateur, vous pouvez fournir un contenu personnalisé, ce qui augmente la satisfaction et la fidélité des utilisateurs.
class Registration { afterUserLogin(user) {
// Définir l'ID utilisateur pushwoosh.setUserId(user.getId());
// Définir des informations utilisateur supplémentaires comme des tags pour Pushwoosh pushwoosh.setTags({ "age": user.getAge(), "name": user.getName(), "last_login": user.getLastLoginDate() }); }}
Tags
Anchor link toLes tags sont des paires clé-valeur assignées aux utilisateurs ou aux appareils, permettant une segmentation basée sur des attributs tels que les préférences ou le comportement, ce qui rend possible la messagerie ciblée.
class UpdateUser { afterUserUpdateProfile(user) {
// Définir la liste des catégories favorites pushwoosh.setTags({ "favorite_categories": user.getFavoriteCategoriesList() });
// Définir les informations de paiement pushwoosh.setTags({ "is_subscribed": user.isSubscribed(), "payment_status": user.getPaymentStatus(), "billing_address": user.getBillingAddress() }); }}
Événements
Anchor link toLes événements sont des actions ou des occurrences spécifiques de l’utilisateur au sein de l’application qui peuvent être suivies pour analyser le comportement et déclencher des messages ou des actions correspondantes.
class Registration {
// Suivre l'événement de connexion afterUserLogin(user) { pushwoosh.postEvent("login", { "name": user.getName(), "last_login": user.getLastLoginDate() }); }
// Suivre l'événement d'achat afterUserPurchase(product) { pushwoosh.postEvent("purchase", { "product_id": product.getId(), "product_name": product.getName(), "price": product.getPrice(), "quantity": product.getQuantity() }); }}
Dépannage
Anchor link toSi vous rencontrez des problèmes pendant le processus d’intégration, veuillez vous référer à la section support et communauté.