OneLinkUrlGenerator v1

Visão Geral

O OneLinkUrlGenerator gera e incorpora links automaticamente atrás de um botão ou banner no site da sua marca.

Construtores públicos

OneLinkUrlGenerator

Argumentos de entrada

TipoParâmetroDescrição
Sequência de caracteresoneLinkURL [obrigatório]- Atende como base para todos os links gerados pelo script.
- É o domínio do template do OneLink + ID do template.
Lista de sequências de caracterespidKeysList- Lista os parâmetros de fonte de mídia na URL de entrada que serão colocados como parâmetro de pid na URL de saída.
- Se houver vários parâmetros de fonte de mídia no link de entrada (por exemplo, af_pid e utm_source), a pidKeysList verificará os parâmetros de primeiro para último e usará a primeira correspondência encontrada.
dictionary {string: string,
…}
pidOverrideListLista os valores da fonte de mídia na URL de entrada, juntamente com o que você quer que sejam substituído.
Sequência de caracterespidStaticValueSe uma chave pid não for encontrada no PidKeysList, o pidStaticValue será usado como o valor pid.
Lista de sequências de caracterescampaignKeysListLista o(s) parâmetro(s) da campanha na URL de entrada que será/serão colocado(s) como o parâmetro c na URL de saída.
Sequência de caracterescampaignStaticValueSe uma chave de campanha não for encontrada na CampaignKeySlist, o CampaignStaticValue será usado como o valor c.
Sequência de caracteresgclIdParam- Define qual parâmetro no URL de saída carrega o GCLID.
- Qualquer parâmetro pode ser escolhido. Atenção! Para exibir nos relatórios de dados brutos da AppsFlyer, o parâmetro deve ser um dos af_sub [1-5].
Sequência de caracteresskipListSe alguma string na lista de ignorar aparecer no referenciador HTTP, o Smart Script não será executado e retornará null.

Exemplo de uso

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',
      });

Métodos públicos

generateUrl

Visão Geral

Essa função gera a URL com base nos construtores públicos descritos acima e nas funções de definição descritas abaixo.

Argumentos de entrada

Nenhum

Valor de retorno

TipoDescrição
Sequência de caracteresURL gerado por OneLinkUrlGenerator

Exemplo de uso

const url = onelinkGenerator.generateUrl();

setDeepLinkValue

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresdeepLinkValueParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída deep_link_value.verdadeiro
Sequência de caracteresdeepLinkValueUm valor de fallback a ser definido no URL de saída deep_link_value se deepLinkValueParam não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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");
const url = onelinkGenerator.generateUrl();

setChannel

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caractereschannelParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_channel.verdadeiro
Sequência de caractereschannelValueUm valor de fallback a ser definido no URL de saída af_channel se channelParam não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

setAdset

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresadsetParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_adset.verdadeiro
Sequência de caracteresadsetValueUm valor de fallback a ser definido no URL de saída af_adset se adsetParam não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

onelinkGenerator.setAdset("no_adset", "adset");
const url = onelinkGenerator.generateUrl();

setAd

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresadParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_ad.verdadeiro
Sequência de caracteresadValueUm valor de fallback a ser definido no URL de saída af_ad se adParam não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

onelinkGenerator.setAd("original_url_ad", "new_ad");
const url = onelinkGenerator.generateUrl();

setAfSub1

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresafSub1ParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_sub1.verdadeiro
Sequência de caracteresafSub1ValueUm valor de fallback a ser definido no URL de saída af_sub1 se afSub1Param não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");
const url = onelinkGenerator.generateUrl();

setAfSub2

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresafSub2ParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_sub2.verdadeiro
Sequência de caracteresafSub2ValueUm valor de fallback a ser definido no URL de saída af_sub2 se afSub2Param não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

onelinkGenerator.setAfSub2("original_url_sub2","fallback_sub2");
const url = onelinkGenerator.generateUrl();

setAfSub3

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresafSub3ParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_sub3.verdadeiro
Sequência de caracteresafSub3ValueUm valor de fallback a ser definido no URL de saída af_sub3 se afSub3Param não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

onelinkGenerator.setAfSub3("original_sub3", "new_afsub3");
const url = onelinkGenerator.generateUrl();

setAfSub4

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresafSub4ParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_sub4.verdadeiro
Sequência de caracteresafSub4ValueUm valor de fallback a ser definido no URL de saída af_sub4 se afSub4Param não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

setAfSub5

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteresafSub5ParamA chave no URL de entrada da qual o script usa o valor do deep link a ser definido no URL de saída af_sub5.verdadeiro
Sequência de caracteresafSub5ValueUm valor de fallback a ser definido no URL de saída af_sub5 se afSub5Param não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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

setCustomParameter

Argumentos de entrada

TipoParâmetroDescriçãoOBRIGATÓRIA
Sequência de caracteressearchKeyA chave no URL de entrada da qual o script usa o valor a ser definido no URL de saída customKeyverdadeiro
Sequência de caracterescustomKeyA chave no URL de saída do OneLink na qual colocar o valor encontrado por searchKeyverdadeiro
Sequência de caracterescustomValueUm valor de fallback a ser definido no URL de saída customKey se searchKey não for encontrado no URL de saída.Falso

Valor de retorno

void

Exemplo de uso

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