[Legasi] OneLink Smart Script V1

Sekilas : Sesuaikan OneLinks yang dibuat dan disematkan secara otomatis di balik tombol atau spanduk di situs web merek Anda. Catatan: Meskipun tidak wajib, pertimbangkan untuk bermigrasi OneLink Smart Script V2

Tentang OneLink Smart Script

Pengguna tiba di situs web seluler Anda sebelum mencapai halaman toko aplikasi Anda, baik secara organik, atau melalui kampanye iklan. Namun, karena ada dua klik (yang pertama mengarah ke halaman web dan yang kedua mengarahkan dari halaman web ke app store), menimbulkan kesulitan untuk mengumpulkan metrik konversi klik dan tautan langsung (deep linking).

OneLink Smart Script memecahkan masalah ini. Skrip:

Menggunakan URL masuk yang mengarah ke halaman web untuk secara otomatis membuat URL OneLink keluar unik yang mengarah ke app store.
Menyediakan pengumpulan metrik web-to-app yang akurat untuk semua sumber media.
Dapat digunakan untuk deep linking.
Berjalan mulus di halaman web atau halaman arahan mana pun.

Prosedur

Untuk menyiapkan Smart Script, daftar tindakan prosedur berikut harus diselesaikan.

Daftar periksa prosedur
1. Impor skrip ke situs web Anda.
Inisialisasi objek Smart Script OneLinkUrlGeneratordengan parameter dan nilai.
3. [Opsional] Jalankan setter dengan parameter dan nilai tambahan.
4. Buat URL.

Import the script

Untuk mengimpor skrip ke situs web Anda :

Unduh skrip .
Impor ke situs/halaman seluler tempat Anda ingin menjalankannya.

Initialize the script

Untuk menginisialisasi skrip :

Dapatkan dari pemasar: Parameter/nilai yang harus ada pada URL OneLink keluar (berdasarkan apa yang ada di URL masuk). Lihat tabel berikut untuk detailnya.
Inisialisasi objek Smart Script OneLinkUrlGenerator menggunakan argumen (parameter).

Parameter	Jenis	Fungsionalitas	Contoh
oneLinkURL [wajib]	string	- Berfungsi sebagai dasar untuk semua tautan yang dibuat oleh skrip. - Ini adalah domain template OneLink + ID template.	yourbrand.onelink.me/A1b2 Contoh domain bermerek: click.yourbrand.com/A1b2
pidKeysList	Daftar string	- Mencantumkan parameter sumber media di URL masuk yang akan ditempatkan sebagai parameter pid di URL keluar. - Jika ada beberapa parameter sumber media di tautan masuk (misalnya af_pid dan utm_source), pidKeysList memindai parameter dari pertama hingga terakhir, dan menggunakan kecocokan pertama yang ditemukan.	['af_pid', 'utm_source']
pidOverrideList	dictionary {string: string, …}	Mencantumkan nilai sumber media di URL masuk, beserta pengganti yang Anda inginkan.	{ 'twitter': 'twitter_int', 'snapchat': 'snapchat_int', 'some_social_net': 'some_social_net_int' }
pidStaticValue	string	Jika kode pid tidak ditemukan di pidKeysList, pidStaticValue digunakan sebagai nilai pid.	- 'website' - 'landing_page'
campaignKeysList	Daftar string	Mencantumkan parameter kampanye di URL masuk yang akan ditempatkan sebagai parameter c di URL keluar.	['af_campaign', 'utm_campaign']
campaignStaticValue	string	Jika kode kampanye tidak ditemukan di campaignKeysList, campaignStaticValue akan digunakan sebagai nilai c.	- 'website' - 'landing_page'
gclIdParam	string	- Menentukan parameter mana dalam URL keluar yang membawa GCLID. - Parameter apa pun dapat dipilih. Perhatikan! Agar dapat ditampilkan di laporan data lengkap AppsFlyer, parameternya harus merupakan salah satu dari af_sub[1-5].	'af_sub5'
skipList	string	Jika ada string dalam daftar lewati yang muncul di pengarah HTTP, Smart Script menampilkan `null`.	- '[‘facebook’, ‘twitter’]' - Facebook is in the skipList by default.

Run setters

Untuk menjalankan setter :

