OneLinkスマートスクリプト V2—Webからアプリへ誘導するURL生成ツール

概要:自動的に生成されたOneLinkをカスタマイズし、ブランドのWebサイト上のボタンやバナーに埋め込みましょう。

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

OneLinkスマートスクリプトは、Webページへ誘導するURLを使用して、アプリストアへ誘導する一意のOneLink URLを自動的に生成します。

The outgoing URLs are generated using arguments you receive from the marketer and input into the script. Note: The afParameters argument has a structure made up of several other arguments (parameters), each of which contains a configuration object that has keys, override values, and a default value.

実装ステップ

スマートスクリプトを設定するには、以下の方法があります。

Embed the script in your website

スマートスクリプトの初期化および呼び出しコードは、 AppsFlyer管理画面のスマートスクリプト生成ツール から取得することも(推奨)、開発者が 手動でインポートして呼び出す こともできます。

スマートスクリプト生成ツールを使用して実装する

  1. マーケティング担当者から、スクリプト、初期化コード、および引数を含むファイルを取得します。
  2. スマートスクリプトのテストページでスクリプトをテストし、正しい送信URLが生成されていることを確認します。
  3. スマートスクリプトの結果のテスト/使用手順 に従って進めてください。

Githubの実装例をご参照ください。

スクリプトを手動で実装する

  1. スクリプトをダウンロードしてください。
  2. マーケティング担当者から、受信パラメータと送信パラメータをどうマッピングするかのリストを受け取ります。
  3. スマートスクリプトの引数オブジェクト構成を初期化してください。
  4. Web/ランディングページのHTML内のスクリプトを以下の方法で呼び出し、URLSを生成してください:
var result = window.AF_SMART_SCRIPT.generateOneLinkURL({
  oneLinkURL,
  afParameters,
  referrerSkipList, // optional
  urlSkipList // optional
})
  1. スマートスクリプトの結果のテスト/使用手順 に従って進めてください。

スマートスクリプトの結果を確認して使用する

  1. Check the return value in result. Possible return values are:
    • 送信用OneLink URL:必要に応じて結果の値を使用します。
      例:WebサイトのCTA(アプリダウンロード)URLにリンクとして配置する、など
    • null. If the script returns null, implement your desired error flow. For example: the web/landing page's existing URL is not changed.
      var result_url = "No output from script"
      if (result) {
            result_url = result.clickURL;            
            // Put the generated OneLink URL behind CTA buttons
            document.getElementById('andrd_link').setAttribute('href', result_url);
            document.getElementById('ios_link').setAttribute('href', result_url);
            // Optionally - Create QR code from the generated OneLink URL
            window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
            //The size of the QR code is defined in the CSS file under #my_qr_code_div_id
            // #my_qr_code_div_id canvas { 
            //  height: 200px;
            //  width: 200px;
            //}
            // Optionally - fire an impression.
            // The impression will fire to https://impressions.onelink.me//.... 
            window.AF_SMART_SCRIPT.fireImpressionsLink();
      }

Use Google Tag Manager

Google Tag Managerでスマートスクリプトを設定する方法:

  1. マーケティング担当者が指示に従って、スマートスクリプトのコードをGTMに設定したことを確認します。
  2. Check the return value in AF_SMART_SCRIPT_RESULT. Possible return values are:
    • 送信用OneLink URL:必要に応じて結果の値を使用します。
      例:WebサイトのCTA(アプリダウンロード)URLにリンクとして配置する、など
    • null. If the script returns null, implement your desired error flow. For example: the web/landing page's existing URL is not changed.
      var result_url = AF_SMART_SCRIPT_RESULT.clickURL;
      if (result_url) {
            document.getElementById('andrd_link').setAttribute('href', result_url);
            document.getElementById('ios_link').setAttribute('href', result_url);
            // Optionally - Create QR code from the generated OneLink URL
            window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
            //The size of the QR code is defined in the CSS file under #my_qr_code_div_id
            // #my_qr_code_div_id canvas { 
            //  height: 200px;
            //  width: 200px;
            //}
            // Optionally - fire an impression.
            // The impression will fire to https://impressions.onelink.me//.... 
            window.AF_SMART_SCRIPT.fireImpressionsLink();            
      }
  1. スマートスクリプトのテストページでスクリプトをテストし、正しい送信URLが生成されていることを確認します。

