Configuration du SDK Android

Integrate the OneSignal Android SDK into this codebase.

Follow the instructions at:
https://raw.githubusercontent.com/OneSignal/sdk-ai-prompts/main/docs/android/ai-prompt.md

​

Étape 0. Configurer FCM dans OneSignal (requis pour envoyer des push)

​

Contrat de configuration et prérequis

• Version du SDK : 5.6.1+ (dernière version : consultez les releases)
• Instructions de configuration IA : https://raw.githubusercontent.com/OneSignal/sdk-ai-prompts/main/docs/android/ai-prompt.md
• Dépôt du SDK : https://github.com/OneSignal/OneSignal-Android-SDK
• Android Studio : Meerkat+ (2024.2.1+)
• API Android : 23+ minimum (Android 6.0+), 31+ recommandé (Android 12+)
• Appareil/Émulateur : Android 7.0+ avec Google Play Services installé
• Dépendance requise : com.onesignal:OneSignal:[5.6.1, 5.9.99]
• Classe Application : Requise pour une initialisation correcte du SDK
• Format de l’App ID : UUID de 36 caractères (exemple : 12345678-1234-1234-1234-123456789012) — disponible dans le tableau de bord OneSignal > Settings > Keys & IDs
• Initialisation : OneSignal.initWithContext(this, "YOUR_APP_ID")
• Optimisation de la batterie : Peut affecter les notifications en arrière-plan
• Recommandé : Attribuer un External ID via OneSignal.login("user_id") pour unifier les utilisateurs sur tous les appareils

​

Étapes de configuration Android

• Le SDK OneSignal installé et initialisé dans votre application Android
• La demande de permission pour les notifications push fonctionnant correctement sur un appareil réel
• Un push de test et un message in-app envoyés avec succès

​

Étape 1. Ajouter le SDK OneSignal

1. Dans Android Studio, ouvrez votre fichier build.gradle.kts (Module: app) ou build.gradle (Module: app)
2. Ajoutez OneSignal à votre section dependencies :

implementation("com.onesignal:OneSignal:[5.6.1, 5.9.99]")

implementation 'com.onesignal:OneSignal:[5.6.1, 5.9.99]'

3. Synchroniser Gradle : Cliquez sur Sync Now dans la bannière qui apparaît ou allez dans File > Sync Project with Gradle Files

​

Étape 2. Créer et configurer la classe Application

1. File > New > Kotlin Class/File (ou Java Class)
2. Nom : ApplicationClass (ou le nom de votre choix)

// FILE: ApplicationClass.kt
// PURPOSE: Initialize OneSignal when your app launches
// REQUIREMENT: Must be registered in AndroidManifest.xml

package com.your.package.name // Replace with your actual package name

import android.app.Application
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch

import com.onesignal.OneSignal
import com.onesignal.debug.LogLevel

class ApplicationClass : Application() {
    override fun onCreate() {
        super.onCreate()

        // Enable verbose logging to debug issues (remove in production)
        OneSignal.Debug.logLevel = LogLevel.VERBOSE

        // Replace with your 36-character App ID from Dashboard > Settings > Keys & IDs
        OneSignal.initWithContext(this, "YOUR_APP_ID")

        // Prompt user for push notification permission
        // In production, consider using an in-app message instead for better opt-in rates
        CoroutineScope(Dispatchers.IO).launch {
            OneSignal.Notifications.requestPermission(false)
        }
    }
}

// FILE: ApplicationClass.java
// PURPOSE: Initialize OneSignal when your app launches
// REQUIREMENT: Must be registered in AndroidManifest.xml

package com.your.package.name; // Replace with your actual package name

import android.app.Application;

import com.onesignal.Continue;
import com.onesignal.OneSignal;
import com.onesignal.debug.LogLevel;

public class ApplicationClass extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // Enable verbose logging to debug issues (remove in production)
        OneSignal.getDebug().setLogLevel(LogLevel.VERBOSE);

        // Replace with your 36-character App ID from Dashboard > Settings > Keys & IDs
        OneSignal.initWithContext(this, "YOUR_APP_ID");

        // Prompt user for push notification permission
        // In production, consider using an in-app message instead for better opt-in rates
        OneSignal.getNotifications().requestPermission(false, Continue.none());
    }
}

1. Ouvrez le fichier AndroidManifest.xml de votre application
2. Dans votre balise <application>, ajoutez android:name=".ApplicationClass" (remplacez .ApplicationClass par le nom réel de votre classe si vous l’avez défini différemment).

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

    <application
        android:name=".ApplicationClass"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        ...
      </application>

  </manifest>

​

Étape 3. Configurer les icônes de notification par défaut (recommandé)

​

Étape 4. Tester l’intégration

