OneLink Smart Script V2 — gerador de URL da web para aplicativo

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.

Sobre o OneLink Smart Script

OneLink Smart Script usa URLs de entrada que levam à página web para gerar automaticamente URLs exclusivas de saída OneLink que levam à loja de aplicativos.

The outgoing URLs are generated using arguments you receive from the marketer and input into the script. Note: The afParameters argument has a structure made up of several other arguments (parameters), each of which contains a configuration object that has keys, override values, and a default value.

Etapas de implementação

Para configurar o Smart Script, você pode:

Embed the script in your website

A inicialização do Smart Script e o código de chamada podem vir do gerador de Smart Script no painel da AppsFlyer (recomendado) ou importados e chamados manualmente pelo desenvolvedor.

Usar código gerado pelo Smart Script Generator

  1. Obtenha o arquivo do profissional de marketing que inclui o script, o código de inicialização e os argumentos.
  2. Test the script on the Smart Script test page. Ensure the correct outgoing URL is generated.
  3. Siga o teste e use as instruções de resultados do Smart Script.

Veja o exemplo de integração no Github

Configurar manualmente o script

  1. Fazer download do script.
  2. Obtenha os argumentos para chamar o script que mapeia os parâmetros de entrada para os parâmetros de saída do profissional de marketing.
  3. Inicialize os argumentos e os objetos de configuração do Smart Script.
  4. Gere os URLS chamando o script no HTML da web/página inicial usando o seguinte método:
var result = window.AF_SMART_SCRIPT.generateOneLinkURL({
  oneLinkURL,
  afParameters,
  referrerSkipList, // optional
  urlSkipList // optional
})
  1. Siga o teste e use as instruções de resultados do Smart Script.

Verificar e usar o resultado do Smart Script

  1. Check the return value in result. Possible return values are:
    • An outgoing Onelink URL. Use the result value as needed. For example, to place it as a link under a CTA on your website.
    • null. If the script returns null, implement your desired error flow. For example: the web/landing page's existing URL is not changed.
      var result_url = "No output from script"
      if (result) {
            result_url = result.clickURL;            
            // Put the generated OneLink URL behind CTA buttons
            document.getElementById('andrd_link').setAttribute('href', result_url);
            document.getElementById('ios_link').setAttribute('href', result_url);
            // Optionally - Create QR code from the generated OneLink URL
            window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
            //The size of the QR code is defined in the CSS file under #my_qr_code_div_id
            // #my_qr_code_div_id canvas { 
            //  height: 200px;
            //  width: 200px;
            //}
            // Optionally - fire an impression.
            // The impression will fire to https://impressions.onelink.me//.... 
            window.AF_SMART_SCRIPT.fireImpressionsLink();
      }

Use Google Tag Manager

Para configurar o Smart Script no Google Tag Manager:

  1. Confirm that the marketer followed their instructions and placed the Smart Script code into GTM.
  2. Check the return value in AF_SMART_SCRIPT_RESULT. Possible return values are:
    • Um URL OneLink de saída. Use o valor do resultado conforme necessário. Por exemplo, para colocá-lo como um link em um CTA em seu site.
    • null. If the script returns null, implement your desired error flow. For example: the web/landing page's existing URL is not changed.
      var result_url = AF_SMART_SCRIPT_RESULT.clickURL;
      if (result_url) {
            document.getElementById('andrd_link').setAttribute('href', result_url);
            document.getElementById('ios_link').setAttribute('href', result_url);
            // Optionally - Create QR code from the generated OneLink URL
            window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
            //The size of the QR code is defined in the CSS file under #my_qr_code_div_id
            // #my_qr_code_div_id canvas { 
            //  height: 200px;
            //  width: 200px;
            //}
            // Optionally - fire an impression.
            // The impression will fire to https://impressions.onelink.me//.... 
            window.AF_SMART_SCRIPT.fireImpressionsLink();            
      }
  1. Test the script on the Smart Script test page. Ensure the correct outgoing URL is generated.

