[Legado] OneLink Smart Script V1

Visão geral: personalize OneLinks que são gerados e incorporados automaticamente atrás de um botão ou banner no site da sua marca. Nota: embora não seja obrigatório, considere migrar para o OneLink Smart Script V2.

Sobre o OneLink Smart Script

Os usuários chegam ao seu site mobile antes de acessar a página da loja de aplicativos, seja organicamente ou por meio de campanhas publicitárias. No entanto, como há dois cliques (o primeiro que direciona para a página da web e o segundo que direciona da página da web para a loja de aplicativos), é problemático coletar métricas de conversão de cliques e deep linking. 

O OneLink Smart Script resolve esses problemas. O script:

• Usa as URLs de entrada que levam à página da web para gerar automaticamente URLs de saída exclusivas do OneLink que levam à loja de aplicativos. 
• Fornece uma coleção precisa de métricas web-to-app para todas as fontes de mídia. 
• Pode ser usado para deep linking.
• Funciona perfeitamente em qualquer página da web ou página inicial.

Procedimentos

Para configurar o Smart Script, é necessário concluir a seguinte lista de procedimentos de ação.

Import the script

Para importar o script para seu site:

1. Fazer download do script.
2. Importe para o site mobile/páginas nas quais você deseja que ele seja executado.

Initialize the script

Para inicializar o script:

1. Obter do profissional de marketing: os parâmetros/valores que a URL do OneLink de saída deve conter (com base no que está contido na URL de entrada). Consulte a tabela a seguir para obter detalhes.
2. Inicializar o objeto Smart Script OneLinkUrlGenerator usando os argumentos (parâmetros).

Run setters

Para executar setters:

1. Obter do profissional de marketing: quaisquer outros parâmetros e valores que a URL do OneLink de saída deve conter (com base no que está contido na URL de entrada).
2. Execute os setters usando o modelo a seguir:

onelinkGenerator.set[parameter]("parameter value", "optional static value");

Por exemplo:

onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");

Generate URLs

Para gerar URLs do OneLink de saída:

• Execute o método GenerateURL no HTML da web/página inicial que chama o script.
  Os possíveis valores de retorno são:
  • Uma URL do Onelink de saída
  • Nulo. Se o script retornar nulo, a URL existente da web/página de destino não será alterada.

Exemplos

Basic attribution

URL de entrada:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/basic_url.html?af_c=gogo&af_pid=email

Script:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
      const url = onelinkGenerator.generateUrl();

URL de saída:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true

UTM parameters

URL de entrada:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/utm_params.html?utm_source=email&utm_campaign=summer_sale

Script:

onst onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source', 'utm_source'],
         campaignKeysList: ['incoming_campaign', 'utm_campaign']
      });
      const url = onelinkGenerator.generateUrl();

URL de saída:
https://engmntqa.onelink.me/LtRd/?pid=email&c=summer_sale&af_js_web=true

PID and campaign static values

URL de entrada:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/static_val.html?af_not_c=gogo&af_not_pid=email

Script:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         pidStaticValue: 'my_static_pid',
         campaignKeysList: ['incoming_campaign'],
         campaignStaticValue: 'my_static_cmpn',
      });
      const url = onelinkGenerator.generateUrl();

URL de saída:
https://engmntqa.onelink.me/LtRd/?pid=my_static_pid&c=my_static_cmpn&af_js_web=true

Override PIDs

URL de entrada:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/override_pid.html?af_pid=twitter&af_c=big_social

Script:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign'],
         pidOverrideList: { twitter: 'twitter_out',
                            snapchat: 'snapchat_out'
                          }
      });
      const url = onelinkGenerator.generateUrl();

URL de saída:
https://engmntqa.onelink.me/LtRd/?pid=twitter_out&c=big_social&af_js_web=true

Google Click ID passthrough to af_sub

URL de entrada:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/gclid.html?af_pid=sms&af_c=candles&gclid=1a2b3c

Script:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign'],
         gclIdParam: 'af_sub4'
      });
      const url = onelinkGenerator.generateUrl();

URL de saída:
https://engmntqa.onelink.me/LtRd/?pid=google_lp&c=candles&af_js_web=true&af_sub4=1a2b3c

Set OneLink parameters

