[Heredado] OneLink Smart Script V1

De un vistazo: Personaliza los OneLinks que se generan automáticamente e incrustan detrás de un botón o banner en el sitio web de tu marca. Nota: Aunque no es obligatorio, considera migrar a OneLink Smart Script V2.

Acerca de OneLink Smart Script

Los usuarios llegan a tu sitio web móvil antes de llegar a la página de tu tienda de aplicaciones, ya sea de forma orgánica o a través de campañas publicitarias. Sin embargo, dado que hay dos clics (el primero que dirige a la página web y el segundo que dirige de la página web a la tienda de aplicaciones), recopilar métricas de conversión de clics y enlaces profundos es problemático.

OneLink Smart Script resuelve estos problemas. El script:

Utiliza las URL entrantes que llevan a la página web para generar automáticamente URL de OneLink salientes únicas que llevan a la tienda de aplicaciones.
Proporciona una recopilación precisa de métricas de la web a la aplicación para todas las fuentes de medios.
Se puede usar para enlaces profundos.
Se ejecuta sin problemas en cualquier página web o de aterrizaje.

Procedimientos

Para configurar el Smart Script, se debe completar la siguiente lista de verificación de acciones de procedimientos.

Lista de verificación de procedimientos
1. Importa el script a tu sitio web.
2. Inicializa el objeto de Smart Script OneLinkUrlGenerator con los parámetros y valores.
3. [Opcional] Ejecuta configuradores con parámetros y valores adicionales.
4. Genera las URL.

Import the script

Para importar el script a tu sitio web:

Descarga el script.
Impórtalo en el sitio móvil/páginas en las que deseas que se ejecute.

Initialize the script

Para inicializar el script:

Obtén del marketer: los parámetros/valores que debe contener la URL de OneLink saliente (según lo que contiene la URL entrante). Consulta la tabla siguiente para obtener más detalles.
Inicializa el objeto Smart Script OneLinkUrlGenerator utilizando los argumentos (parámetros).

Parámetro	Tipo	Funcionalidad	Ejemplo
oneLinkURL [obligatorio]	Cadena	- Sirve como base para todos los enlaces generados por el script. - Es el dominio de la plantilla de OneLink + el ID de la plantilla.	yourbrand.onelink.me/A1b2 Ejemplo de dominio de marca: click.yourbrand.com/A1b2
pidKeysList	Lista de cadenas	- 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.	['af_pid', 'utm_source']
pidOverrideList	dictionary {string: string, …}	Enumera los valores de la fuente de medios en la URL entrante, junto con los valores con los que se reemplazarán.	{ 'twitter': 'twitter_int', 'snapchat': 'snapchat_int', 'some_social_net': 'some_social_net_int' }
pidStaticValue	Cadena	Si no se encuentra una clave de pid en pidKeysList, el valor pidStaticValue se utiliza como valor pid.	- 'website' - 'landing_page'
campaignKeysList	Lista de cadenas	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.	['af_campaign', 'utm_campaign']
campaignStaticValue	Cadena	Si no se encuentra una clave de campaña en campaignKeysList, el valor campaignStaticValue se utiliza como valor c.	- 'website' - 'landing_page'
gclIdParam	Cadena	- 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].	'af_sub5'
skipList	Cadena	Si aparece alguna cadena en la lista de omisión en el referente HTTP, el Smart Script devuelve `null`.	- '[‘facebook’, ‘twitter’]' - Facebook is in the skipList by default.

Run setters

Para ejecutar los configuradores:

Obtén del marketer: cualquier otro parámetro/valor que deba contener la URL de OneLink saliente (según lo que contiene la URL entrante).
Ejecuta los configuradores utilizando la plantilla siguiente:

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

Por ejemplo:

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

Generate URLs

Para generar las URL de OneLink salientes:

Ejecuta el método generateURL en el HTML de la página web/de aterrizaje que llama al script.
Los posibles valores devueltos son:
- Una URL de Onelink saliente
- Nulo. Si el script devuelve un valor nulo, la URL existente de la página web/de aterrizaje no se modificará.

Ejemplos

Basic attribution

URL entrante:
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 saliente:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true

UTM parameters

URL entrante:
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 saliente:
https://engmntqa.onelink.me/LtRd/?pid=email&c=summer_sale&af_js_web=true

PID and campaign static values

URL entrante:
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 saliente:
https://engmntqa.onelink.me/LtRd/?pid=my_static_pid&c=my_static_cmpn&af_js_web=true

Override PIDs

URL entrante:
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 saliente:
https://engmntqa.onelink.me/LtRd/?pid=twitter_out&c=big_social&af_js_web=true

Google Click ID passthrough to af_sub

URL entrante:
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 saliente:
https://engmntqa.onelink.me/LtRd/?pid=google_lp&c=candles&af_js_web=true&af_sub4=1a2b3c

Set OneLink parameters

Para crear un enlace largo que se utilizará para enlaces profundos, puedes transmitir tanto parámetros personalizados como parámetros predefinidos. Consulta las funciones para transmitir parámetros en el script de muestra que sigue.

Para transmitir un parámetro personalizado:

Llama a la función setCustomParameter.
El setCustomParameter acepta tres argumentos:
1. [Obligatorio] La clave en la URL entrante desde la cual el script toma el valor para configurar en la URL saliente.
2. [Obligatorio] La clave que se debe especificar en la URL saliente.
3. [Opcional] Un valor alternativo estático, en caso de que la clave en el primer argumento no se encuentre en la URL.

Si no se encuentra la clave en el primer argumento y no se define ningún valor alternativo estático, se omite el parámetro.

Para transmitir un parámetro predefinido

Llama a las funciones en el script de muestra que sigue (excepto setCustomParameter).
Cada función acepta dos argumentos:
1. [Obligatorio] La clave en la URL entrante de la que el script toma el valor para configurar en la URL saliente.
2. [Opcional] Un valor alternativo estático, en caso de que la clave del primer argumento no se encuentre en la URL.

Si no se encuentra la clave en el primer argumento y no se define ningún valor alternativo estático, se omite el parámetro.

URL entrante:
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 saliente:
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

Puedes crear un enlace largo con parámetros de atribución adicionales. Consulta las funciones para transmitir parámetros en el script de muestra que sigue.

Para agregar un parámetro de atribución:

Llama a la función setCustomParameter.
El setCustomParameter acepta tres argumentos:
1. [Obligatorio] La clave del parámetro de atribución en la URL entrante desde la cual el script toma el valor para configurar en la URL saliente.
2. [Obligatorio] La clave del parámetro de atribución que se debe especificar en la URL saliente.
3. [Opcional] Un valor alternativo estático, en caso de que la clave en el primer argumento no se encuentre en la URL.

Si no se encuentra la clave en el primer argumento y no se define ningún valor alternativo estático, se omite el parámetro.

URL entrante:
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

Puedes desactivar el Smart Script para un clic en particular (por ejemplo, desde Twitter o Facebook) creando una lista de exclusión. Si alguna de las cadenas de la lista de exclusión aparece en el referente HTTP del clic, el script inteligente devuelve 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

Puedes asegurarte de que OneLink Smart Script funcione para todos los clics y nunca omita ninguno, pasando una lista de exclusión vacía.

Script:

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