Passer au contenu principal

​
Aperçu

Ce guide explique comment intégrer les notifications push OneSignal dans une application Vue.js. Il couvre à la fois Vue 2 et Vue 3 en utilisant les plugins Vue officiels de OneSignal, ainsi que les considérations clés de configuration, y compris la configuration du service worker et le support TypeScript.

​
Exigences

​
Compatibilité Vue

Assurez-vous d’installer une version de plugin compatible avec votre environnement Vue.
VuePlugin OneSignal
2onesignal-vue
3onesignal-vue3

​
Installation

Installez via votre gestionnaire de paquets préféré : 
yarn add onesignal-vue
# ou yarn add @onesignal/onesignal-vue3

​
Initialisation

Importez le service OneSignal et initialisez-le dans votre composant racine. La fonction init renvoie une promesse qui se résout lorsque OneSignal est chargé. Remplacez YOUR_APP_ID par votre ID d’application OneSignal trouvé dans Clés et ID. 
import Vue from 'vue'
import OneSignalVue from 'onesignal-vue'

Vue.use(OneSignalVue);

new Vue({
  render: h => h(App),
  beforeMount() {
    this.$OneSignal.init({ appId: 'YOUR_APP_ID' });
  }
}).$mount('#app')
//Exemple 1
await this.$OneSignal.init({ appId: 'YOUR_APP_ID' });
// faire d'autres choses

//Exemple 2
this.$OneSignal.init({ appId: 'YOUR_APP_ID' }).then(() => {
  // faire d'autres choses
});
Le plugin OneSignal expose automatiquement une propriété globale $OneSignal accessible à l’intérieur de l’application.

​
API de composition

Vous pouvez également exploiter l’API de composition de Vue via le hook useOneSignal() qui peut être appelé depuis setup.

​
Personnalisation des options d’initialisation

Vous pouvez personnaliser votre initialisation avec des paramètres init supplémentaires.

​
Paramètres du service worker

Si vous ne l’avez pas encore fait, vous devrez télécharger le fichier Service Worker OneSignal pour l’ajouter à votre site. Le fichier OneSignalSDKWorker.js doit être accessible publiquement. Vous pouvez le placer dans votre répertoire public, à la racine de niveau supérieur ou dans un sous-répertoire. Cependant, si vous placez le fichier dans un sous-répertoire et/ou avez un autre service worker pour votre site, assurez-vous de spécifier le chemin. Voir Service Worker OneSignal pour plus de détails.
OptionDescription
serviceWorkerParamPortée contrôlée par le worker OneSignal. Recommandation : Utilisez un sous-chemin personnalisé (par ex. "/onesignal/").
serviceWorkerPathChemin vers votre fichier service worker OneSignal hébergé (par ex. "onesignal/OneSignalSDKWorker.js"). Doit être accessible publiquement.
Exemple : 
this.$OneSignal.init({
  appId: 'YOUR-ONESIGNAL-APP-ID',
  serviceWorkerParam: {
    scope: '/onesignal/'
  },
  serviceWorkerPath: 'onesignal/OneSignalSDKWorker.js'
});

​
Hébergement du worker

  • Racine publique (par défaut) : /OneSignalSDKWorker.js
  • Dossier personnalisé (recommandé) : par ex. /onesignal/OneSignalSDKWorker.js comme défini à l’étape précédente.

​
Vérifier l’hébergement du service worker

Visitez le chemin dans votre navigateur pour confirmer qu’il est accessible. Si vous avez utilisé la racine : 
https://your-site.com/OneSignalSDKWorker.js
Si vous utilisez l’exemple de chemin : 
https://your-site.com/onesignal/OneSignalSDKWorker.js
Il devrait renvoyer du JavaScript valide.

​
Notes importantes

  • Évitez l’initialisation en double en développement
    • Lors des tests dans un environnement de développement, vous pourriez voir le SDK OneSignal s’initialiser deux fois, ce qui peut provoquer des erreurs de console.
    • Cela se produit en raison de <React.StrictMode> qui fait s’exécuter les effets deux fois en développement. Pour le résoudre, supprimez <React.StrictMode> de votre composant racine pendant le développement.
Le mode strict n’affecte que le développement—il n’impacte pas les builds de production.

