Guide de migration v1 à v2

⚠️

Avis important

As of Nov. 8th, 2023, AppsFlyer Smart Banner web SDK v1, is deprecated. From this date onwards websites using the Smart Banner web SDK v1 can no longer show Smart Banners.
Please upgrade to Smart Banner v2 by following the instructions in this article.

Vue d'ensemble

La mise à niveau de votre SDK vers une nouvelle version peut être simple à réaliser, mais il est important de savoir quels changements lui ont été apportés. Dans ce tutoriel, nous allons passer en revue les étapes pour faire passer votre SDK à la nouvelle version, et nous verrons les modifications à apporter à votre code qui en découlent.

Conditions préalables

  1. Assurez-vous d'avoir téléchargé la dernière version du SDK.
    Si vous disposez déjà du SDK web PBA, supprimez-le et remplacez-le par le SDK web pour les bannières intelligentes ET pour la PBA : ne vous contentez pas pas d'ajouter simplement le SDK web pour les bannières intelligentes.

Vous pouvez trouver les deux extraits du SDK ici (choisissez celui qui vous correspond) :
1. Utilisation du SDK web pour les Smart Banners uniquement.
2. Utilisation du SDK web pour les Smart Banners ET la PBA.

Installation

Remplacez l'ancien snippet du SDK de votre site web par le nouvel extrait.
Il suffit de remplacer l'ancien extrait de code par le nouveau dans la balise <head> de chaque page qui affiche vos bannières mobile.

Méthodes du SDK

  1. Une fois le nouveau SDK en place, vous devrez modifier votre code pour qu'il s'accorde aux changements.
    Dans notre cas, l'ancien SDK incluait des fonctions obsolètes telles que :
    disableBanners()
    disableTracking()
    getAdditionalParams()
    setAdditionalParams()

Ces fonctions ont été supprimées dans le nouveau SDK, vous devrez donc supprimer toute référence à ces dernières dans votre code.

showBanner

Dans l'ancien SDK, la fonction showBanner était appelée ainsi :

showBanner({ bannerContainerQuery: "#container-id",
              bannerZIndex: 1000,
              additionalParams: { deep_link_value: "flights", deep_link_sub1: "london"}});

Dans le nouveau SDK, showBanner est appelé de cette manière :

AF('banners', 'showBanner', { bannerContainerQuery: "#container-id",
              bannerZIndex: 1000,
              additionalParams: { deep_link_value: "flights", deep_link_sub1: "london"}});

hideBanner

The hideBanner a également changé, elle passe de :

hideBanner()

à la nouvelle version

AF('banners', 'hideBanner')

updateParams

Le nouveau SDK vous permet de programmer des ajouts, jusqu'à 10 paramètres peuvent être ajoutés l'URL OneLink attribuée au bouton call-to-action (CTA), après l'affichage de la bannière. Cette fonctionnalité est très utile pour le tracking ou tout autre événement où vous devez transmettre des données dynamiques à votre OneLink.

Exemple :

AF ("banners", "updateParams", {af_ad: "my_new_ad", deep_link_sub8: "promo_summer"})

Il est important de noter que cette méthode ne fonctionne pas avec le SDK Web de Smart Banner, qui est obsolète.