Dapatkan dari pemasar: Parameter dan nilai lain apa pun yang harus ada di URL OneLink keluar (berdasarkan apa yang ada di URL masuk).
Jalankan setter menggunakan template berikut:

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

Contoh:

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

Generate URLs

Untuk membuat URL OneLink keluar :

Jalankan metode generateURL di HTML web/halaman arahan yang memanggil skrip.
Nilai pengembalian yang mungkin adalah:
- URL Onelink keluar
- Null. Jika skrip mengembalikan null, URL web/laman arahan yang ada tidak akan diubah.

Contoh

Basic attribution

URL masuk:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/examples/basic_url.html?af_c=gogo&af_pid=email

Skrip :

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

URL keluar :
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true

UTM parameters

URL masuk:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/utm_params.html?utm_source=email&utm_campaign=summer_sale

Skrip :

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

PID and campaign static values

URL masuk:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/static_val.html?af_not_c=gogo&af_not_pid=email

Skrip :

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

Override PIDs

URL masuk:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/override_pid.html?af_pid=twitter&af_c=big_social

Skrip :

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

Google Click ID passthrough to af_sub

URL masuk:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/gclid.html?af_pid=sms&af_c=candles&gclid=1a2b3c

Skrip :

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

Set OneLink parameters

Untuk membuat tautan panjang yang akan digunakan untuk deep linking, Anda dapat meneruskan parameter khusus dan parameter yang telah ditentukan sebelumnya. Lihat fungsi untuk meneruskan parameter dalam contoh skrip berikut.

Untuk meneruskan parameter khusus:

Panggil fungsi setCustomParameter.
setCustomParameter menerima tiga argumen:
1. [Wajib] Kode di URL masuk tempat di mana skrip mengambil nilai untuk ditetapkan di URL keluar.
2. [Wajib] Kode yang akan ditentukan di URL keluar.
3. [Opsional] Nilai fallback statis, jika kode dalam argumen pertama tidak ditemukan di URL.

Jika kode dalam argumen pertama tidak ditemukan, dan tidak ada fallback statis yang ditentukan, parameter akan dilewati.

Untuk meneruskan parameter yang telah ditentukan

Panggil fungsi dalam contoh skrip berikut (kecuali setCustomParameter).
Setiap fungsi menerima dua argumen:
1. [Wajib] Kode dalam URL masuk tempat di mana skrip mengambil nilai untuk ditetapkan di URL keluar.
2. [Opsional] Nilai fallback statis, jika kode dalam argumen pertama tidak ditemukan di URL.

Jika kode dalam argumen pertama tidak ditemukan, dan tidak ada fallback statis yang ditentukan, parameter akan dilewati.

URL masuk:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/setters.html?af_c=gogo&af_pid=email

Skrip :

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 keluar :
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_af_sub5customone_param_sub5&af_paramsaya_sub5&afsub3

Set additional attribution parameters

Anda dapat membuat tautan panjang dengan parameter atribusi tambahan. Lihat fungsi untuk meneruskan parameter dalam contoh skrip berikut.

Untuk menambahkan parameter atribusi:

Panggil fungsi setCustomParameter.
setCustomParameter menerima tiga argumen:
1. [Wajib] Kode parameter atribusi di URL masuk tempat di mana skrip mengambil nilai untuk ditetapkan di URL keluar.
2. [Wajib] Kode parameter atribusi yang akan ditentukan di URL keluar.
3. [Opsional] Nilai fallback statis, jika kode dalam argumen pertama tidak ditemukan di URL.

Jika kode dalam argumen pertama tidak ditemukan, dan tidak ada fallback statis yang ditentukan, parameter akan dilewati.

URL masuk:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/set_af_params.html?af_c=gogo&af_pid=email&partner_name=bigagency

Skrip :

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

Anda dapat menonaktifkan Smart Script untuk klik tertentu (misalnya, dari Twitter atau Facebook) dengan membuat daftar lewati. Jika salah satu string dalam daftar lewati muncul di pengarah HTTP klik, Smart Script menampilkan null.

Skrip :

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

Anda dapat memastikan bahwa OneLink Smart Script berfungsi untuk semua klik, dan tidak pernah melewati, dengan meneruskan daftar lewati yang kosong.

Skrip :

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