​
Tester l’intégration du SDK OneSignal

Ce guide vous aide à vérifier que votre intégration du SDK OneSignal fonctionne correctement en testant les notifications push et l’enregistrement des abonnements.

​
Vérifier les abonnements web push

1

Lancez votre site sur un appareil de test.

  • Utilisez Chrome, Firefox, Edge ou Safari pendant les tests.
  • N’utilisez pas le mode Navigation privée ou Incognito. Les utilisateurs ne peuvent pas s’abonner aux notifications push dans ces modes.
  • Les invites devraient apparaître en fonction de votre configuration des invites de permission.
  • Cliquez sur Autoriser dans l’invite native pour vous abonner aux notifications push.
2

Vérifiez votre tableau de bord OneSignal

Vérifiez le tableau de bord OneSignal :
  • Allez dans Audience > Subscriptions.
  • Vous devriez voir une nouvelle entrée avec le statut Subscribed.
Vous avez créé avec succès un abonnement web push. Les abonnements web push sont créés lorsque les utilisateurs s’abonnent pour la première fois aux notifications push sur votre site.

​
Configurer les abonnements de test

Les abonnements de test sont utiles pour tester une notification push avant d’envoyer un message.
1

Ajouter aux abonnements de test.

Dans le tableau de bord, à côté de l’abonnement, cliquez sur le bouton Options (trois points) et sélectionnez Add to Test Subscriptions.
2

Nommez votre abonnement.

Nommez l’abonnement afin de pouvoir identifier facilement votre appareil plus tard dans l’onglet Test Subscriptions.
3

Créer un segment d'utilisateurs de test.

Allez dans Audience > Segments > New Segment.
4

Nommez le segment.

Nommez le segment Test Users (le nom est important car il sera utilisé plus tard).
5

Ajoutez le filtre Test Users et cliquez sur Create Segment.

Vous avez créé avec succès un segment d’utilisateurs de test. Nous pouvons maintenant tester l’envoi de messages à cet appareil individuel et à des groupes d’utilisateurs de test.

​
Envoyer un push de test via l’API

1

Obtenez votre clé API d'application et votre ID d'application.

Dans votre tableau de bord OneSignal, allez dans Settings > Keys & IDs.
2

Mettez à jour le code fourni.

Remplacez YOUR_APP_API_KEY et YOUR_APP_ID dans le code ci-dessous par vos clés réelles. Ce code utilise le segment Test Users que nous avons créé plus tôt.
curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "chrome_web_image": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'
3

Exécutez le code.

Exécutez le code dans votre terminal.
4

Vérifiez les images et la livraison confirmée.

Si toutes les étapes de configuration ont été complétées avec succès, les abonnements de test devraient recevoir une notification.
Seul Chrome prend en charge les images. Les images apparaîtront petites dans la vue de notification réduite. Développez la notification pour voir l’image complète.
5

Vérifiez la livraison confirmée.

Dans votre tableau de bord, allez dans Delivery > Sent Messages, puis cliquez sur le message pour afficher les statistiques.Vous devriez voir la statistique confirmed, ce qui signifie que l’appareil a reçu la push.
Safari ne prend pas en charge la Livraison confirmée.
Si vous avez un forfait Professional ou supérieur, faites défiler jusqu’à Audience Activity pour voir la confirmation au niveau de l’abonnement :
Vous avez envoyé avec succès une notification via notre API à un segment.
Besoin d’aide ? Contactez support@onesignal.com avec les informations suivantes :
  • Copiez-collez la requête et la réponse API dans un fichier .txt
  • Votre Subscription ID
  • L’URL de votre site Web avec le code OneSignal
Nous serons ravis de vous aider !

​
Identification des utilisateurs

Précédemment, nous avons démontré comment créer des Abonnements web push. Nous allons maintenant étendre l’identification des Utilisateurs sur tous leurs abonnements (y compris push, email et SMS) en utilisant le SDK OneSignal. Nous couvrirons les External IDs, les tags, les abonnements multicanaux, la confidentialité et le suivi des événements pour vous aider à unifier et engager les utilisateurs sur toutes les plateformes.

​
Attribuer un External ID

