Récupérer les onboardings dans le SDK Unity

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 — offrant des animations plus fluides, un rendu natif cohérent, des temps de chargement plus rapides et aucune dépendance à un runtime WebView. Consultez Obtenir des flows et paywalls et Afficher des flows et 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 Unity. La première étape consiste à récupérer l’onboarding associé au placement et sa configuration d’affichage, comme décrit ci-dessous.

Avant de commencer, assurez-vous que :

Vous avez installé le SDK Adapty pour Unity version 3.14.0 ou supérieure.
Vous avez créé un onboarding.
Vous avez ajouté l’onboarding à un placement.

Récupérer l’onboarding et créer la vue

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’ensemble de l’expérience : le contenu affiché, la façon dont il est présenté, et la manière dont les interactions utilisateur (comme les réponses à des quiz ou les saisies de formulaire) sont traitées. Le conteneur assure également le suivi automatique des événements analytiques, ce qui vous évite d’implémenter un suivi de vue séparé.

Pour de meilleures performances, récupérez la configuration de l’onboarding tôt afin de laisser suffisamment de temps aux images pour se télécharger avant de les afficher aux utilisateurs.

Pour obtenir un onboarding, utilisez la méthode GetOnboarding :

Adapty.GetOnboarding("YOUR_PLACEMENT_ID", (onboarding, error) => {
    if (error != null) {
        // handle the error
        return;
    }
    
    // the requested onboarding
});

Paramètres :

Paramètre	Présence	Description
placementId	requis	L’identifiant du Placement souhaité. Il s’agit de la valeur que vous avez indiquée lors de la création d’un placement dans l’Adapty Dashboard.
locale	optionnel par défaut : `en`	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 correspond à la langue, le second à la région. Exemple : `en` désigne l’anglais, `pt-br` représente le portugais brésilien. Consultez Localisations et codes de locale pour plus d’informations sur les codes de locale et leur utilisation recommandée.
fetchPolicy	par défaut : `.reloadRevalidatingCacheData`	Par défaut, le SDK tente de charger les données depuis le serveur et renvoie les données en cache en cas d’échec. Nous recommandons cette option car elle garantit que vos utilisateurs disposent toujours des données les plus récentes. Toutefois, si vous pensez que vos utilisateurs ont une connexion internet instable, envisagez d’utiliser `.returnCacheDataElseLoad` pour renvoyer les données en cache si elles existent. Dans ce cas, les utilisateurs n’auront peut-être pas les toutes dernières données, mais le chargement sera plus rapide, quelle que soit la qualité de leur connexion. Le cache est mis à jour régulièrement, il est donc sûr de l’utiliser pendant la session pour éviter les requêtes réseau. Notez que le cache n’est pas effacé au redémarrage de l’application ; il est uniquement supprimé lors de la désinstallation ou d’un nettoyage manuel. Le SDK Adapty stocke les onboardings localement sur 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, ainsi qu’un serveur de secours indépendant en cas d’indisponibilité du CDN. Ce système est conçu pour vous garantir toujours la dernière version de vos onboardings tout en assurant une fiabilité même en cas de connexion internet 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 dépassé, les données en cache ou le fallback local sont renvoyés. Notez que dans de rares cas, cette méthode peut expirer légèrement après le délai indiqué dans `loadTimeout`, car l’opération peut reposer sur plusieurs requêtes en arrière-plan.

Paramètres de réponse :

Paramètre	Description
Onboarding	Un objet `AdaptyOnboarding` contenant : l’identifiant et la configuration de l’onboarding, le Remote Config, ainsi que plusieurs autres propriétés.

Après avoir récupéré l’onboarding, appelez la méthode CreateOnboardingView.

Le résultat de la méthode CreateOnboardingView ne peut être utilisé qu’une seule fois. Si vous en avez besoin à nouveau, appelez de nouveau la méthode CreateOnboardingView. L’appeler deux fois sans recréer peut entraîner l’erreur AdaptyUIError.viewAlreadyPresented.

AdaptyUI.CreateOnboardingView(onboarding, (view, error) => {
    // handle the result
});

Paramètres :

Paramètre Présence Description

onboarding requis Un objet AdaptyOnboarding pour obtenir une vue pour l’onboarding souhaité.

Paramètre	Présence	Description
onboarding	requis	Un objet `AdaptyOnboarding` pour obtenir une vue pour l’onboarding souhaité.
externalUrlsPresentation	optionnel par défaut : `InAppBrowser`	Contrôle la façon dont les liens de l’onboarding sont ouverts. Options disponibles : - `AdaptyWebPresentation.InAppBrowser` - Ouvre les liens dans un navigateur intégré à l’application (par défaut) - `AdaptyWebPresentation.ExternalBrowser` - Ouvre les liens dans le navigateur externe de l’appareil Consultez Personnaliser l’ouverture des liens dans les onboardings pour des exemples d’utilisation.