Create a QR code with the Smart Script result

前提条件: スマートスクリプト V2.1+以降の実装

QRコードを作成する方法

  1. サイトのHTMLページに特定のIDを持つ div タグを作成して QRコードをホストしてください。
    div タグのスタイルは、好きなように設定できます。
  2. スマートスクリプトを実行して OneLink URL を生成したら、次の関数を呼び出して div ID を渡してください。
window.AF_SMART_SCRIPT.displayQrCode("my_qr_code_div_id");
  1. ベストプラクティス:結果が生成されたら、ユーザーがデスクトップでアクセスしている場合にはQRコードを表示し、ユーザーがモバイルでアクセスした際にはリンク付きのボタンを表示します。

Fire an impression

インプレッションは、ページの読み込み時、CTAやバナーの表示時などに発生させることができます。
注意: インプレッションはモバイル端末でのみ発生させることができます。デスクトップ上では発火されません。

前提条件: スマートスクリプト V2.2+

インプレッションを発火させるには:

  1. 指示に従ってスマートスクリプトを実行し、クリックURLを生成します。
  2. 結果が有効である(null ではない)ことを確認してください。
  3. 次のインプレッションファンクションを実行します:
window.AF_SMART_SCRIPT.fireImpressionsLink();

引数

Argument 備考
oneLinkURL (必須)
  • OneLinkテンプレートのドメインと、テンプレートのIDを提供してください。注意:OneLinkカスタムリンクのURLではありません。
  • yourbrand.onelink.me/A1b2
  • ブランドドメインの例:click.yourbrand.com/A1b2

afParameters

(必須)

 

 

 


mediaSource

(必須)

メディアソースのオブジェクト構成

  • Keys: ['incoming_mediasource’' 'utm_source']
  • オーバーライド値:{twitter: 'twitter_int', orig_src: 'new_src'}
  • デフォルト値: ['any_source']

campaign

キャンペーンのオブジェクト構成

  • Keys: ['incoming_campaign', 'utm_campaign']
  • オーバーライド値: {campaign_name: 'new_campaign_name'}
  • デフォルト値: ['any_campaign_name']

channel

チャネルのオブジェクト構成

  • Keys: ['incoming_channel', 'utm_channel']
  • オーバーライド値: {video: 'new_video'}
  • デフォルト値: ['any_video']

ad

広告のオブジェクト構成

  • Keys: ['incoming_ad', 'utm_ad']
  • オーバーライド値: {ad_name: 'new_ad_name'}
  • デフォルト値: ['any_ad_name']
adSet

広告セットのオブジェクト構成

  • Keys: ['incoming_adset', 'utm_adset']
  • オーバーライド値: {'adset_name': 'new_adset_name'}
  • デフォルト値: ['any_adset_name']
deepLinkValue

deep_link_value のオブジェクト構成

  • Keys: ['product_id', 'page_name']
  • オーバーライド値: {twenty_percent_off: 'thirty_percent_off'}
  • デフォルト値: 'new_offers_page'
afSub1-5

af_sub[1-5] のオブジェクト構成

 
googleClickIdKey

GCLID を持つパラメーターの名前を明記します。
AppsFlyerのローデータに表示するためには、パラメーターは、af_sub[1-5] のいずれかを使用する必要があります。

 
他の(カスタム)クエリパラメーター
  • アトリビューションやディープリンクのために、送信URLに含めたいその他のパラメータを、その構成オブジェクトとともにリストアップします。
  • カスタムパラメータの名前は、開発者が設定オブジェクトの paramKey としてリストアップします。
  • paramKey: 'deep_link_sub1'
  • Keys: ['page_id']
  • オーバーライド値: {page12: 'new_page12'}
  • Default value: 'page1'
 
referrerSkipList
特定のクリック(TwitterやFacebookなど)のHTTPリファラーに含まれる文字列のリストで、これが見つかった場合、スマートスクリプトは null を返します。この機能は、TwitterやFacebookのような、既にクリックの計測が行われているSRN媒体の場合などに有効です。  
urlSkipList 特定のクリックに対するURLに含まれる文字列(例:af_r)のうち、見つかった場合にスマートスクリプトが以下を返す文字列: null。これは、af_r を含むAppsFlyer計測リンクを使用してユーザーをモバイルサイトにリダイレクトし、元のクリックのデータが失われないようにしたい場合に便利です。  