Utilisez un External ID pour identifier les utilisateurs de manière cohérente sur tous les appareils, adresses e-mail et numéros de téléphone en utilisant l’identifiant utilisateur de votre backend. Cela garantit que votre messagerie reste unifiée sur tous les canaux et systèmes tiers (particulièrement important pour les Intégrations). Définissez l’External ID avec la méthode login de notre SDK chaque fois qu’ils sont identifiés par votre application.
OneSignal génère des ID uniques en lecture seule pour les abonnements (Subscription ID) et les utilisateurs (OneSignal ID).Lorsque les utilisateurs téléchargent votre application sur différents appareils, s’abonnent à votre site Web et/ou vous fournissent des adresses e-mail et des numéros de téléphone en dehors de votre application, de nouveaux abonnements seront créés.La définition de l’External ID via notre SDK est fortement recommandée pour identifier les utilisateurs sur tous leurs abonnements, quelle que soit la façon dont ils sont créés.

​
Ajouter des tags de données

Les Tags sont des paires clé-valeur de données chaîne que vous pouvez utiliser pour stocker les propriétés des utilisateurs (comme username, role ou les préférences) et les événements (comme purchase_date, game_level ou les interactions utilisateur). Les tags alimentent la Personnalisation des messages et la Segmentation avancées permettant des cas d’utilisation plus avancés. Définissez les tags avec les méthodes addTag et addTags de notre SDK au fur et à mesure que les événements se produisent dans votre application. Dans cet exemple, l’utilisateur a atteint le niveau 6 identifiable par le tag appelé current_level défini sur une valeur de 6.
Nous pouvons créer un segment d’utilisateurs ayant un niveau entre 5 et 10, et l’utiliser pour envoyer des messages ciblés et personnalisés :

​
Ajouter des abonnements email et/ou SMS

Plus tôt, nous avons vu comment notre SDK crée des abonnements web push pour envoyer des push. Vous pouvez également atteindre les utilisateurs via les canaux email et SMS en créant les abonnements correspondants. Si l’adresse e-mail et/ou le numéro de téléphone existent déjà dans l’application OneSignal, le SDK l’ajoutera à l’utilisateur existant, il ne créera pas de doublons. Vous pouvez afficher les utilisateurs unifiés via Audience > Users dans le tableau de bord ou avec l’API View user.
Meilleures pratiques pour la communication multicanale
  • Obtenez un consentement explicite avant d’ajouter des abonnements email ou SMS.
  • Expliquez les avantages de chaque canal de communication aux utilisateurs.
  • Fournissez des préférences de canal afin que les utilisateurs puissent sélectionner les canaux qu’ils préfèrent.

​
Confidentialité et consentement de l’utilisateur

Pour contrôler quand OneSignal collecte les données utilisateur, utilisez les méthodes de contrôle du consentement du SDK : Consultez nos documents sur la confidentialité et la sécurité pour en savoir plus sur :

​
Écouter les événements push, utilisateur et in-app

Utilisez les écouteurs du SDK pour réagir aux actions des utilisateurs et aux changements d’état. Le SDK fournit plusieurs écouteurs d’événements auxquels vous pouvez vous connecter. Consultez notre guide de référence du SDK pour plus de détails.

​
Événements de notification push

​
Changements d’état de l’utilisateur

​
Configuration avancée et capacités

Explorez davantage de capacités pour améliorer votre intégration :

​
Configuration et référence du SDK Web

Assurez-vous d’avoir activé toutes les fonctionnalités clés en consultant le guide Configuration web push. Pour tous les détails sur les méthodes disponibles et les options de configuration, visitez la référence du SDK Web.
Félicitations ! Vous avez terminé avec succès le guide de configuration du SDK Web.
Besoin d’aide ?Discutez avec notre équipe d’assistance ou envoyez un e-mail à support@onesignal.comVeuillez inclure :
  • Les détails du problème que vous rencontrez et les étapes de reproduction si disponibles
  • Votre OneSignal App ID
  • L’External ID ou le Subscription ID le cas échéant
  • L’URL du message que vous avez testé dans le OneSignal Dashboard le cas échéant
  • Tous les journaux ou messages d’erreur pertinents
Nous serons ravis de vous aider !