Récupérer les onboardings dans le SDK Kotlin Multiplatform
Les onboardings sont dépréciés dans le SDK v4 et seront supprimés dans une prochaine version. Ils ne reçoivent plus de correctifs ni d’améliorations. Utilisez les flows à la place : contrairement aux onboardings, qui s’exécutent dans une WebView, les flows s’affichent nativement sur l’appareil — vous offrant des animations plus fluides, un aspect natif cohérent, des temps de chargement plus rapides et aucune dépendance à un environnement WebView. Consultez Obtenir des flows et des paywalls et Afficher des flows et des paywalls pour commencer.
Après avoir conçu la partie visuelle de votre onboarding avec le builder dans l’Adapty Dashboard, vous pouvez l’afficher dans votre application Kotlin Multiplatform. La première étape consiste à récupérer l’onboarding associé au placement ainsi que sa configuration d’affichage, comme décrit ci-dessous.
Avant de commencer, assurez-vous que :
- Vous avez installé le SDK Adapty Kotlin Multiplatform en version 3.15.0 ou supérieure.
- Vous avez créé un onboarding.
- Vous avez ajouté l’onboarding à un placement.
Récupérer un onboarding
Lorsque vous créez un onboarding avec notre builder no-code, il est stocké sous forme de conteneur avec une configuration que votre application doit récupérer et afficher. Ce conteneur gère l’expérience complète — quel contenu apparaît, comment il est présenté et comment les interactions utilisateur (comme les réponses à des quiz ou les saisies de formulaires) sont traitées. Le conteneur assure également le suivi automatique des événements analytiques, vous n’avez donc pas besoin d’implémenter un suivi des vues séparément.
Pour de meilleures performances, récupérez la configuration de l’onboarding suffisamment tôt pour que les images aient le temps de se télécharger avant d’être affichées aux utilisateurs.
Pour obtenir un onboarding, utilisez la méthode getOnboarding :
Adapty.getOnboarding(
placementId = "YOUR_PLACEMENT_ID",
locale = "en",
fetchPolicy = AdaptyPaywallFetchPolicy.Default,
loadTimeout = 5.seconds
).onSuccess { paywall ->
// the requested paywall
}.onError { error ->
// handle the error
}Paramètres :
| Paramètre | Présence | Description |
|---|---|---|
| placementId | requis | L’identifiant du Placement souhaité. Il s’agit de la valeur que vous avez spécifiée lors de la création d’un placement dans l’Adapty Dashboard. |
| locale | optionnel par défaut : | L’identifiant de la localisation de l’onboarding. Ce paramètre doit être un code de langue composé d’un ou deux sous-tags séparés par le caractère moins (-). Le premier sous-tag désigne la langue, le second la région. Exemple : |
| fetchPolicy | par défaut : .reloadRevalidatingCacheData | Par défaut, le SDK tentera de charger les données depuis le serveur et retournera les données en cache en cas d’échec. Nous recommandons cette option car elle garantit que vos utilisateurs reçoivent toujours les données les plus récentes. Cependant, si vous pensez que vos utilisateurs ont une connexion internet instable, envisagez d’utiliser Notez que le cache reste intact lors du redémarrage de l’application et n’est effacé qu’à la réinstallation de l’application ou lors d’un nettoyage manuel. Le SDK Adapty stocke les onboardings localement en deux couches : le cache mis à jour régulièrement décrit ci-dessus et les onboardings de secours. Nous utilisons également un CDN pour récupérer les onboardings plus rapidement et un serveur de secours indépendant en cas d’inaccessibilité du CDN. Ce système est conçu pour vous garantir toujours la dernière version de vos onboardings tout en assurant la fiabilité même lorsque la connexion internet est limitée. |
| loadTimeout | par défaut : 5 sec | Cette valeur limite le délai d’attente de cette méthode. Si le délai est atteint, les données en cache ou le fallback local seront retournés. Notez que dans de rares cas, cette méthode peut expirer légèrement après le délai spécifié dans |
Paramètres de la réponse :
| Paramètre | Description |
|---|---|
| Onboarding | Un objet AdaptyOnboarding contenant : l’identifiant et la configuration de l’onboarding, le Remote Config, et plusieurs autres propriétés. |
Accélérer la récupération des onboardings avec l’onboarding de l’audience par défaut
En général, les onboardings sont récupérés presque instantanément, vous n’avez donc pas à vous soucier d’accélérer ce processus. Cependant, si vous avez de nombreuses audiences et onboardings et que vos utilisateurs ont une connexion internet faible, la récupération d’un onboarding peut prendre plus de temps que souhaité. Dans ce cas, vous pourriez vouloir afficher un onboarding par défaut pour garantir une expérience fluide plutôt que de ne rien afficher du tout.
Pour y remédier, vous pouvez utiliser la méthode getOnboardingForDefaultAudience, qui récupère l’onboarding du placement spécifié pour l’audience All Users. Il est toutefois essentiel de comprendre que l’approche recommandée reste de récupérer l’onboarding via la méthode getOnboarding, comme détaillé dans la section Récupérer un onboarding ci-dessus.
Préférez getOnboarding à getOnboardingForDefaultAudience, car cette dernière présente des limitations importantes :
- Problèmes de compatibilité : peut créer des problèmes lors de la prise en charge de plusieurs versions de l’application, nécessitant soit des designs rétrocompatibles, soit d’accepter que les anciennes versions puissent s’afficher incorrectement.
- Pas de personnalisation : affiche uniquement le contenu pour l’audience « All Users », sans ciblage basé sur le pays, l’attribution ou les attributs personnalisés.
Si une récupération plus rapide l’emporte sur ces inconvénients pour votre cas d’usage, utilisez getOnboardingForDefaultAudience comme indiqué ci-dessous. Sinon, utilisez getOnboarding comme décrit ci-dessus.
Adapty.getOnboardingForDefaultAudience(
placementId = "YOUR_PLACEMENT_ID",
locale = "en",
fetchPolicy = AdaptyPaywallFetchPolicy.Default,
).onSuccess { paywall ->
// the requested paywall
}.onError { error ->
// handle the error
}Paramètres :
| Paramètre | Présence | Description |
|---|---|---|
| placementId | requis | L’identifiant du Placement souhaité. Il s’agit de la valeur que vous avez spécifiée lors de la création d’un placement dans l’Adapty Dashboard. |
| locale | optionnel par défaut : | L’identifiant de la localisation de l’onboarding. Ce paramètre doit être un code de langue composé d’un ou deux sous-tags séparés par le caractère moins (-). Le premier sous-tag désigne la langue, le second la région. Exemple : en signifie anglais, pt-br représente le portugais brésilien. |
| fetchPolicy | par défaut : .reloadRevalidatingCacheData | Par défaut, le SDK tentera de charger les données depuis le serveur et retournera les données en cache en cas d’échec. Nous recommandons cette option car elle garantit que vos utilisateurs reçoivent toujours les données les plus récentes. Cependant, si vous pensez que vos utilisateurs ont une connexion internet instable, envisagez d’utiliser Notez que le cache reste intact lors du redémarrage de l’application et n’est effacé qu’à la réinstallation de l’application ou lors d’un nettoyage manuel. Le SDK Adapty stocke les onboardings localement en deux couches : le cache mis à jour régulièrement décrit ci-dessus et les onboardings de secours. Nous utilisons également un CDN pour récupérer les onboardings plus rapidement et un serveur de secours indépendant en cas d’inaccessibilité du CDN. Ce système est conçu pour vous garantir toujours la dernière version de vos onboardings tout en assurant la fiabilité même lorsque la connexion internet est limitée. |