Skip to main content

Aperçu

Ce guide explique comment intégrer les notifications push OneSignal dans une application Unity distribuée sur le Huawei AppGallery. Suivez ces instructions uniquement si votre application est distribuée sur le Huawei AppGallery.

Prérequis

  • Android Studio
  • Un appareil Huawei avec “Huawei App Gallery” installé
  • Application et plateforme OneSignal configurées

Configurer votre application OneSignal et votre plateforme

Configuration requise pour les notifications push Pour commencer à envoyer des notifications push avec OneSignal, vous devez d’abord configurer votre application OneSignal avec toutes les plateformes que vous prenez en charge—Apple (APNs), Google (FCM), Huawei (HMS), et/ou Amazon (ADM).
Si votre organisation possède déjà un compte OneSignal, demandez à être invité avec un rôle administrateur pour configurer l’application. Sinon, inscrivez-vous pour un compte gratuit pour commencer.
Vous pouvez gérer plusieurs plateformes (iOS, Android, Huawei, Amazon, Web) sous une seule application OneSignal.
1

Créer ou sélectionner votre application

  • Pour ajouter des plateformes à une application existante, allez dans Settings > Push & In-App dans le tableau de bord OneSignal.
  • Pour repartir de zéro, cliquez sur New App/Website et suivez les instructions.

L'exemple montre la création d'une nouvelle application.

2

Configurer et activer une plateforme

  • Choisissez un nom clair et reconnaissable pour votre application et votre organisation.
  • Sélectionnez la ou les plateformes que vous souhaitez configurer (iOS, Android, etc.).
  • Cliquez sur Next: Configure Your Platform.

Exemple de configuration de votre première application, organisation et canal OneSignal.

3

Configurer les identifiants de plateforme

Suivez les instructions en fonction de vos plateformes :Cliquez sur Save & Continue après avoir saisi vos identifiants.
4

Choisir le SDK cible

Sélectionnez le SDK qui correspond à votre plateforme de développement (par exemple, iOS, Android, React Native, Unity), puis cliquez sur Save & Continue.

Sélectionnez le SDK que vous utilisez pour accéder à la documentation.

5

Installer le SDK et enregistrer votre App ID

Une fois votre plateforme configurée, votre OneSignal App ID sera affiché. Copiez et enregistrez cet ID—vous en aurez besoin lors de l’installation et de l’initialisation du SDK.Si vous collaborez avec d’autres personnes, utilisez le bouton Invite pour ajouter des développeurs ou des membres de l’équipe, puis cliquez sur Done pour terminer la configuration.

Enregistrez votre App ID et invitez des membres d'équipe supplémentaires.

Une fois terminé, suivez le guide d’installation du SDK pour votre plateforme sélectionnée afin de terminer l’intégration de OneSignal.

Configuration

1. Configuration du SDK OneSignal

Configuration du SDK OneSignal Unity

Suivez le guide de configuration du SDK OneSignal Unity pour implémenter notre SDK dans votre application. Notez que la configuration Firebase/Google n’est pas requise pour les versions d’application publiées sur le Huawei AppGallery.

2. Configuration Huawei

Configuration de la plateforme Huawei sur OneSignal Fichier de configuration Huawei (agconnect-services.json) *Depuis la Liste des projets AppGallery Connect, sélectionnez votre application. *Cliquez sur le bouton “agconnect-services.json” pour télécharger ce fichier.
Placez ce fichier dans Assets/Plugins/Android/OneSignalConfig

3. Génération d’une empreinte de certificat de signature

Vous pouvez ignorer cette étape si vous avez déjà ajouté votre empreinte de certificat SHA-256 au tableau de bord de Huawei pour un autre service Huawei.
Suivez les instructions de Génération d’une empreinte de certificat de signature

4. Ajouter le plugin gradle Huawei et les dépendances

4a.1 Allez dans File -> Build Settings -> Player Settings -> Android -> Publishing Settings et cliquez sous Custom Main Gradle Template. Cela créera un fichier mainTemplate.gradle.
4a.2 Dans mainTemplate.gradle, supprimez le commentaire // GENERATED BY UNITY. REMOVE THIS COMMENT TO PREVENT OVERWRITING WHEN EXPORTING AGAIN
  • Sous dependencies, ajoutez implementation 'com.huawei.hms:push:6.3.0.304'