externalUrlsPresentation

optionnel

par défaut : InAppBrowser

Contrôle la façon dont les liens de l’onboarding sont ouverts. Options disponibles :

- AdaptyWebPresentation.InAppBrowser - Ouvre les liens dans un navigateur intégré à l’application (par défaut)

- AdaptyWebPresentation.ExternalBrowser - Ouvre les liens dans le navigateur externe de l’appareil

Consultez Personnaliser l’ouverture des liens dans les onboardings pour des exemples d’utilisation.

Une fois que vous avez chargé avec succès l’onboarding et sa configuration d’affichage, vous pouvez le présenter dans votre application mobile.

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 disposent d’une connexion internet faible, la récupération d’un onboarding peut prendre plus de temps que souhaité. Dans ces situations, vous pouvez afficher un onboarding par défaut pour garantir une expérience fluide plutôt que de ne rien afficher du tout.

Pour résoudre ce problème, vous pouvez utiliser la méthode GetOnboardingForDefaultAudience, qui récupère l’onboarding du placement spécifié pour l’audience All Users. Cependant, il est essentiel de comprendre que l’approche recommandée est de récupérer l’onboarding via la méthode getOnboarding, comme détaillé dans la section Récupérer l’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 conceptions rétrocompatibles, soit d’accepter que les anciennes versions s’affichent incorrectement.
Pas de personnalisation : Affiche uniquement le contenu pour l’audience « Tous les utilisateurs », supprimant le ciblage basé sur le pays, l’attribution ou les attributs personnalisés.

Si une récupération plus rapide compense ces inconvénients pour votre cas d’utilisation, utilisez GetOnboardingForDefaultAudience comme indiqué ci-dessous. Sinon, utilisez GetOnboarding comme décrit ci-dessus.

Adapty.GetOnboardingForDefaultAudience("YOUR_PLACEMENT_ID", (onboarding, error) => {
    if (error != null) {
        // handle the error
        return;
    }
    
    // the requested onboarding
});

Paramètres :

Paramètre Présence Description

placementId requis L’identifiant du Placement souhaité. C’est la valeur que vous avez spécifiée lors de la création d’un placement dans l’Adapty Dashboard.

Paramètre	Présence	Description
placementId	requis	L’identifiant du Placement souhaité. C’est la valeur que vous avez spécifiée lors de la création d’un placement dans l’Adapty Dashboard.
locale	optionnel défaut : `en`	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 correspond à la langue, le second à la région. Exemple : `en` désigne l’anglais, `pt-br` représente le portugais brésilien.
fetchPolicy	défaut : `.reloadRevalidatingCacheData`	Par défaut, le SDK tente de charger les données depuis le serveur et renvoie les données en cache en cas d’échec. Nous recommandons cette option car elle garantit que vos utilisateurs obtiennent toujours les données les plus récentes. Cependant, si vous pensez que vos utilisateurs ont une connexion internet instable, envisagez d’utiliser `.returnCacheDataElseLoad` pour renvoyer les données en cache si elles existent. Dans ce cas, les utilisateurs n’auront peut-être pas les toutes dernières données, mais le chargement sera plus rapide, quelle que soit la qualité de leur connexion. Le cache est mis à jour régulièrement, il est donc sûr de l’utiliser pendant la session pour éviter les requêtes réseau. Notez que le cache reste intact après le redémarrage de l’application et n’est effacé que lors de la désinstallation ou via 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, ainsi qu’un serveur de secours indépendant en cas d’indisponibilité du CDN. Ce système est conçu pour garantir que vous obtenez toujours la dernière version de vos onboardings tout en assurant la fiabilité même lorsque la connexion internet est limitée.

locale

optionnel

défaut : en

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 correspond à la langue, le second à la région.

Exemple : en désigne l’anglais, pt-br représente le portugais brésilien.

fetchPolicy

défaut : .reloadRevalidatingCacheData

Par défaut, le SDK tente de charger les données depuis le serveur et renvoie les données en cache en cas d’échec. Nous recommandons cette option car elle garantit que vos utilisateurs obtiennent toujours les données les plus récentes.

Cependant, si vous pensez que vos utilisateurs ont une connexion internet instable, envisagez d’utiliser .returnCacheDataElseLoad pour renvoyer les données en cache si elles existent. Dans ce cas, les utilisateurs n’auront peut-être pas les toutes dernières données, mais le chargement sera plus rapide, quelle que soit la qualité de leur connexion. Le cache est mis à jour régulièrement, il est donc sûr de l’utiliser pendant la session pour éviter les requêtes réseau.

Notez que le cache reste intact après le redémarrage de l’application et n’est effacé que lors de la désinstallation ou via 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, ainsi qu’un serveur de secours indépendant en cas d’indisponibilité du CDN. Ce système est conçu pour garantir que vous obtenez toujours la dernière version de vos onboardings tout en assurant la fiabilité même lorsque la connexion internet est limitée.