[Hérité] Script intelligent OneLink V1

En bref : personnalisez les OneLinks qui seront automatiquement générés et intégrés à un bouton ou une bannière sur le site de votre marque. Remarque : même si cela n'est pas obligatoire, nous vous conseillons de migrer vers OneLink Smart Script V2.

À propos de OneLink Smart Script

Les utilisateurs passent par votre site web mobile pour atteindre la page de votre app store, soit de manière organique, soit via des campagnes publicitaires. Cependant, étant donné que deux clics sont nécessaires (le premier mène à la page web et le second va de la page web à l'app store), la collecte des mesures de conversion des clics et des données de deep linking est problématique.

OneLink Smart Script résout ces problèmes. Le script :

Utilise les URL entrantes qui mènent à la page web pour générer automatiquement des URL OneLink sortantes uniques qui mènent à l'app store.
Fournit une collecte précise d'indicateurs web-to-app pour toutes les sources média.
Peut être utilisé pour le deep linking.
S'exécute en toute transparence sur n'importe quelle page web ou de destination.

Procédures

Les procédures suivantes permettent de configurer Smart Script :

Étapes de la procédure
1. Importer le script sur votre site web.
Initialiser l'objet Smart Script OneLinkUrlGenerator avec les paramètres et valeurs.
3. [Facultatif] Exécuter les setters avec les paramètres et valeurs complémentaires.
4. Générer les URL.

Import the script

Pour importer le script sur votre site web :

Télécharger le script.
L'importer dans le ou les sites mobile sur lesquels vous souhaitez qu'il s'exécute.

Initialize the script

Pour initialiser le script :

Récupérer les paramètres/valeurs que l'URL OneLink sortante doit contenir (selon ce qui est contenu dans l'URL entrante) auprès du marketeur. Reportez-vous au tableau suivant pour plus de détails.
Initialisez l’objet Smart Script OneLinkUrlGenerator en utilisant les arguments (paramètres).

Paramètre	Type	Fonctionnalité	Exemple
oneLinkURL [obligatoire]	chaîne	Sert de base à tous les liens générés par le script. Il s'agit du domaine de template OneLink + l'ID de template.	votremarque.onelink.moi/A1b2 Exemple de domaine de marque : clic.votremarque.com/A1b2
pidKeysList	Liste des chaînes de caractères	Liste le(s) paramètre(s) de source de média de l'URL entrant à placer comme paramètre pid dans l'URL sortant. - S'il existe plusieurs paramètres de source média dans le lien entrant (ex : af_pid et utm_source), la pidKeysList scanne dans l'ordre les paramètres et utilise la première correspondance qu'il trouve.	['af_pid', 'utm_source']
pidOverrideList	dictionary {string: string, …}	Répertorie les valeurs de la source média dans l'URL entrante, ainsi que celles par lesquelles vous souhaitez les remplacer.	{ 'twitter': 'twitter_int', 'snapchat': 'snapchat_int', 'some_social_net': 'some_social_net_int' }
pidStaticValue	chaîne	Si aucune clé pid ne figure dans la pidKeysList, la valeur pid pidStaticValue est utilisée.	- 'website' - 'landing_page'
campaignKeysList	Liste des chaînes de caractères	Répertorie les paramètres de campagne dans l'URL entrante qui sera placée en tant que paramètre c dans l'URL sortante.	['af_campaign', 'utm_campaign']
campaignStaticValue	chaîne	Si aucune clé de campagne ne figure dans campaignKeysList, la valeur campaignStaticValue est utilisée.	- 'website' - 'landing_page'
gclIdParam	chaîne	Définit le paramètre de l'URL sortante qui porte le GCLID. - Tous les paramètres peuvent être choisis. Important ! Pour s'afficher dans les rapports de données brutes AppsFlyer, le paramètre doit être l'un des suivants : af_sub[1-5].	'af_sub5'
skipList	chaîne	Dans le cas où l'une des chaînes de la liste d'exclusion apparaît dans le référent HTTP, le smart script renvoie `null`.	- '[‘facebook’, ‘twitter’]' - Facebook is in the skipList by default.

Run setters

Pour exécuter des paramètres :

Récupérer tous les autres paramètres et valeurs que l'URL OneLink sortante doit contenir (selon ce qui est contenu dans l'URL entrante) auprès du marketeur.
Exécutez les paramètres en utilisant le modèle qui suit :

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

Par exemple :

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

Generate URLs

Pour générer des URL OneLink sortantes :

Exécuter la méthode generateURL dans le code HTML de la page web/d'accueil qui appelle le script.
Les valeurs de retour possibles sont les suivantes :
- Une URL Onelink sortante
- Null. Si le script renvoie la valeur Null, l'URL existante de la page web/d'accueil n'est pas modifiée.

Exemples

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

Set OneLink parameters

Pour créer un lien long de deep linking, vous pouvez utiliser à la fois des paramètres personnalisés et des paramètres prédéfinis. Voir les fonctions de transmission des paramètres dans l'exemple de script qui suit.

Pour transmettre un paramètre personnalisé :

Appelez la fonction setCustomParameter.
Le setCustomParameter accepte trois arguments :
1. [Obligatoire] La clé de l'URL entrante où le script récupère la valeur à utiliser dans l'URL sortante.
2. [Obligatoire] La clé à indiquer dans l'URL sortante.
3. [Facultatif] Une valeur de secours fixe, au cas où la clé du premier argument n'est pas trouvée dans l'URL.

Si la clé dans le premier argument n'est pas trouvée et qu'aucun secours statique n'est définie, le paramètre est ignoré.

Pour transmettre un paramètre prédéfini

Appelez la ou les fonctions dans l’exemple de script suivant (sauf setCustomParameter).
Chaque fonction accepte deux arguments : 1. [Obligatoire] La clé de l'URL entrante où le script récupère la valeur à utiliser dans l'URL sortante. 2. [Facultatif] Une valeur de secours fixe, au cas où la clé du premier argument n'est pas trouvée dans l'URL.

Si la clé dans le premier argument n'est pas trouvée et qu'aucun secours statique n'est définie, le paramètre est ignoré.

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 sortante :
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

Vous pouvez créer un lien long avec des paramètres d'attribution supplémentaires. Voir les fonctions de transmission des paramètres dans l'exemple de script qui suit.

Pour ajouter un paramètre d'attribution :

Appelez la fonction setCustomParameter.
Le setCustomParameter accepte trois arguments :
1. [Obligatoire] La clé du paramètre d'attribution de l'URL entrante où le script récupère la valeur à utiliser dans l'URL sortante.
2. [Obligatoire] La clé du paramètre d'attribution à indiquer dans l'URL sortante.
3. [Facultatif] Une valeur de secours fixe, au cas où la clé du premier argument n'est pas trouvée dans l'URL.

Si la clé dans le premier argument n'est pas trouvée et qu'aucun secours statique n'est définie, le paramètre est ignoré.

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

Vous pouvez désactiver le Smart Script pour certains clics (ex : depuis Twitter ou Facebook) en créant une liste d'exclusion. Si l'une des chaînes de la liste d'exclusion apparaît dans le référent HTTP du clic, le Smart Script renvoie 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

Vous pouvez vous assurer que le Smart Script OneLink fonctionne pour tous les clics et n'en ignore aucun en définissant une liste d'exclusion vide.

Script :

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