4a.3 Créez un nouveau fichier nommé Assets/Plugins/Android/settingsTemplate.gradle avec le contenu suivant.
import java.nio.file.Files

// This file contents should be placed at Assets/Plugins/Android/settingsTemplate.gradle
// This works around Unity's 2019.3 bug where their root build.gradle is placing buildscript under allprojects
// On it's own it doesn't create issues however doing so means including a buildscript block in any sub projects
//   such as "unityLibrary" which is generated from the template Assets/Plugins/Android/mainTemplate.gradle does not work.
// It results in a build error of "Configuration with name 'compileClasspath' not found." on a lint task.
// Normally adding "lintOptions { abortOnError false }" bypasses any lint task errors however
//   either due to a bug with the Android Gradle plugin or an order of operations this does seem to be applying in this case.
// Until Unity fixes their root build.gradle we will need to keep using this file to enable any additional Gradle plugins.

static void enableJetifier(Project project) {
    project.ext['android.useAndroidX'] = true
    project.ext['android.enableJetifier'] = true
}

static void addBuildscript(Project project) {
    project.buildscript {
        repositories {
            maven { url 'https://plugins.gradle.org/m2/' } // Gradle Plugin Portal
            maven { url 'http://developer.huawei.com/repo/' }
        }
        dependencies {
            classpath 'com.huawei.agconnect:agcp:1.6.5.300'
        }
    }
}

static void applyPlugins(Project project) {
    // Only apply to the :app project. (Unity calls this :launcher)
    if (project.name != 'launcher')
        return

    project.afterEvaluate {
        it.apply plugin: 'com.huawei.agconnect'
    }
}

static void copyHMSFile(Project project) {
    // Only apply to the :app project. (Unity calls this :launcher)
    if (project.name != 'launcher')
        return

    def newFile = new File("${project.rootDir}/launcher/agconnect-services.json")

    if (newFile.exists())
        return

    def file = new File("${project.rootDir}/unityLibrary/OneSignalConfig/agconnect-services.json")
    Files.copy(file.toPath(), newFile.toPath())
}

gradle.rootProject {
    it.afterEvaluate {
        it.allprojects {
            // Since Unity 2019.3 enabling Jetifier via mainTemplate.gradle is no longer working
            // Enabling it for all gradle projects here.
            enableJetifier(it)

            addBuildscript(it)
            applyPlugins(it)
            copyHMSFile(it)
        }
    }
}

// Per Unity's docs /*/*INCLUDES/*/* should be at the bottom.
// https://docs.unity3d.com/Manual/android-gradle-overview.html

// However it seem to have left out this include line
include ':launcher', ':unityLibrary'
**INCLUDES**
4b.1 Allez dans File -> Build Settings -> Player Settings -> Android -> Publishing Settings et cliquez sous Custom Gradle Template. Cela créera un fichier mainTemplate.gradle.
4b.2 Dans mainTemplate.gradle, supprimez le commentaire // GENERATED BY UNITY. REMOVE THIS COMMENT TO PREVENT OVERWRITING WHEN EXPORTING AGAIN
  • Sous buildscript { repositories }, ajoutez maven { url 'http://developer.huawei.com/repo/' }
  • Sous buildscript { dependencies }, ajoutez classpath 'com.huawei.agconnect:agcp:1.6.5.300'
  • Sous allprojects { repositories }, ajoutez maven { url 'http://developer.huawei.com/repo/' }
Après avoir ajouté ces dépendances, ajoutez sous allprojects {} ce qui suit
allprojects {
  ...
}

task copyReport(type: Copy) {
    from file("$projectDir/OneSignalConfig/agconnect-services.json")
    into file("$projectDir")
}

allprojects {
    afterEvaluate {
        for (def task in it.tasks)
            if (task != rootProject.tasks.copyReport)
                task.dependsOn rootProject.tasks.copyReport
    }
}
Sous dependencies, ajoutez implementation 'com.huawei.hms:push:6.3.0.304'
Au bas du fichier, ajoutez apply plugin: 'com.huawei.agconnect'

Étapes de configuration supplémentaires

Configurer le service de localisation Huawei (optionnel)

Dans mainTemplate.gradle sous dependencies, ajoutez implementation 'com.huawei.hms:location:<HUAWEI HMS VERSION #>
Assurez-vous également d’ajouter la permission de localisation à votre AndroidManifest.xml si vous ne l’avez pas déjà
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>