Create a QR code with the Smart Script result

Pré-requisito: Smart Script V2.1+

Para criar um código QR:

  1. Crie uma tag div com um ID específico na página HTML do seu site para hospedar o código QR.
    Você pode definir o estilo da tag div como quiser.
  2. Depois de executar o Smart Script e gerar um URL do OneLink, chame a seguinte função e passe a ela o ID div:
window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
  1. Prática recomendada: depois de obter o resultado, mostre o código QR quando os usuários estiverem no desktop e mostre o botão com o link quando os usuários estiverem no celular.

Fire an impression

You can fire an impression when a page loads, a CTA or banner displays, etc. Note: Impressions can only be fired on mobile devices; not on desktop.

Pré-requisitos: Smart Script V2,2+

Para disparar uma impressão:

  1. Siga as instruções para executar o Smart Script e gerar um URL clicável.
  2. Certifique-se de que o resultado seja válido (e não nulo).
  3. Execute a seguinte função de impressão:
window.AF_SMART_SCRIPT.fireImpressionsLink();

Argumentos

Argumento Observações Exemplo
oneLinkURL (obrigatório)
  • Forneça o domínio do template do OneLink + ID do template. Nota: não forneça um URL de link personalizado do OneLink!
  • yourbrand.onelink.me/A1b2
  • Exemplo de domínio de marca: clique.suamarca.com/A1b2

afParameters

(obrigatório)

 

 

 


mediaSource

(obrigatório)

Objeto de configuração para fonte de mídia

  • Chaves: ['incoming_mediasource' 'utm_source']
  • Substituir valores: {twitter: 'twitter_int', orig_src: 'new_src'}
  • Valor padrão: ['any_source']

campaign

Objeto de configuração para campanha

  • Chaves: ['incoming_campaign', 'utm_campaign']
  • Substituir valores: {campaign_name: 'new_campaign_name'}
  • Valor padrão: ['any_campaign_name']

channel

Objeto de configuração para canal

  • Chaves: ['incoming_channel', 'utm_channel']
  • Substituir valores: {video: 'new_video'}
  • Valor padrão: ['any_video']

ad

Objeto de configuração para anúncio

  • Chaves: ['incoming_ad', 'utm_ad']
  • Substituir valores: {ad_name: 'new_ad_name'}
  • Valor padrão: ['any_ad_name']
adSet

Objeto de configuração para adset

  • Chaves: ['incoming_adset', 'utm_adset']
  • Substituir valores: {'adset_name': 'new_adset_name'}
  • Valor padrão: ['any_adset_name']
deepLinkValue

Objeto de configuração para deep_link_value

  • Chaves: ['product_id', 'page_name']
  • Substituir valores: {twenty_percent_off: 'thirty_percent_off'}
  • Valor padrão: 'new_offers_page'
afSub1-5

Objeto de configuração para af_sub[1-5]

 
googleClickIdKey

Indique o que chamar o parâmetro que carrega o GCLID.
Atenção! Para exibir nos relatórios de dados brutos da AppsFlyer, o parâmetro deve ser um dos af_sub [1-5].

 
Outros parâmetros de consulta (personalizados)
  • Lista de quaisquer outros parâmetros que você deseja incluir na URL de saída do OneLink para atribuição ou deep linking, junto com seus objetos de configuração.
  • O nome do parâmetro personalizado é listado pelo desenvolvedor como paramKey no objeto de configuração.
  • paramKey: 'deep_link_sub1'
  • Chaves: ['page_id']
  • Substituir valores: {page12: 'new_page12'}
  • Valor padrão: 'page1'
 
referrerSkipList
Lista das strings no referenciador HTTP para um clique específico (por exemplo, Twitter ou Facebook) que, se encontradas, fazem com que o Smart Script retorne null. Isso pode ser útil para SRNs como Twitter e Facebook, para os quais os cliques já foram relatados.  
urlSkipList Lista das strings no URL de um clique específico (por exemplo af_r) que, se encontradas, fazem com que o Smart Script retorne null. Isso pode ser útil se você usar um link de atribuição da AppsFlyer com af_r para redirecionar usuários para seu site mobile e não quiser que os dados do clique original sejam perdidos.  

