Руководство по миграции смарт-баннера с v1 на v2

⚠️

Важное замечание

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.

Обзор

Обновление SDK до новой версии может быть простым процессом, но важно понимать, какие изменения были внесены. В этом руководстве мы рассмотрим шаги по обновлению текущего SDK до новой версии, а также то, как скорректировать ваш код с учетом изменений.

Необходимые условия

  1. Обязательно скачайте последнюю версию SDK.
    Если у вас уже есть отдельный веб-SDK PBA, удалите его и замените на веб-SDK как для смарт-баннеров, так и для атрибуции People-based; не добавляйте отдельный веб-SDK для смарт-баннеров.

Вы можете найти оба фрагмента SDK здесь (выберите тот, который подходит вам):
1. Использование веб-SDK только для смарт-баннеров.
2. Использование веб-SDK для смарт-баннеров и атрибуции People-Based.

Установка

Замените старый фрагмент SDK на вашем сайте на новый.
Просто замените старый фрагмент кода в теге <head> каждой страницы, отображающей ваши мобильные баннеры, на новый фрагмент SDK.

Методы SDK

  1. Как только новый SDK будет внедрен, вам нужно будет скорректировать код, чтобы отразить изменения.
    В этом случае старый SDK включал устаревшие функции, такие как:
    disableBanners()
    disableTracking()
    getAdditionalParams()
    setAdditionalParams()

Эти функции были удалены в новом SDK, поэтому вам необходимо удалить все ссылки на них в коде.

showBanner

В старом SDK функция показа баннера showBanner вызывалась следующим образом:

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

В новом SDK функция showBanner вызывается следующим образом:

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

hideBanner

The hideBanner функция также изменилась, перейдя от:

hideBanner()

к новой версии

AF('banners', 'hideBanner')

updateParams

Новый SDK позволяет программно добавлять до 10 параметров в URL-адреса OneLink, назначенный кнопке с призывом к действию (CTA), после отображения баннера. Это полезно для отслеживания или других целей, когда вам нужно передать динамические данные в OneLink.

Пример:

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

Важно отметить, что этот метод не работает с устаревшим веб-SDK смарт-баннеров.