Dépannage Huawei

Lors des tests, assurez-vous de conserver la méthode OneSignal setLogLevel définie sur VERBOSE. Vérifiez les journaux pour voir les erreurs générées et consultez les Codes d’erreur courants Huawei.
Vous devrez peut-être créer une signature keystore de débogage ou de release (choisissez le bon chemin de build d’application, debug ou release) pour éviter une erreur 6003 lors de l’enregistrement du pushToken Huawei avec le SDK OneSignal. Voir la section “Configure a Signature”
Cela signifie qu’il manque une classe HMS dans l’application qui est nécessaire pour les notifications push. Le simple fait d’avoir com.huawei.hms:push dans le build.gradle empêchera cette erreur spécifique de se produire. Cependant, si vous avez des paramètres Proguard ou R8 agressifs, cela pourrait causer des problèmes. Nous recommandons de désactiver temporairement minifyEnabled si vous l’avez pour voir si c’est la cause du problème.De plus, vous ne devriez pas mélanger les versions majeures d’autres bibliothèques HMS. Commencez par la version 4 ou 5. Assurez-vous de ne pas avoir un mélange de la version 3 à 5, ce qui créera d’autres erreurs
E/OneSignal: HMS ApiException getting Huawei push token!
    com.huawei.hms.common.ApiException: -5: Core error
Vérifiez vos règles Proguard ou R8 pour vous assurer qu’elles sont configurées correctement. Désactivez-les éventuellement temporairement pour voir si c’est lié. Si cela résout le problème après avoir désactivé Proguard ou R8, vous pouvez suivre ce guide et les réactiver. Voir la section “Configure a Signature”

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, l’enregistrement des abonnements et la messagerie in-app.
Si vous testez avec un émulateur Android, il doit démarrer avec un démarrage à froid.
  1. Allez dans Device Manager dans Android Studio.
  2. Sélectionnez votre appareil émulateur et cliquez sur Edit.
  3. Allez dans Additional Settings ou More.
  4. Définissez l’option de démarrage sur Cold Boot.
  5. Enregistrez les modifications et redémarrez l’émulateur.

Vérifier les abonnements mobiles

1

Lancez votre application sur un appareil de test.

L’invite d’autorisation push native devrait apparaître automatiquement si vous avez ajouté la méthode requestPermission lors de l’initialisation.

Invites d'autorisation push iOS et Android

2

Vérifiez votre tableau de bord OneSignal

Avant d’accepter l’invite, vérifiez le tableau de bord OneSignal :
  • Allez dans Audience > Subscriptions.
  • Vous devriez voir une nouvelle entrée avec le statut “Never Subscribed”.

Tableau de bord affichant un abonnement avec le statut 'Never Subscribed'

3

Retournez à l'application et appuyez sur Autoriser dans l'invite.

4

Actualisez la page Subscription du tableau de bord OneSignal.

Le statut de l’abonnement devrait maintenant afficher Subscribed.

Tableau de bord affichant un abonnement avec le statut 'Subscribed'

Vous avez créé avec succès un abonnement mobile. Les abonnements mobiles sont créés lorsque les utilisateurs ouvrent votre application pour la première fois sur un appareil ou s’ils désinstallent et réinstallent votre application sur le même appareil.

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.

Ajout d'un appareil aux abonnements de test

2

Nommez votre abonnement.

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

Tableau de bord affichant le champ 'Name your subscription'

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.

Création d'un segment 'Test Users' avec le filtre Test Users

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"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "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 avec une image incluse :

Notification push avec image sur iOS et Android

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.

Statistiques de livraison affichant 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 :

Livraison confirmée au niveau de l'appareil dans Audience Activity

Vous avez envoyé avec succès une notification via notre API à un segment.
  • Aucune image reçue ? Votre Notification Service Extension est peut-être manquant.
  • Aucune livraison confirmée ? Consultez le guide de dépannage ici.
  • Vous rencontrez des problèmes ? Copiez-collez la requête API et un journal du début à la fin du lancement de l’application dans un fichier .txt. Ensuite, partagez les deux avec support@onesignal.com.

Envoyer un message in-app

Les messages in-app vous permettent de communiquer avec les utilisateurs pendant qu’ils utilisent votre application.
1

