OneLink Smart Script V2 — gerador de URL da web para aplicativo
Esta página tem uma versão mais recente
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.
As URLs de saída são geradas usando argumentos que você recebe do profissional de marketing e entrada no script. Observação: O argumento afParameters
tem uma estrutura composta de vários outros argumentos (parâmetros), e cada um contém um objeto de configuração que tem chaves, valores de substituição e um valor padrão.
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
- Obtenha o arquivo do profissional de marketing que inclui o script, o código de inicialização e os argumentos.
- Test the script on the Smart Script test page. Ensure the correct outgoing URL is generated.
- 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
- Fazer download do script.
- 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.
- Inicialize os argumentos e os objetos de configuração do Smart Script.
- 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
})
Verificar e usar o resultado do Smart Script
- Verifique o valor de retorno em
result
. Os possíveis valores de retorno são:- 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
. Se o script retornarnull
, implemente o fluxo de erro desejado. Por exemplo: o URL existente da web/página inicial não é alterado.
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:
- Confirm that the marketer followed their instructions and placed the Smart Script code into GTM.
- Verifique o valor de retorno em
AF_SMART_SCRIPT_RESULT
. Os possíveis valores de retorno são:- 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
. Se o script retornarnull
, implemente o fluxo de erro desejado. Por exemplo: o URL existente da web/página inicial não é alterado.
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();
}
- 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:
- 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. - 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");
- 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:
- Siga as instruções para executar o Smart Script e gerar um URL clicável.
- Certifique-se de que o resultado seja válido (e não nulo).
- Execute a seguinte função de impressão:
window.AF_SMART_SCRIPT.fireImpressionsLink();
Argumentos
Argumento | Observações | Exemplo | |
---|---|---|---|
oneLinkURL (obrigatório) |
|
|
|
afParameters (obrigatório)
|
mediaSource (obrigatório) |
Objeto de configuração para fonte de mídia |
|
campaign |
Objeto de configuração para campanha |
|
|
channel |
Objeto de configuração para canal |
|
|
ad |
Objeto de configuração para anúncio |
|
|
adSet |
Objeto de configuração para adset |
|
|
deepLinkValue |
Objeto de configuração para |
|
|
afSub1-5 |
Objeto de configuração para |
||
googleClickIdKey |
Indique o que chamar o parâmetro que carrega o GCLID. |
||
Outros parâmetros de consulta (personalizados) |
|
|
|
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 |
|
|
overrideValues |
|
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 |
|
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
Veja um exemplo de como você pode desativar o Smart Script para um determinado clique (por exemplo, do Twitter ou 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
.
URL skip list
Veja o exemplo de como você pode desabilitar o Smart Script para uma determinada string na URL (por exemplo, af_r
) criando uma lista de exceções. Se alguma das strings na lista de exceções aparecer no URL do clique, o Smart Script retornará 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.
Atualizado 2 meses atrás