Para criar um link longo a ser usado para deep linking, você pode passar parâmetros personalizados e parâmetros predefinidos. Veja as funções para passar parâmetros no script de amostra a seguir.

Para passar um parâmetro personalizado:

• Chame a função setCustomParameter.
  setCustomParameter aceita três argumentos:
  1. [Obrigatório] A chave no URL de entrada a partir da qual o script usa o valor para definir no URL de saída.
  2. [Obrigatório] A chave a ser especificada no URL de saída.
  3. [Opcional] Um valor de fallback estático, caso a chave no primeiro argumento não seja encontrada no URL.

Se a chave no primeiro argumento não for encontrada e nenhum fallback estático for definido, o parâmetro será ignorado.

Para passar um parâmetro predefinido

• Chame a(s) função(ões) no script de amostra a seguir (exceto setCustomParameter).
  Cada função aceita dois argumentos:
  1. [Obrigatório] A chave na URL de entrada a partir da qual o script usa o valor para definir na URL de saída.
  2. [Opcional] Um valor de fallback estático, caso a chave no primeiro argumento não seja encontrada na URL.

Se a chave no primeiro argumento não for encontrada e nenhum fallback estático for definido, o parâmetro será ignorado.

URL de entrada:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/setters.html?af_c=gogo&af_pid=email

Script:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
      onelinkGenerator.setDeepLinkValue("original_url_deeplinkvalue", "yessss");
      onelinkGenerator.setChannel("original_url_channel", "new_channel");
      onelinkGenerator.setAdset("no_adset", "adset");
      onelinkGenerator.setAd("original_url_ad", "new_ad");
      onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");
      onelinkGenerator.setAfSub2("original_url_sub2");
      onelinkGenerator.setAfSub3("no_sub3", "new_afsub3");
      onelinkGenerator.setAfSub4("original_url_sub4");
      onelinkGenerator.setAfSub5("neverfind_sub5", "new_afsub5");
      onelinkGenerator.setCustomParameter("original_url_fruit_name", "onelink_my_custom_param", "apples");
      const url = onelinkGenerator.generateUrl();

URL de saída:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true&deep_link_value=yessss&af_channel=new_channel&af_adset=adset&af_ad=new_ad&af_sub1=ram_afsub1&af_sub3=new_afsub3&af_sub5=new_afsub5&onelink_my_custom_param=apples

Set additional attribution parameters

Você pode criar um link longo com parâmetros de atribuição adicionais. Veja as funções para passar parâmetros no script de amostra a seguir.

Para adicionar um parâmetro de atribuição:

• Chame a função setCustomParameter.
  setCustomParameter aceita três argumentos:
  1. [Obrigatório] A chave do parâmetro de atribuição no URL de entrada a partir da qual o script usa o valor para definir no URL de saída.
  2. [Obrigatório] A chave do parâmetro de atribuição a ser especificado no URL de saída.
  3. [Opcional] Um valor de fallback estático, caso a chave no primeiro argumento não seja encontrada no URL.

Se a chave no primeiro argumento não for encontrada e nenhum fallback estático for definido, o parâmetro será ignorado.

URL de entrada:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/set_af_params.html?af_c=gogo&af_pid=email&partner_name=bigagency

Script:

onelinkGenerator.setCustomParameter("incoming_site_id", "af_siteid", "defaultSiteID");

Outgoing URL:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true&af_siteid=defaultSiteID

Skip clicks from Twitter or Facebook

Você pode desativar o Smart Script para um clique específico (por exemplo, do Twitter ou do Facebook) criando uma lista de exceções. Se alguma das strings na lista de exceção aparecer no referenciador HTTP do clique, o Smart Script retornará null.

Script:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
      {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
        pidKeysList: ['original_pid'],
        campaignKeysList: ['original_campaign'],
        skipList: ['twitter', 'facebook']
    });
const url = onelinkGenerator.generateUrl();

Don't skip any clicks

Você pode garantir que o OneLink Smart Script funcione para todos os cliques e nunca ignore nenhum, passando uma lista de exceções vazia.

Script:

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
      {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
        pidKeysList: ['original_pid'],
        campaignKeysList: ['original_campaign'],
        skipList: []
    });
const url = onelinkGenerator.generateUrl();