Fermez ou mettez votre application en arrière-plan sur l'appareil.

C’est parce que les utilisateurs doivent répondre aux critères d’audience in-app avant qu’une nouvelle session ne commence. Dans OneSignal, une nouvelle session commence lorsque l’utilisateur ouvre votre application après qu’elle ait été en arrière-plan ou fermée pendant au moins 30 secondes. Pour plus de détails, consultez notre guide sur comment les messages in-app sont affichés.
2

Créer un message in-app.

  • Dans votre tableau de bord OneSignal, naviguez vers Messages > In-App > New In-App.
  • Trouvez et sélectionnez le message Welcome.
  • Définissez votre Audience comme le segment Test Users que nous avons utilisé précédemment.

Ciblage du segment 'Test Users' avec un message in-app

3

Personnalisez le contenu du message si désiré.

Exemple de personnalisation du message de bienvenue in-app

4

Définir le déclencheur sur 'On app open'.

5

Planifier la fréquence.

Sous Schedule > How often do you want to show this message? sélectionnez Every time trigger conditions are satisfied.

Options de planification du message in-app

6

Rendre le message actif.

Cliquez sur Make Message Live pour qu’il soit disponible pour vos utilisateurs de test chaque fois qu’ils ouvrent l’application.
7

Ouvrez l'application et voyez le message.

Après que le message in-app soit actif, ouvrez votre application. Vous devriez le voir s’afficher :

Message de bienvenue in-app affiché sur les appareils

Vous ne voyez pas le message ?
  • Démarrez une nouvelle session
    • Vous devez fermer ou mettre l’application en arrière-plan pendant au moins 30 secondes avant de la rouvrir. Cela garantit qu’une nouvelle session est démarrée.
    • Pour plus d’informations, voir comment les messages in-app sont affichés.
  • Toujours dans le segment Test Users ?
    • Si vous avez réinstallé ou changé d’appareil, réajoutez l’appareil aux abonnements de test et confirmez qu’il fait partie du segment Test Users.
  • Vous rencontrez des problèmes ?
    • Suivez Obtenir un journal de débogage tout en reproduisant les étapes ci-dessus. Cela générera des journaux supplémentaires que vous pourrez partager avec support@onesignal.com et nous vous aiderons à enquêter sur ce qui se passe.
Vous avez configuré avec succès le SDK OneSignal et appris des concepts importants tels que :Continuez avec ce guide pour identifier les utilisateurs dans votre application et configurer des fonctionnalités supplémentaires.

Identification des utilisateurs

Précédemment, nous avons démontré comment créer des Abonnements mobiles. 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.

Un profil utilisateur dans OneSignal avec un tag appelé "current_level" défini sur "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 :

Éditeur de segment montrant un segment ciblant les utilisateurs avec une valeur current_level supérieure à 4 et inférieure à 10


Capture d'écran montrant une notification push ciblant le segment Niveau 5-10 avec un message personnalisé


La notification push est reçue sur un appareil iOS et Android avec le contenu personnalisé

Ajouter des abonnements email et/ou SMS

Plus tôt, nous avons vu comment notre SDK crée des abonnements mobiles pour envoyer des messages push et in-app. 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.

Un profil utilisateur avec des abonnements push, email et SMS unifiés par External ID

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 :

Demander les autorisations push

Au lieu d’appeler requestPermission() immédiatement à l’ouverture de l’application, adoptez une approche plus stratégique. Utilisez un message in-app pour expliquer la valeur des notifications push avant de demander l’autorisation. Pour les meilleures pratiques et les détails d’implémentation, consultez notre guide Demander les autorisations push.

É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

Pour une personnalisation complète, consultez Mobile Service Extensions.

Changements d’état de l’utilisateur

Événements de message in-app

  • addClickListener() : Gérer les actions de clic in-app. Idéal pour le deep linking ou le suivi des événements.
  • addLifecycleListener() : Suivre le cycle de vie complet des messages in-app (affiché, cliqué, rejeté, etc.).

Configuration avancée et capacités

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

Configuration et référence du SDK mobile

Assurez-vous d’avoir activé toutes les fonctionnalités clés en consultant le guide Configuration push mobile. Pour tous les détails sur les méthodes disponibles et les options de configuration, visitez la référence du SDK mobile.
Félicitations ! Vous avez terminé avec succès le guide de configuration du SDK mobile.

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 !