オブジェクトの構成

OneLinkスマートスクリプトは、受信URLのパラメータとスクリプトに定義された引数を用いて、送信URLを生成します。afParameters 引数は、アトリビューションやディープリンクに使用される他のいくつかの引数(パラメータ)で構成される構造を持っており、それぞれの引数には、次の表に示すように、キー、オーバーライド(上書き)値、デフォルト値を持つオブジェクト構成が含まれています。

Argument 詳細
keys
  • 文字列の一覧
  • スクリプトが検索する受信URLに含まれる可能性のあるパラメータのリストで、その値が送信URLの値として配置されます。
  • スクリプトは左から右に向かって検索し、最初にマッチしたところで停止します。
  • 例: ['in_channel', 'utm_channel']
  • スクリプトのchannelパラメータでは、受信URLのin_channelを検索して、その値をchannelの値として使用します。

overrideValues

  • Dictionary {string: string}
  • 送信URLで変更したい値は、受信URLでの値と、置き換えたい値を列挙してください。
  • スクリプトは、受信URLに含まれるパラメータ値を、あなたが定義した値に置き換えます。 

例: {'video': 'video_new'}

スクリプトのchannel パラメータは、受信値が video の場合、スクリプトが送信URLにおいて video_new に変更します。

defaultValue
  • 文字列
  • "フォールバック" の値を何にするかを記載します。
  • キーリストからパラメータが見つからない場合は、送信URLにdefaultValueの値が使用されます。
  • 空のキーリストを渡すことで、強制的にデフォルト値を設定することができます。

例: ['web_video']

スクリプトのchannelパラメータについては、パラメータ in_channel が見つからない場合、web_videoがchannelの値として使用されます。

Basic attribution

media_source と campaignに単一のキーを使用している、受信URLから送信OneLink URLへの基本的な変換のを参照してください。

Multiple keys

media_source と campaignに複数のキーを使用している、受信URLから送信OneLink URLへの変換のを参照してください。

UTM parameters

media_source と campaignにUTMパラメーターを使用している、受信URLから送信OneLink URLへの基本的な変換のを参照してください。

Override values

受信 media_source の値を置き換えている、受信URLから送信OneLink URLへ変換のを参照してください。

Default values

受信した media_source の値が見つからない場合に、デフォルト値を使用している受信URLから送信OneLink URLへの変換のを参照してください。

Forced default values

受信 media_source の値が見つかった場合でも、デフォルト値を使用している、受信URLから送信OneLink URLへの基本的な変換のを参照してください。

Google click ID passthrough to af_sub

受信URLから、GoogleクリックIDを af_sub4 に渡している送信OneLink URLへの基本的な変換のを参照してください。:GCLIDが見つかった場合、スクリプトは受信パラメータキーワードを探し、キーワードの値を af_keywords の値として送信URLに入れます。

Facebook click ID passthrough to af_sub

受信URLから、FacebookクリックIDを af_sub2 に渡している送信OneLink URLへの基本的な変換のを参照してください。

Set attribution and OneLink parameters

AppsFlyerのアトリビューションとOneLinkパラメータを使用して、受信URLを送信OneLink URLに変換しているを参照してください。

Set additional custom parameters

追加のカスタムパラメーター (代理店向けの「af_prt」を含む) がある場合の受信URLから送信OneLink URLへコンバージョンのを参照してください。

Referrer skip list

See example of how you can disable the Smart Script for a particular click (for example, from Twitter or Facebook) by creating a skip list. If any of the strings in the skip list appear in the HTTP referrer of the click, the Smart Script returns null.

URL skip list

See example of how you can disable the Smart Script for a particular string in the URL (for example, af_r) by creating a skip list. If any of the strings in the skip list appear in the URL of the click, the Smart Script returns null.

Smart Script set up with Google Tag Manager

Google Tag Managerを使ったOneLinkスマートスクリプトの設定を使用した場合の受信URLから送信OneLink URLへの変換のを参照してください。

QR code

スマートスクリプトがQRコードを生成する方法のを参照してください。

Impression

インプレッション計測の例 を参照してください。


このページは役に立ちましたか?