OneLinkUrlGenerator v1

Resumen General

El OneLinkUrlGenerator genera e inserta automáticamente enlaces detrás de un botón o banner en el sitio web de tu marca.

Constructores públicos

OneLinkUrlGenerator

Argumentos de entrada

Tipo	Parámetro	Descripción
String	oneLinkURL [obligatorio]	- Sirve como base para todos los enlaces generados por el script. - Es el dominio de la plantilla de OneLink + el ID de la plantilla.
Lista de cadenas	pidKeysList	- Muestra los parámetros de fuente de medios en la URL entrante que se colocarán como el parámetro pid en la URL saliente. - Si hay varios parámetros de fuente de medios en el enlace entrante (por ejemplo, af_pid y utm_source), pidKeysList analiza los parámetros del primero al último y utiliza la primera coincidencia encontrada.
dictionary {string: string, …}	pidOverrideList	Enumera los valores de la fuente de medios en la URL entrante, junto con los valores con los que se reemplazarán.
String	pidStaticValue	Si no se encuentra una clave de pid en pidKeysList, el valor pidStaticValue se utiliza como valor pid.
Lista de cadenas	campaignKeysList	Enumera los parámetros de la campaña en la URL entrante que se colocarán como el parámetro c en la URL saliente.
String	campaignStaticValue	Si no se encuentra una clave de campaña en campaignKeysList, el valor campaignStaticValue se utiliza como valor c.
String	gclIdParam	- Define qué parámetro en la URL saliente lleva el GCLID. - Se puede elegir cualquier parámetro. Nota: Para mostrarse en los reportes de raw data de AppsFlyer, el parámetro debe ser uno de af_sub[1-5].
String	skipList	Si aparece alguna cadena en la lista de exclusión en el referente HTTP, el Smart Script no se ejecuta y devuelve `null`.

Ejemplo 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

Resumen General

Esta función genera la URL en función de los constructores públicos descritos anteriormente y de las funciones de establecimiento descritas a continuación.

Argumentos de entrada

Nada

Valor devuelto

Tipo	Descripción
String	URL generada por `OneLinkUrlGenerator`

Ejemplo de uso

const url = onelinkGenerator.generateUrl();

setDeepLinkValue

Argumentos de entrada

Tipo	Parámetro	Descripción	Obligatorio
String	deepLinkValueParam	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `deep_link_value`.	True
String	deepLinkValue	Un valor alternativo que se debe establecer en la URL saliente `deep_link_value` si `deepLinkValueParam` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	channelParam	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_channel`.	True
String	channelValue	Un valor alternativo que se debe establecer en la URL saliente `af_channel` si `channelParam` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	adsetParam	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_adset`.	True
String	adsetValue	Un valor alternativo que se debe establecer en la URL saliente `af_adset` si `adsetParam` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	adParam	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_ad`.	True
String	adValue	Un valor alternativo que se debe establecer en la URL saliente `af_ad` si `adParam` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	afSub1Param	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_sub1`.	True
String	afSub1Value	Un valor alternativo que se debe establecer en la URL saliente `af_sub1` si `afSub1Param` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	afSub2Param	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_sub2`.	True
String	afSub2Value	Un valor alternativo que se debe establecer en la URL saliente `af_sub2` si `afSub2Param` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	afSub3Param	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_sub3`.	True
String	afSub3Value	Un valor alternativo que se debe establecer en la URL saliente `af_sub3` si `afSub3Param` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	afSub4Param	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_sub4`.	True
String	afSub4Value	Un valor alternativo que se debe establecer en la URL saliente `af_sub4` si `afSub4Param` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	afSub5Param	La clave de la URL entrante desde la cual el script toma el valor de enlace profundo para establecer en la URL saliente `af_sub5`.	True
String	afSub5Value	Un valor alternativo que se debe establecer en la URL saliente `af_sub5` si `afSub5Param` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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

Tipo	Parámetro	Descripción	Obligatorio
String	searchKey	La clave en la URL entrante de la que la secuencia de comandos toma el valor para establecer en la URL saliente `customKey`	True
String	customKey	La clave en la URL de OneLink saliente en la que colocar el valor encontrado por `searchKey`	True
String	customValue	Un valor alternativo que se debe establecer en la URL saliente `customKey` si `searchKey` no se encuentra en la URL entrante.	False

Valor devuelto

void

Ejemplo 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();