Guia de migração do Smart Banner v1 para v2

⚠️

Aviso importante

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.

Visão Geral

Fazer upgrade do seu SDK para uma nova versão pode ser um processo simples, mas é importante entender as mudanças que foram feitas. Neste tutorial, mostraremos as etapas para o upgrade do seu SDK atual para a nova versão e como ajustar seu código para acomodar as alterações.

Pré-requisitos

  1. Cerifique-se de fazer download da última versão do SDK.
    Se você já tiver o SDK web PBA autônomo, remova-o e substitua-o pelo SDK web para Smart Banners e Atribuição baseada em Pessoas. Não basta adicionar o SDK web autônomo para Smart Banners.

Você pode encontrar os dois trechos de código do SDK aqui (escolha aquele que se adapta a você):
1. Usando o Web SDK apenas para Smart Banners.
2. Usando o Web SDK para Smart Banners e para Atribuição Baseada em Pessoas.

Instalação

Substitua o trecho do SDK antigo em seu site pelo novo.
Basta substituir o trecho do código antigo na tag <head> de cada página que exibe seus banners mobile pelo novo trecho do SDK.

Métodos do SDK

  1. Depois que o novo SDK estiver ativo, você precisará ajustar seu código para refletir as alterações.
    Nesse caso, o SDK antigo incluía funções descontinuadas, como:
    disableBanners()
    disableTracking()
    getAdditionalParams()
    setAdditionalParams()

Essas funções foram removidas no novo SDK, portanto, você precisará remover todas as referências a elas em seu código.

showBanner

No antigo SDK, a função showBanner era chamada assim:

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

No novo SDK, a função showBanner é chamada assim:

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

hideBanner

The hideBanner também mudou, passando de:

hideBanner()

para a nova versão

AF('banners', 'hideBanner')

updateParams

O novo SDK permite que você adicione programaticamente até 10 parâmetros ao URL do OneLink atribuído ao botão de call-to-action (CTA), após a exibição do banner. Isso é útil para o acompanhamento ou outras finalidades em que você precisa passar dados dinâmicos para o OneLink.

Exemplo:

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

É importante observar que esse método não funciona com o SDK da web do Smart Banner descontinuado.