概要：自動的に生成されたOneLinkをカスタマイズし、ブランドのWebサイト上のボタンやバナーに埋め込みましょう。注：必須ではありませんが、OneLinkスマートスクリプトV2への移行をご検討ください。

7901 Smart Script flow 1920x1080 2 (1).png

OneLinkスマートスクリプトについて

最終的にアプリストアページに到達する前に、ユーザーは、オーガニックまたは広告キャンペーン経由でモバイルサイトを訪問します。ただし、2つのクリックが存在するため（1つ目はWebページへ遷移、2つ目はWebページからアプリストアへ遷移）、クリックのコンバージョン指標の収集とディープリンクには問題が発生します。

OneLinkスマートスクリプトはこれらの問題を解決します。スクリプトは：

Webページへ誘導するURLを使用して、アプリストアへ誘導する一意のOneLink URLを自動的に生成します。
すべてのメディアソースに対して、正確なWebからアプリへの指標を収集します。
ディープリンクに使用できます。
どんなWebページやランディングページ上でシームレスに実行できます。

手順

スマートスクリプトを設定するには、以下のアクションチェックリストの手順を完了する必要があります。

手順のチェックリスト
スクリプトをWebサイトにインポートしてください。
スマートスクリプトのオブジェクト OneLinkUrlGenerator をパラメーターと値で初期化してください。
[オプション] 追加のパラメーターと値を持つセッターを実行してください。
URLを生成してください。

Import the script

スクリプトをWebサイトにインポートする方法：

スクリプトをダウンロードしてください。
実行したいモバイルサイト／ページにインポートしてください。

Initialize the script

スクリプトを初期化する方法：

マーケティング担当者から、Outgoing OneLink URLに含まれているべきパラメーター／値（流入URLに含まれているものに基づく）を取得してください。詳細は次の表を参照してください。
引数（パラメーター）を使って、スマートスクリプトのオブジェクト OneLinkUrlGenerator を初期化してください。

パラメーター	タイプ	機能性	例
oneLinkURL (必須)	文字列	スクリプトで生成されるすべてのリンクのベースとなります。 OneLinkテンプレートのドメイン＋テンプレートIDです。	yourbrand.onelink.me/A1b2 ブランドドメインの例：click.yourbrand.com/A1b2
pidKeysList	文字列の一覧	送信側URLのpidパラメーターとして配置される受信側URLのメディアソースパラメーターを列挙します。受信側リンクに複数のメディアソースパラメーターが存在する場合（af_pidやutm_sourceなど）、pidKeysListはパラメーターを最初から最後までスキャンし、最初にマッチしたものを使用します。	['af_pid', 'utm_source']
pidOverrideList	dictionary {string: string, …}	受信側URLに含まれるメディアソースの値と、それをどのように置換したいかをリストアップしてください。	{ 'twitter': 'twitter_int', 'snapchat': 'snapchat_int', 'some_social_net': 'some_social_net_int' }
pidStaticValue	文字列	pidKeysList にpidが見つからない場合、pidStaticValue がpidとして使用されます。	'website' 'landing_page'
campaignKeysList	文字列の一覧	送信側URLの c パラメーターとして配置される受信側URLのキャンペーンパラメーターの一覧。	['af_campaign', 'utm_campaign']
campaignStaticValue	文字列	campaignKeysList にキャンペーンキーが見つからない場合は、c値として campaignStaticValue が使用されます。	'website' 'landing_page'
gclIdParam	文字列	送信側URLのどのパラメーターがGCLIDを含むかを定義します。どのパラメーターも選択できます。注！AppsFlyerのローデータに表示するためには、パラメーターは、af_sub[1-5] のいずれかを使用する必要があります。	'af_sub5'
skipList	文字列	スキップリストに含まれる文字列がHTTPリファラーに含まれている場合、スマートスクリプトは `null` を返します。	'[‘facebook’, ‘twitter’]' Facebookはデフォルトで skipList に含まれています。

Run setters

settersを実行する方法：

マーケティング担当者から、送信側 OneLink URLに含まれているべきパラメーター／値（受信側URLに含まれているものに基づく）を取得してください。
次のテンプレートを使用して setter を実行してください。

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

例：

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

Generate URLs

送信側OneLink URLの生成方法：

スクリプトを呼び出すWeb/ランディングページのHTMLで、generateURL メソッドを実行してください。
可能な戻り値は：
- 送信側OneLink URL
- Null。スクリプトが null を返す場合、Web／ランディングページの既存URLは変更されません。

例

Basic attribution

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

スクリプト：

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

送信側URL：
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true

UTM parameters

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

スクリプト：

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

PID and campaign static values

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

スクリプト：

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

Override PIDs

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

スクリプト：

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

Google Click ID passthrough to af_sub

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

スクリプト：

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

Set OneLink parameters

ディープリンクに使用するロングリンクを作成するには、カスタムパラメーターと定義済みパラメーターの両方を渡すことができます。次のサンプルスクリプトで、パラメーターを渡す関数をご覧ください。

カスタムパラメーターを渡す方法：

setCustomParameter 関数を呼び出してください。
setCustomParameter は3つの引数を受け入れます：
1. [必須] 送信側URLの値を設定するためにスクリプトが取得する受信側URLのキー。
2. [必須] 送信側URLで指定すべきキー。
3. [オプション] 最初の引数がURLで見つからなかった場合の静的フォールバック値。

第1引数のキーが見つからず、静的フォールバックも定義されていない場合、そのパラメーターはスキップされます。

定義済みのパラメーターを渡す方法

次のサンプルスクリプトの関数を呼び出してください（setCustomParameterを除く）。
各関数は2つの引数を受け入れます：
1. [必須] 送信側URLの値を設定するためにスクリプトが取得する受信側URLのキー。
2. [オプション] 最初の引数がURLで見つからなかった場合の静的フォールバック値。

第1引数のキーが見つからず、静的フォールバックも定義されていない場合、そのパラメーターはスキップされます。

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

スクリプト：

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

計測パラメーターを追加したロングリンクを作成することができます。次のサンプルスクリプトで、パラメーターを渡す関数をご覧ください。

計測パラメーターを追加する方法：

setCustomParameter 関数を呼び出してください。
setCustomParameter は3つの引数を受け入れます：
1. [必須] 送信側URLの値を設定するためにスクリプトが取得する受信側URLの計測パラメーターのキー。
2. [必須] 送信側URLで指定すべき計測パラメーターのキー。
3. [オプション] 最初の引数がURLで見つからなかった場合の静的フォールバック値。

第1引数のキーが見つからず、静的フォールバックも定義されていない場合、そのパラメーターはスキップされます。

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

スクリプト：

onelinkGenerator.setCustomParameter("partner_name", "af_prt", "defaultPartner");
onelinkGenerator.setCustomParameter("incoming_site_id", "af_siteid", "defaultSiteID");

送信側URL:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true&af_prt=bigagency&af_siteid=defaultSiteID

Skip clicks from Twitter or Facebook

スキップリストを作成することで、スマートスクリプトを特定のクリック（例：TwitterやFacebookなど）に対して無効にすることができます。クリックのHTTPリファラにスキップリストの文字列が含まれている場合、スマートスクリプトは null を返します。

スクリプト：

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

空のスキップリストを渡すことで、OneLinkスマートスクリプトが全てのクリックに機能し、スキップしないようにすることができます。

スクリプト：

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