1. Lancez l’application sur un appareil ou un émulateur avec Google Play Services
2. Vérifiez dans le tableau de bord > Audience > Subscriptions — le statut affiche “Never Subscribed”
3. Acceptez la demande de permission lorsqu’elle apparaît
4. Actualisez le tableau de bord — le statut passe à “Subscribed”

​

Créer un abonnement de test et un segment

1. Cliquez sur ⋮ à côté de l’abonnement > Add to Test Users > nommez-le
2. Allez dans Audience > Segments > New Segment
3. Nom : Test Users, ajoutez le filtre Test Users > Create Segment

​

Envoyer un push de test via l’API

1. Accédez à Settings > Keys & IDs.
2. Dans 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éé précédemment.

curl -X POST 'https://api.onesignal.com/notifications' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Authorization: Key YOUR_APP_API_KEY' \
  -d '{
    "app_id": "YOUR_APP_ID",
    "target_channel": "push",
    "name": "Testing basic setup",
    "headings": { "en": "👋" },
    "contents": {"en": "Hello world!"},
    "included_segments": ["Test Users"],
    "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  }'

​

Tester les messages in-app

1. Fermez l’application pendant plus de 30 secondes
2. Tableau de bord > Messages > In-App > New In-App > sélectionnez le modèle Welcome
3. Audience : segment Test Users
4. Déclencheur : On app open
5. Planification : Every time trigger conditions are satisfied
6. Cliquez sur Make Message Live
7. Ouvrez l’application

​

Erreurs courantes et solutions

​

Gestion des utilisateurs

​

Attribuer un External ID (recommandé)

// Call when user logs in or is identified, safe to call multiple times
// Typically used in a login completion handler, or on app launch if already authenticated
fun onUserAuthenticated(userId: String) {
    OneSignal.login(userId)
}

// If you want to remove the External ID from the Subscription, setting it to an anonymous user
fun onUserLoggedOut() {
    OneSignal.logout()
}

​

Ajouter des tags et des événements personnalisés

// Add a tag when the user's name is set
OneSignal.User.addTag("username", "john_doe")

// Create a custom event when user abandoned a cart
val properties = mapOf(
    "product_id" to "123456",
    "product_name" to "Product Name",
    "product_price" to 100,
    "product_quantity" to 1
)
OneSignal.User.trackEvent("abandoned_cart", properties)

​

Ajouter des abonnements e-mail et/ou SMS

// Add email subscription
// Call when user provides their email (e.g., account creation, settings update) after calling OneSignal.login("user_id")
OneSignal.User.addEmail("user@example.com")

// Add SMS subscription
// Use E.164 format: + country code + number
// Call when user provides their phone number (e.g., account creation, settings update) after calling OneSignal.login("user_id")
OneSignal.User.addSms("+15551234567")

​

Confidentialité et consentement utilisateur

// In ApplicationClass onCreate(), BEFORE OneSignal.initWithContext()
// Use this if your app requires GDPR or other privacy consent before data collection
OneSignal.consentRequired = true

// Later, after user grants consent (e.g., taps "I Agree" on your consent screen)
OneSignal.consentGiven = true

​

Demander les permissions push

​

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

​

Événements de notification push

// Add click listener to handle when users tap notifications
val clickListener = object : INotificationClickListener {
  override fun onClick(event: INotificationClickEvent) {
    Log.d("OneSignal", "Notification clicked: ${event.notification.title}")
  }
}
OneSignal.Notifications.addClickListener(clickListener)

​

Changements d’état utilisateur

// Add subscription observer to track push subscription changes
class MyObserver : IPushSubscriptionObserver {
  init {
    OneSignal.User.pushSubscription.addObserver(this)
  }

  override fun onPushSubscriptionChange(state: PushSubscriptionChangedState) {
    if (state.current.optedIn) {
      println("User is now opted-in with push token: ${state.current.token}")
    }
  }
}

​

Événements de messages in-app

// Add click listener for in-app message interactions
val clickListener = object : IInAppMessageClickListener {
  override fun onClick(event: IInAppMessageClickEvent) {
    print(event.result.actionId)
  }
}
OneSignal.InAppMessages.addClickListener(clickListener)

​

Configuration avancée et fonctionnalités

​

Fonctionnalités spécifiques à Android

• Canaux de notification — Organisez les notifications en catégories (Android 8.0+)
• Extensions de service — Personnalisation avancée des notifications
• Support Huawei/HMS — Alternative à Google Play Services

​

Fonctionnalités universelles

• Liens profonds — Dirigez les utilisateurs vers des écrans spécifiques depuis les notifications
• Boutons d’action — Ajoutez des boutons interactifs aux notifications
• Vérification d’identité — Identification sécurisée des utilisateurs
• Suivi de localisation — Ciblage basé sur la localisation
• Intégrations — Connectez-vous aux plateformes d’analyse et de données
• Messagerie multilingue — Notifications localisées