Objeto de configuração

O OneLink Smart Script usa argumentos para gerar um URL de saída com base nos parâmetros do URL de entrada e nos argumentos definidos no script. O argumento afParameters tem uma estrutura composta de vários outros argumentos (parâmetros) usados para atribuição e deep linking, e cada um contém um objeto de configuração que tem chaves, valores de substituição e um valor padrão, conforme descrito na tabela a seguir.

Argumento Descrição Exemplo
keys
  • Lista de sequências de caracteres
  • Lista de parâmetros possíveis no URL de entrada que o script procura, cujo valor é colocado como o valor no URL de saída.
  • O script pesquisa da esquerda para a direita e para na primeira partida.
  • Exemplo: ['in_channel', 'utm_channel']
  • Para o parâmetro do canal no script, o script pesquisa o link de entrada para in_channel e usa o valor como o valor para channel.

overrideValues

  • Dictionary {string: string}
  • Para valores que você deseja alterar no link de saída, liste os valores no URL de entrada, junto com o que você deseja que eles sejam substituídos.
  • O script substitui os valores de parâmetro do URL de entrada pelos valores que você define. 

Exemplo: {'video': 'video_new'}

Para o parâmetro do canal no script, sempre que o valor de entrada for video, o script o altera para video_new no link de saída.

defaultValue
  • Sequência de caracteres
  • Indique qual valor você quer para o seu "fallback".
  • Se um parâmetro não for encontrado na sua lista de chaves, o valor defaultValue será usado no URL de saída.
  • Você pode forçar um valor padrão passando uma lista de chaves vazia.

Exemplo: ['web_video']

Para o parâmetro do canal no script, se você tiver o parâmetro in_channel e ele não for encontrado, web_video será usado como o valor do canal.

Exemplos

Basic attribution

Veja um exemplo da conversão básica de uma URL de entrada para uma URL de saída OneLink, com uma única chave para a mídia_source e campanha

Multiple keys

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink, com múltiplas chaves para mídia_source e campanha.

UTM parameters

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink, com parâmetros UTM para mídia_source e campanha.

Override values

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink, substituindo o valor da media_source de entrada.

Default values

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink, usando o valor padrão quando um valor de media_source de entrada não é encontrado.

Forced default values

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink, usando o valor padrão mesmo quando um valor de media_source de entrada é encontrado.

Google click ID passthrough to af_sub

Consulte o exemplo da conversão de um URL de entrada para um URL OneLink de saída que passe o ID de clique do Google para af_sub4. Observação: quando um GCLID é encontrado, o script procura a palavra-chave do parâmetro de entrada e coloca o valor da palavra-chave no URL de saída como o valor de af_keywords.

Facebook click ID passthrough to af_sub

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink que passa o ID de clique do Facebook para af_sub2.

Set attribution and OneLink parameters

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink com atribuição da AppsFlyer e parâmetros OneLink.

Set additional custom parameters

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink com parâmetros personalizados adicionais (incluindo o parâmetro af_prt para agências).

Referrer skip list

See example of how you can disable the Smart Script for a particular click (for example, from Twitter or Facebook) by creating a skip list. If any of the strings in the skip list appear in the HTTP referrer of the click, the Smart Script returns null.

URL skip list

See example of how you can disable the Smart Script for a particular string in the URL (for example, af_r) by creating a skip list. If any of the strings in the skip list appear in the URL of the click, the Smart Script returns null.

Smart Script set up with Google Tag Manager

Veja um exemplo da conversão de uma URL de entrada para uma URL de saída OneLink usando o OneLink Smart Script configurado usando o Google Tag Manager.

QR code

Veja um exemplo de como o Smart Script gera um código QR.

Impression

Veja um exemplo de uma impressão.