Web SDKを使用してWebサイトにAppsFlyerを実装し、訪問、イベント、コンバージョン、収益を記録・計測します。
Web SDKの利用・実装ガイド
- Web SDKのJavaScriptタグには、以下の特徴があります。
- 複数のプラットフォームを横断するユーザージャーニーを分析する、People-Based Attribution(PBA)ソリューションの一部です。
- Webサイトへの訪問とユーザーの操作を、AppsFlyerプラットフォームに送信します。
- Webサイト用のプラグインモジュールで、プログラミングは不要です。 Webサイト訪問者のOSやブラウザに依存しません。
- サイズ:40~60Kb。
- AppsFlyerのモバイルSDKと併せてWeb SDKを実装すると、モバイルアプリとWebを横断するユーザーの行動を記録し、関連付けることができます。
- Webサイト外で発生するイベントは、Webサーバー間イベントAPI(Web S2S)で記録できます。
コードスニペットの選択
実装方法とセキュリティ要件に合ったスニペットを選択してください。以下の2種類があります。
- 標準Web SDK:標準的な実装方法です。
- Advanced SDK Verification:Web SDKのサプライチェーン保護を追加する、セキュリティを強化した実装方法です。 CDNの侵害、DNSハイジャック、中間者攻撃に対する保護をさらに強化したい場合に使用してください。
重要
標準Web SDKからAdvanced SDK Verificationに切り替える場合は、既存のスニペットを新しいものに置き換えてください。既存のスニペットに新しいスニペットを追加しないでください。
標準Web SDK
標準のWeb SDKを実装するには、このスニペットを使用してください。 SDKを読み込むすべてのページで、<head>タグの先頭付近に貼り付けてください。
Smart Bannersを使用しない場合
<script>
// Queue — buffers AF() calls until the SDK is ready
window.AppsFlyerSdkObject = "AF";
window.AF = window.AF || function() {
(window.AF.q = window.AF.q || []).push([Date.now()].concat(Array.prototype.slice.call(arguments)));
};
window.AF.id = window.AF.id || { pba: { webAppId: "WEB_DEV_KEY" } };
window.AF.plugins = {};
// Inject SDK
var o = document.createElement("script"),
p = document.getElementsByTagName("script")[0];
o.async = 1;
o.src = "https://websdk.appsflyersdk.com?" + "st=pba&af_id=WEB_DEV_KEY";
p.parentNode.insertBefore(o, p);
</script>
Smart Bannersを使用する場合
<script>
// Queue — buffers AF() calls until the SDK is ready
window.AppsFlyerSdkObject = "AF";
window.AF = window.AF || function() {
(window.AF.q = window.AF.q || []).push([Date.now()].concat(Array.prototype.slice.call(arguments)));
};
window.AF.id = window.AF.id || { pba: { webAppId: "WEB_DEV_KEY" }, banners: { key: "YOUR_BANNER_KEY" } };
window.AF.plugins = {};
// Inject SDK
var o = document.createElement("script"),
p = document.getElementsByTagName("script")[0];
o.async = 1;
o.src = "https://websdk.appsflyersdk.com?" + "st=pba,banners&af_id=WEB_DEV_KEY";
p.parentNode.insertBefore(o, p);
AF('banners', 'showBanner');
</script>
Advanced SDK Verification
Advanced SDK Verificationは、Web SDKのサプライチェーン保護を追加します。ユーザーのブラウザで実行されるコードが、AppsFlyerが公開したものと完全に一致することを保証します。 SDK自体のソースコードは標準の実装と同じで、配信と検証の仕組みだけが異なります。
Advanced SDK Verificationには、以下の特徴があります。
- CDNの侵害、DNSハイジャック、中間者攻撃に対する保護を強化します。
- SDKの読み込み時間が約250ミリ秒長くなります。
Advanced SDK Verificationの使用は任意です。標準の実装も引き続き全面的にサポートされており、サードパーティの分析ピクセルでは業界標準の方法です。 Advanced SDK Verificationは、この標準的な保護に加えて、さらに保護を強化します。
Webサイトでnonceを使用したコンテンツセキュリティポリシー(CSP)を適用している場合は、「プライバシーの管理」セクションのコンテンツセキュリティポリシー(CSP)を参照し、nonce対応版のスニペットを使用してください。
Smart Bannersを使用しない場合
<script>
// Queue — buffers AF() calls until the SDK is ready
window.AppsFlyerSdkObject = "AF";
window.AF = window.AF || function() {
(window.AF.q = window.AF.q || []).push([Date.now()].concat(Array.prototype.slice.call(arguments)));
};
window.AF.id = window.AF.id || { pba: { webAppId: "WEB_DEV_KEY" } };
window.AF.plugins = {};
// Manifest loader config
window.AF_LOADER_CONFIG = {
baseUrl: "https://websdk.appsflyersdk.com",
plugins: ["pba"]
};
// Inject manifest loader
var loaderScript = document.createElement("script");
loaderScript.src = "https://websdk.appsflyersdk.com/manifestLoader.v1.js";
loaderScript.integrity = "sha384-Uncl2YwvjFpFz0PwEfl3bL/0JsOQcDFEpwXHzcN0MBavn9vvFEx5pZxADTq8h+CV";
loaderScript.crossOrigin = "anonymous";
loaderScript.async = true;
document.head.appendChild(loaderScript);
</script>
Smart Bannersを使用する場合
<script>
// Queue — buffers AF() calls until the SDK is ready
window.AppsFlyerSdkObject = "AF";
window.AF = window.AF || function() {
(window.AF.q = window.AF.q || []).push([Date.now()].concat(Array.prototype.slice.call(arguments)));
};
window.AF.id = window.AF.id || { pba: { webAppId: "WEB_DEV_KEY" }, banners: { key: "YOUR_BANNER_KEY" } };
window.AF.plugins = {};
// Manifest loader config
window.AF_LOADER_CONFIG = {
baseUrl: "https://websdk.appsflyersdk.com",
plugins: ["banners", "pba"]
};
// Inject manifest loader
var loaderScript = document.createElement("script");
loaderScript.src = "https://websdk.appsflyersdk.com/manifestLoader.v1.js";
loaderScript.integrity = "sha384-Uncl2YwvjFpFz0PwEfl3bL/0JsOQcDFEpwXHzcN0MBavn9vvFEx5pZxADTq8h+CV";
loaderScript.crossOrigin = "anonymous";
loaderScript.async = true;
document.head.appendChild(loaderScript);
</script>
WebサイトへのWeb SDKの実装
導入と実装
考慮事項と必要な対応
| 実装チェックリスト |
|---|
| 訪問とイベントを確実に記録するため、Web SDKをWebサイトのすべてのページに実装してください。 |
| ページの読み込み時にできるだけ早く実行されるよう、上記で選択したスニペットを配置してください。そのためには、headタグの先頭付近にコードを配置します。 |
|
Google Tag Manager(GTM)を使用してSDKを実装する場合:
|
| Web SDKは、Smart Bannersを使用する場合と使用しない場合のどちらでも実装できます。以下の該当する手順に従ってください。 |
|
実装に必須の要件
テストツールを使用した実装の検証 |
事前準備:
- マーケターに、ブランドバンドルを作成済みか確認してください。
- 詳細は、PBAの導入ガイドを参照してください。
- Smart Banners専用のWeb SDKをすでに実装している場合は、既存のSDKを削除し、Smart BannersとPBAの両方に対応するWeb SDKに置き換えてください。PBA専用のWeb SDKを単に追加しないでください。
以下を実施してください。
- Web SDKのWeb Devキーを取得します。 注意:モバイルアプリで使用するキーとは異なります。
-
Web Devキーを取得するには:
- AppsFlyerの上部メニューで、マイアプリタブを選択します。
- [ブランドバンドルを表示]をクリックします。
- 対象のWeb Devキーをコピーします。 (WEB_DEV_KEY)
-
Web Devキーを取得するには:
- Smart Bannersを使用する場合は、Smart Bannerキーを取得します。
-
Smart Bannerキーを取得するには:
- AppsFlyerのサイドメニューで、Engage > Web to App > Smart Bannersを選択します。
- 対象のSmart Bannerキーをコピーします。
-
Smart Bannerキーを取得するには:
- Webサイトのheadタグ内にスクリプトを追加する権限を用意します。
- Google Tag Managerを使用する場合は、Webサイトに実装しておく必要があります。
以下のいずれかの方法で、Web SDKを実装してください。
直接実装
JavaScriptコードスニペット
以下のいずれかの方法で、Web SDKを実装します。
Smart Bannersを使用せずにWeb SDKを実装するには:
- Webサイトのすべてのページで、以下の手順を繰り返してください。
- 以下のコードスニペットの
WEB_DEV_KEYを、前提条件で取得したキーに置き換えます。 - 上記で選択したコードスニペットを、Webサイトのheadタグ内に貼り付けます。 headタグの先頭付近に貼り付けてください。
Smart Bannersを使用してWeb SDKを実装するには:
- Webサイトのすべてのページで、以下の手順を繰り返してください。
-
上記で選択したコードスニペットの
WEB_DEV_KEYとYOUR_BANNER_KEYを、前提条件で取得したキーに置き換えます。 - このコードスニペットを、Webサイトのheadタグ内に貼り付けます。 headタグの先頭付近に貼り付けてください。
Google Tag Manager
Google Tag Manager(GTM)でWeb SDKを実装するには:
- Google Tag Managerを開きます。
-
AppsFlyer Web SDK用の新しいタグを作成します。
- タグの種類にカスタムHTMLを選択します。
- 内容がわかるタグ名を付けます。
- 以下のいずれかを行います。
- 保存をクリックします。
- 以下のいずれかを行います。
-
すべてのページにトリガーを追加する場合:
-
[トリガーを追加]をクリックします。
- All Pagesを選択します。
- 保存をクリックします。
- タグ名を入力し、保存をクリックします。
これで手順は完了です。
-
-
特定のページにトリガーを追加する場合:
- [タグを保存]をクリックします。
- GTMのメイン画面で、トリガーを選択します。新規をクリックします。
- 鉛筆アイコンをクリックします。
- トリガーの種類にページビューを選択します。
- 一部のページビューを選択します。
- 必要に応じて、ページとトリガーの条件を設定します。
- 保存をクリックします。
- トリガーをAppsFlyer Web SDKのタグに関連付けます。以下の手順で設定します。
- GTMのメイン画面で「タグ」を選択します。
- 先ほど作成したタグを選択します。
- トリガーのパネルで鉛筆アイコンをクリックします。
-
先ほど作成したページビュートリガーを選択します。
- 保存をクリックします。
-
すべてのページにトリガーを追加する場合:
Adobe Launch Tag Manager
- Adobe Experience Cloudでのプロパティの作成
- Adobe LaunchプロパティへのWeb SDKの追加
- WebサイトへのAdobe Launchタグの追加
- Adobe Launch環境の公開
Adobe Experience Cloudでのプロパティの作成
- Adobe Experience Cloud > Launchを開きます。
- Adobe Experience Cloud Launchで、Go to Launchをクリックします。
- New Propertyをクリックします。
- プロパティ名を入力します。
- PlatformでWebを選択します。
- Webサイトのドメインを入力します。
- Saveをクリックします。
Adobe LaunchプロパティへのWeb SDKの追加
- My web propertyページで、Rulesタブを選択します。
- ルール名を入力します。 Load web SDKという名前を推奨します。
-
IFセクションのEVENTSで、+Addをクリックします。
- Event Typeで、Core - DOM Readyを選択します。
- Keep Changesをクリックします。
-
THENセクションのActionsで、+Addをクリックします。
- Action Type > Custom Codeを選択します。
- JavaScript > Open Editorを選択し、<script>タグを除いたWeb SDKスニペットを貼り付けます。
- Keep Changesをクリックして、コードエディターを閉じます。
- Saveをクリックします。
WebサイトへのAdobe Launchタグの追加
- My web propertyページで、Environmentsタブを選択します。
- 公開する環境(開発環境または本番環境)の行を探します。
- INSTALLの見出しの下で、該当する行のボックスアイコンをクリックします。通常は本番環境の行です。
- Adobe Launch環境の公開に関するセクションを参照してください。
-
Web Install Instructionsダイアログで、以下を行います。
- スクリプトのコードスニペットをコピーします。
- ダイアログを閉じます。
- コードスニペットをWebサイトの<head>タグ内に貼り付けます。
Adobe Launch環境の公開
- My web propertyページで、Publishingタブを開きます。
-
Developmentセクションで、Add New Libraryをクリックします。
- ライブラリ名を入力し、環境を選択します。
- RESOURCE CHANGESで、Add a Resourceをクリックします。
- Rules > Load web SDK > Latest > Select & Create a New Revisionをクリックします。
- Saveをクリックします。
-
Developmentセクションで、以下を行います。
- 新しく作成したライブラリの横にある操作メニュー(3点アイコン)をクリックし、Build for Developmentを選択します。
- もう一度操作メニューをクリックし、Submit for Approvalを選択します。
-
Submittedセクションで、以下を行います。
- 操作メニューをクリックし、Build for Stagingを選択します。
- もう一度操作メニューをクリックし、Approve for Publishingを選択します。
-
Approvedセクションで、以下を行います。
- 操作メニューをクリックし、Build & Publish to Productionを選択します。
- これで手順は完了です。
モバイルデバイスでWebサイトが読み込まれると、有効なクリエイティブがバナーに表示されます。特定のページやユーザーの操作に応じてバナーを表示するには、Adobe Launchのルールを参照してください。
SDKの動作確認
実装後は、訪問者のブラウザからAppsFlyer Web SDKが呼び出され、メッセージが送信されていることを確認してください。ブラウザに表示される、メッセージのネットワーク通信を調べて確認します。
SDKが読み込まれ、動作していることを確認するには:
- Webサイトを開きます。
-
ブラウザの開発者ツールを開きます。
- (A)Networkタブを開きます。
- ページを再読み込みします。
- (B)wa.appsflyerで絞り込みます。
- (C)eventsメッセージを選択します。
- Headersタブの(D)で、以下を確認します。
- Request URLがwa.appsflyer.com/eventsになっていること。
- site_idクエリパラメータが
WEB_DEV_KEYになっていること。 - (E)ステータスコードが200になっていること。
- site_idの値が、ブランドバンドル設定の
WEB_DEV_KEYの値と一致していることを確認します。- AppsFlyerのサイドメニューで、設定 > ブランドバンドルを選択します。
- Web Devキーをクリックして、キーをコピーします。
- ブラウザの新しいタブやメモ帳など、任意の場所に貼り付けて、キーを表示します。
- site_idと
WEB_DEV_KEYが一致していることを確認します。
- SDKが1回だけ読み込まれることを確認してください。 SDKが複数回読み込まれると、動作しなくなる場合があります。
イベント送信のオプトイン / オプトアウト
Web SDKは、訪問者のイベントデータをAppsFlyerに送信します。本セクションの方法で、イベント送信の制御、停止、開始ができます。
以下の点を考慮してください。
- SDKの初期状態設定:Webページの初回読み込み時にイベントを送信するか、明示的な開始コマンドを受け取るまで待機するかを決定します。この設定は、Webスニペットに含まれます。
-
コマンドによる明示的な制御:イベント送信の停止や開始に使用します。たとえば、データ収集への同意を取得するオプトイン / オプトアウトバナー(Cookie同意バナー)を使用する場合は、バナーの操作にコマンドを組み込んで、イベント送信を開始・停止できます。この明示的な制御はSDKの初期状態設定より優先され、以下の特徴を持つ永続的なファーストパーティCookieを使用します。
- Webサイトのドメインに設定されます。
- Web SDKまたはブラウザが定める期間が経過すると、有効期限が切れます。 Cookieの有効期限が切れると、Web SDKは初期状態設定に戻ります。
-
Web SDKのCookieは、ブラウザ固有のCookie設定を妨げることはなく、常にその設定に従います。
SDKの初期状態設定
| 設定 | 必要なスニペット |
|---|---|
| [デフォルト]イベントを送信 |
Web SDKスニペットを以下のように変更します。 必要に応じて、measurementStatusパラメータを追加します。 measurementStatus=trueを設定します。
|
|
イベントを送信しない
|
Web SDKスニペットを以下のように変更します。必要に応じて、measurementStatusパラメータを追加します。 measurementStatus=falseを設定します。 |
コマンドによる明示的な制御
| 操作 | コマンド |
|---|---|
| イベント送信の開始(オプトイン) | window.AF_SDK.PLUGINS.PBA.enableMeasurement() |
| イベント送信の停止(オプトアウト) | window.AF_SDK.PLUGINS.PBA.disableMeasurement() |
コンテンツセキュリティポリシー(CSP)の適用
Webサイトで厳格なセキュリティやデータプライバシーの対策が必要な場合は、以下の仕組みを使って、Web SDKによる環境やデータへのアクセス方法を設定してください。
コンテンツセキュリティポリシー(CSP)
WebサイトのJavaScriptをCSPで保護する必要がある場合、Web SDKはCSPの設定に応じた2つの方法に対応しています。
-
selfを使用するCSP:
https://websdk.appsflyersdk.comをscript-srcの許可リストに追加してください。標準Web SDKとAdvanced SDK Verificationの両方で利用できます。 -
nonceを使用するCSP:ポリシーで
script-src 'nonce-...'を使用する場合は、Advanced SDK Verificationのnonce対応版を利用できます。この方法では、検証処理に必要な3つのscriptタグすべてにnonceが渡されます。{{CSP_NONCE}}を、サーバーがリクエストごとに生成するnonceの値に置き換えてください。
以下の表は、nonce対応版と各CSPポリシーの互換性を示しています。
| ポリシー | 動作可否 | 補足 |
|---|---|---|
script-src 'self' |
不可 | 外部CDNのオリジンが許可されず、インラインスクリプトもブロックされます。 |
script-src 'self' https://websdk.appsflyersdk.com |
一部のみ | ローダーとSDKは許可されますが、インラインの設定スクリプトは引き続きブロックされます。 |
script-src 'nonce-...' https://websdk.appsflyersdk.com |
可 | nonceがインラインスクリプトとローダーを許可し、SDKのタグにはローダーからnonceが渡されます。 |
script-src 'nonce-...' 'strict-dynamic' |
可(推奨) | nonceがインラインスクリプトとローダーを許可し、strict-dynamicによって、動的に挿入されたSDKのタグにも信頼が引き継がれます。許可リストにCDNのオリジンを追加する必要はありません。 |
CSP nonceを使用するAdvanced SDK Verificationのスニペット
Smart Bannersを使用しない場合
<script nonce="{{CSP_NONCE}}">
// Queue — buffers AF() calls until the SDK is ready
window.AppsFlyerSdkObject = "AF";
window.AF = window.AF || function() {
(window.AF.q = window.AF.q || []).push([Date.now()].concat(Array.prototype.slice.call(arguments)));
};
window.AF.id = window.AF.id || { pba: { webAppId: "WEB_DEV_KEY" } };
window.AF.plugins = {};
// Manifest loader config — nonce forwarded to the injected SDK <script> tag
window.AF_LOADER_CONFIG = {
baseUrl: "https://websdk.appsflyersdk.com",
plugins: ["pba"],
nonce: "{{CSP_NONCE}}"
};
// Inject manifest loader
var loaderScript = document.createElement("script");
loaderScript.src = "https://websdk.appsflyersdk.com/manifestLoader.v1.js";
loaderScript.integrity = "sha384-Uncl2YwvjFpFz0PwEfl3bL/0JsOQcDFEpwXHzcN0MBavn9vvFEx5pZxADTq8h+CV";
loaderScript.crossOrigin = "anonymous";
loaderScript.nonce = "{{CSP_NONCE}}";
loaderScript.async = true;
document.head.appendChild(loaderScript);
</script>
Smart Bannersを使用する場合
<script nonce="{{CSP_NONCE}}">
// Queue — buffers AF() calls until the SDK is ready
window.AppsFlyerSdkObject = "AF";
window.AF = window.AF || function() {
(window.AF.q = window.AF.q || []).push([Date.now()].concat(Array.prototype.slice.call(arguments)));
};
window.AF.id = window.AF.id || { pba: { webAppId: "WEB_DEV_KEY" }, banners: { key: "YOUR_BANNER_KEY" } };
window.AF.plugins = {};
// Manifest loader config — nonce forwarded to the injected SDK <script> tag
window.AF_LOADER_CONFIG = {
baseUrl: "https://websdk.appsflyersdk.com",
plugins: ["banners", "pba"],
nonce: "{{CSP_NONCE}}"
};
// Inject manifest loader
var loaderScript = document.createElement("script");
loaderScript.src = "https://websdk.appsflyersdk.com/manifestLoader.v1.js";
loaderScript.integrity = "sha384-Uncl2YwvjFpFz0PwEfl3bL/0JsOQcDFEpwXHzcN0MBavn9vvFEx5pZxADTq8h+CV";
loaderScript.crossOrigin = "anonymous";
loaderScript.nonce = "{{CSP_NONCE}}";
loaderScript.async = true;
document.head.appendChild(loaderScript);
</script>
クエリパラメータの破棄
クエリパラメータにAppsFlyerで記録したくないデータが含まれる場合は、一部またはすべてのクエリパラメータを破棄するよう指定できます。破棄したパラメータは、ローデータやレポートには含まれません。
以下の方法は、URL、リファラ、header_refererに対して適用できます。
クエリパラメータの破棄方法
| 方法 | 説明 |
|---|---|
| すべてのクエリパラメータを破棄 | URLにaf_url=trueを追加します。 |
| 指定したクエリパラメータを破棄 |
破棄するパラメータを指定するには、クエリパラメータのマスクを設定します。 例: マスクを設定したURL:
破棄後のURL:
|
イベント記録の仕組み
コンバージョンイベントと標準イベント
- SDKはユーザーイベントを記録し、AppsFlyerプラットフォームに送信します。
- AppsFlyerは、マーケターが設定したコンバージョンイベントのリストに基づき、イベントを標準イベントとコンバージョンイベントに分類します。
- コンバージョンイベントのデータは、PBAダッシュボードで確認できます。
- コンバージョンイベントと標準イベントのデータは、ローデータレポートで確認できます。
コンバージョンイベント
- コンバージョンイベントは、マーケティング施策やビジネスの成果を把握するための情報を提供します。購入、ダウンロード、会員登録、サブスクリプションの登録などが該当します。
- PBAは、Webサイトへの訪問につながったメディアソースに、コンバージョンイベントをアトリビューションします。
- アトリビューション先のメディアソースを特定することで、各メディアソースが誘導したユーザーの質を計測し、比較できます。
- コンバージョンイベントは、収益の記録とROIの算出に使用されます。
- 特定のメディアソースに投じた広告予算と、そのメディアソースから流入したユーザーがもたらした収益を比較する際に活用してください。
標準イベント
- 標準イベントは、コンバージョンに至るユーザージャーニーやファネルの検証に使用します。
- ユーザーの行動を計測し、エンゲージメントの高いユーザーを誘導するメディアソースを把握できます。
- ユーザーの行動を記録し、リエンゲージメントキャンペーンの対象ユーザーを識別するためにも使用できます。
イベントの記録
ランディングページの読み込み時や、ユーザーがWebサイトの要素を操作したときなど、特定の条件を満たした時点でWeb SDKを呼び出し、イベントを記録します。イベント記録の例を参照してください。
カスタマーユーザーID(CUID)によるユーザー識別
- AppsFlyerでは、ユーザー側で割り当てた一意のCUIDを使って、Webユーザーを識別します。通常、CUIDはバックエンドサーバーで管理します。
- モバイル環境で使用しているものと同じCUIDの値を使用してください。これにより、複数のプラットフォームを横断したユーザーの行動を総合的に把握できます。モバイルSDKでは、setCustomerUserId関数を使用します(iOS、Android、Unity)。
-
Web SDKでCUIDを設定するには:
- CUIDを取得できた時点で、できるだけ早く設定してください。通常は、ユーザーがログインまたは会員登録して、本人を識別できるようになるまで待つ必要があります。
-
以下の例のように、JavaScriptからsetCustomerUserId()を呼び出してください。
注意: CUIDが数値の場合も、文字列として送信してください。そのために、値を引用符で囲んでください。
- Web S2Sを実装する場合、バックエンドでCUIDとWeb訪問者IDを関連付ける際に、PBAへの通知が必要になる場合があります。
- CUIDに、電話番号やメールアドレスなどの個人を直接識別できる情報を含めないでください。
例:CUIDの設定
// Associate all current user web events to distinct ID 663274
AF('pba', 'setCustomerUserId' , '663274')
Web SDKのイベントパラメータ
| パラメータ名 | 必須 | 説明 |
|---|---|---|
| eventType | はい |
イベントタイプ 形式:文字列 このパラメータには、常にEVENTを設定してください。 例:eventType: "EVENT" |
| eventName | はい |
イベント名 形式:文字列 例:Purchase、Subscription |
| いいえ | このパラメータは非推奨で、システムから削除される予定です。削除日は今後発表されます。代わりにeventValueパラメータを使用してください。 | |
|
|
いいえ | このパラメータは非推奨で、システムから削除される予定です。削除日は今後発表されます。代わりにeventValueパラメータを使用してください。 |
| eventRevenue | いいえ |
コンバージョンイベントに関連付ける収益 形式:浮動小数点数 |
| eventRevenueCurrency | いいえ |
収益の通貨
形式:文字列 |
| eventValue | いいえ |
イベントの内容を表すパラメータのマップです。商品のSKUや明細ごとの価格など、詳細なアプリ内イベントの情報を送信するために使用します。
形式:JSON
例:SKUがABC123、色が青、単価が3.99米ドルの商品情報を送信する場合
上限:1,000文字。超過した部分は切り捨てられるため、上限を超えないようにしてください。 |
イベント記録のシナリオ
イベントの例
// purchase event of shoes with associated revenue
AF('pba', 'event', {eventType: 'EVENT', eventName: 'purchase', eventRevenue: 12, eventValue: {"key1": 123, "key2": "name"}});
送信するイベントは、Webアプリの用途によって異なります。たとえば、オンラインストアで必要なイベントと、ニュースサイトで必要なイベントは異なります。以下のシナリオを参照して、どのようなイベントを、どのタイミングで送信すべきか確認してください。
オンラインストア
オンラインストアを運営している場合を考えます。記録する標準イベントの例は、以下のとおりです。
- 検索:標準イベント
- カートへの追加:標準イベント
- カートからの削除:標準イベント
- 購入:コンバージョンイベント
ニュースサイト
ニュースサイトを運営している場合を考えます。記録するイベントの例は、以下のとおりです。
- 会員登録:コンバージョンイベント
- 有料サブスクリプションの購入:コンバージョンイベント
イベント送信の確認
本セクションは、Web開発者向けです。
PBA Web SDKの実装テスト:テストイベントをリアルタイムで確認できます。
AppsFlyerにイベントが送信されていることを確認するには:
- Webサイトを開きます。
- ブラウザの開発者ツールを開きます。
- Networkタブに切り替えます。
- イベントを発生させます。
-
メッセージで絞り込みます。
- 送信先がwa.appsflyer.comで始まるネットワークリクエストを探します(下のスクリーンショットを参照)。
- 以下を確認してください。
- ステータスコードが200であること。
- Request Payloadが、イベントのパラメータと一致していること。
例
イベントの記録
以下のコードは、説明用のサンプルです。そのまま使用しないでください。
- 前提:イベントを送信する時点で、ページによるWeb SDKの読み込みが完了しているものとします。
- 以下のシナリオでは、次のタイミングでイベントを記録するコードを示します。
- ランディングページが読み込まれたとき。
- ユーザーがWebサイトを操作したとき。
直接実装によるイベントの記録
ランディングページの読み込み時のイベント記録
- メールマガジンの登録ページがあり、登録を記録する場合を考えます。
- 登録完了ページを用意し、登録後のユーザーをそのページにリダイレクトすることもできます。
<html>
<head>
<!-- Assume that the server returns a response with details about the newly subscribed user -->
<!-- Alternatively, you can extract data from localStorage or cookies,
in case data was set in either of them during the subscription process
-->
<script>window.onload = function(){
AF('pba', 'event', {eventType: 'EVENT', eventValue: {'category': 'holiday_promotion', eventValue: {'label' : 'newspaper'}, eventName: 'subscription',}); } </script> </head> <body> <h1>Thank You for Subscribing to Our Newsletter</h1> </body> </html>
- 上記のコードは、基本的なHTMLページの例です。イベントを送信するには、WebページでWeb SDKを読み込む必要があります。
- ユーザーがリダイレクトされ、ページが読み込まれると、ウィンドウの読み込み処理がAF()メソッドを呼び出し、AppsFlyerに登録イベントを送信します。
Webサイトでのユーザー操作に伴うイベント記録
- ECサイトで、購入手続きのイベントを記録する場合を考えます。
- ユーザーが購入手続きボタンをクリックすると、Web SDKがAppsFlyerにイベントを送信します。
<html>
<head>
<!-- Assume that data about products in the shopping cart
is stored in localStorage -->
<script>
window.onload = function () {
document.getElementById('checkout').addEventListener('click', function () {
AF('pba', 'event', {eventType: 'EVENT', eventValue: {'category' : 'holiday_promotion'}, eventName: 'checkout'});
});
}
</script>
</head>
<body>
<h1>Shopping Cart</h1>
<h2>Shirt</h2>
<p>
<ul>
<li>Color: Blue</li>
<li>Quantity: 2</li>
<li>Price: $20</li>
</ul>
</p>
<h2>Pants</h2>
<p>
<ul>
<li>Color: Black</li>
<li>Quantity: 3</li>
<li>Price: $15</li>
</ul>
</p>
<button id='checkout'>Checkout</button>
</body>
</html>
上記のコードは、基本的なHTMLページの例です。 イベントを送信するには、WebページでWeb SDKを読み込む必要があります。
- ページが読み込まれると、Checkoutボタンにクリックリスナーが登録されます。
- ユーザーがCheckoutボタンをクリックすると、コールバック関数が以下を実行します。
- localStorageからデータを取得します。
- AF()メソッドを呼び出し、データを渡します。
- AF()メソッドがAppsFlyerにイベントを送信します。
タグマネージャーによるイベントの記録
ランディングページの読み込み時のイベント記録
- メールマガジンの登録ページがあり、登録完了を記録する場合を考えます。
- 登録完了ページを用意し、登録が完了したユーザーをリダイレクトします。
-
登録完了ページの設定
<html> <head> <script> // Google Tag Manager loads the Web SDK <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-XXXX'); </script> <script> // Assume that the server returns a response with details about the newly subscribed user function getResponseFromServer() { return JSON.stringify({ action: 'subscribe', category: 'site actions', label: userEmail }) } //Alternatively, you can extract data from localStorage or cookies, //in case data was set in either of them during the subscription process localStorage.setItem('data', JSON.stringify({ action: 'subscribe', category: 'site actions', label: 'user@email.com' })); </script> </head> <body> <h1>Thank You for Subscribing to Our Newsletter</h1> </body> </html>上記のコードはGTMを読み込み、GTMがWeb SDKを読み込みます。その後、スクリプトでさらに2つの処理が行われます。 1つ目は、サーバーからユーザー情報を含むレスポンスを取得する関数の実行です。 2つ目は、ローカルストレージへのデータ保存です。 GTMは、この関数とlocalStorageの両方にアクセスできます。 GTMから関数を呼び出し、localStorageにアクセスできます。
-
登録完了ページの読み込み後に、登録のアトリビューションを行う新しいタグを追加
- タグに識別しやすい名前を付け、タグの種類にカスタムHTMLを選択します。
-
カスタムHTMLに、以下のコードを入力します。
<script> AF('pba', 'event', {eventType: 'EVENT', eventValue: {'category' : 'holiday_promotion'}, eventName: 'subscription'}); </script> -
テキスト欄の下にある詳細設定、続いてタグの順序付けを展開し、タグの実行後にコンバージョンが発火する設定になっていることを確認します。
-
コンバージョンタグを発火させるため、トリガーを設定します。この例では、登録完了ページの読み込み時にトリガーが発火します。
Webサイトでのユーザー操作に伴うイベント記録
- ECサイトで、購入手続きのイベントを記録する場合を考えます。
- ユーザーが購入手続きボタンをクリックすると、Web SDKがAppsFlyerにイベントを送信します。
-
購入手続きページの設定
<html> <head> <script> // Google Tag Manager loads the Web SDK <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-XXXX'); </script> </head> <body> <h1>Shopping Cart</h1> <h2>Shirt</h2> <p> <ul> <li>Color: Blue</li> <li>Quantity: 2</li> <li>Price: $20</li> </ul> </p> <h2>Pants</h2> <p> <ul> <li>Color: Black</li> <li>Quantity: 3</li> <li>Price: $15</li> </ul> </p> <button id='checkout'>Checkout</button> </body> </html>上記のコードは、GTMを使用してWeb SDKを読み込みます。それ以外の部分は、ショッピングカートページを模したHTMLです。 IDがcheckoutになっているCheckoutボタンに注目してください。このIDは、GTMでこのボタンのクリックを処理する設定に必要です。
- GTMで変数、設定をクリックし、組み込み変数の一覧でClick Elementにチェックを入れます。
- 新しい変数を作成して内容がわかる名前を付け、種類にすべての要素を選択します。
- トリガーの設定で一部のクリックを選択し、Click ElementがCSSセレクタに一致する条件として、#checkoutを指定します。
-
購入手続き用の新しいタグを作成します。種類に「カスタムHTML」を選択し、トリガーに購入手続き用のトリガーを設定します。
<script> AF('pba', 'event', {eventType: 'EVENT', eventValue: {'category' : 'holiday_promotion'}, eventName: 'checkout'}); </script>
- イベントが発火する前に、Web SDKの関数を定義するタグが読み込まれていることを確認してください。
- イベント値には、収益の通貨記号などの特殊文字を含めないでください。
- 値の文字列は、50文字未満にしてください。
会員登録後のカスタマーユーザーIDの設定
以下のコードは、参考用のサンプルです。そのまま使用しないでください。使い方が不明な場合は、Web開発者にご相談ください。
前提:イベントを送信する前に、ページによるWeb SDKの読み込みが完了しているものとします。SDKを再度読み込まないでください。
ユーザーの操作の流れ:
- ユーザーがWebサイトに会員登録します。
- Webサイトのコードがユーザー情報を収集し、サーバーに送信します。
- サーバーが、そのユーザーの一意のCUIDを生成します。
- 登録完了ページで、サーバーに新しいCUIDを問い合わせます。
- サーバーのレスポンスを使い、Web SDKのsetCustomerUserId()メソッドでAppsFlyerのCUIDを設定します。
直接実装
会員登録ページを設定します。
<html>
<head>
<!-- The Web SDK script loads first -->
<script>
!function(t,e,n,s,a,c,i,o,p){t.AppsFlyerSdkObject=a,t.AF=t.AF||function(){
(t.AF.q=t.AF.q||[]).push([Date.now()].concat(Array.prototype.slice.call(arguments)))},
t.AF.id=t.AF.id||i,t.AF.plugins={},o=e.createElement(n),p=e.getElementsByTagName(n)[0],o.async=1,
o.src="https://websdk.appsflyersdk.com?"+(c.length>0?"st="+c.split(",").sort().join(",")+"&":"")+(i.length>0?"af_id="+i:""),
p.parentNode.insertBefore(o,p)}(window,document,"script",0,"AF","pba",{pba: {webAppId: "WEB_DEV_KEY"}})
</script>
<script>
};
// This function stores the user email sent to the server after the user reaches the thank you page
// The response from the server is a unique CUID that should be set using the web SDK setCustomerUserId method
function storeUserEmail (){
var userEmail = document.getElementById('email').value;
localStorage.setItem('user_email', userEmail);
}
</script>
</head>
<body>
<h1>Sign Up</h1>
<form onsubmit="storeUserEmail()" action="/signup" method="post">
<div><label>Name</label>
<input type="text" name="name" id="name"></div>
<br />
<div> <label>Email</label>
<input type="email" name="email" id="email"></div>
<br />
<input type="submit" id="submit">
</form>
</body>
</html>
上記のコードは、シンプルな会員登録フォームです。フォームが送信されると、メールアドレスがlocalStorageに保存されます。ユーザーが登録完了ページに到達すると、メールアドレスがサーバーに送信され、そのアドレスに対応する一意のCUIDが生成されます。
会員登録したユーザー向けの登録完了ページを設定します。
<html>
<head>
<script>
!function(t,e,n,s,a,c,i,o,p){t.AppsFlyerSdkObject=a,t.AF=t.AF||function(){
(t.AF.q=t.AF.q||[]).push([Date.now()].concat(Array.prototype.slice.call(arguments)))},
t.AF.id=t.AF.id||i,t.AF.plugins={},o=e.createElement(n),p=e.getElementsByTagName(n)[0],o.async=1,
o.src="https://websdk.appsflyersdk.com?"+(c.length>0?"st="+c.split(",").sort().join(",")+"&":"")+(i.length>0?"af_id="+i:""),
p.parentNode.insertBefore(o,p)}(window,document,"script",0,"AF","pba",{pba: {webAppId: "WEB_DEV_KEY"}})
</script>
<script>
// Using the fetch API to send the user email to the server
// and get the unique user id in return
window.onload = function () {
var userEmail = localStorage.getItem('user_email');
fetch('users/' + userEmail).then(function (res) {
res.text().then(function (id) {
console.log(id);
AF('pba', 'setCustomerUserId', id);
});
});
} </script>
</head>
<body>
<h1>Thank You for Signing Up!</h1>
</body>
</html>
このコードはfetch APIを使用しています。ユーザーが入力したメールアドレスをサーバーに送信します。会員登録時にサーバーが一意のCUIDを持つユーザーを作成する前提で、メールアドレスは、そのCUIDを取得するためにサーバーに送信します。サーバーから返された一意のCUIDを、setCustomerUserIdメソッドに渡します。
Google Tag Manager
-
会員登録ページを設定します。
<html> <head> <script> // Google Tag Manager loads the Web SDK (function (w, d, s, l, i) { w[l] = w[l] || []; w[l].push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' }); var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f); })(window, document, 'script', 'dataLayer', 'GTM-5VJ6C7R'); // This function stores the user email to be sent to the server after the user reaches the thank you page // the response from the server is a unique CUID that should be used in the web SDK setCustomerUserId method function storeUserEmail (){ var userEmail = document.getElementById('email').value; localStorage.setItem('user_email', userEmail); } </script> </head> <body> <h1>Sign Up</h1> <form onsubmit="storeUserEmail()" action="/signup" method="post"> <div><label>Name</label> <input type="text" name="name" id="name"></div> <br /> <div> <label>Email</label> <input type="email" name="email" id="email"></div> <br /> <input type="submit" id="submit"> </form> </body> </html>上記のコードは、シンプルな会員登録フォームです。フォームが送信されると、メールアドレスがlocalStorageに保存されます。ユーザーが登録完了ページに到達すると、そのメールアドレスに対応する一意のCUIDを取得するため、メールアドレスがサーバーに送信されます。
-
会員登録したユーザー向けの登録完了ページを設定します。
(t.AF.q=t.AF.q||[]).push([Date.now()].concat(Array.prototype.slice.call(arguments)))}, t.AF.id=t.AF.id||i,t.AF.plugins={},o=e.createElement(n),p=e.getElementsByTagName(n)[0],o.async=1, o.src="https://websdk.appsflyersdk.com?"+(c.length>0?"st="+c.split(",").sort().join(",")+"&":"")+(i.length>0?"af_id="+i:""), p.parentNode.insertBefore(o,p)}(window,document,"script",0,"AF","pba",{pba: {webAppId: "WEB_DEV_KEY"}}) </script> <script> // using the fetch api to send the user email to the server // and get the unique user id in return window.onload = function () { var userEmail = localStorage.getItem('user_email'); fetch('users/' + userEmail).then(function (res) { res.text().then(function (id) { console.log(id); AF('pba', 'setCustomerUserId', id); }); }); } </script> </head> <body> <h1>Thank You for Signing Up!</h1> </body> </html>上記のコードは登録完了ページの例で、GTMのトリガーにより、会員登録フォームでユーザーが入力したメールアドレスをサーバーに送信します。
会員登録時に、サーバーが一意のCUIDを持つユーザーを作成する前提です。
メールアドレスをサーバーに送信するのは、一意のCUIDを取得するためです。
サーバーから返された一意のCUIDを、setCustomerUserId()メソッドで送信します。
続いて、トリガーとタブを作成します。 - 登録完了ページの読み込み後に登録のアトリビューションを行う、新しいタグを追加します。
-
タグに識別しやすい名前を付け、タグの種類に「カスタムHTML」を選択します。
<script> var userEmail = localStorage.getItem('user_email'); fetch('users/' + userEmail).then(function (res) { res.text().then(function (id) { console.log(id); AF('pba', 'setCustomerUserId', id); }); }); </script> -
テキスト欄の下にある詳細設定、続いてタグの順序付けを展開し、タグの実行後にコンバージョンが発火する設定になっていることを確認します。
-
コンバージョンタグをいつ発火させるかを指定するため、トリガーを設定します(以下の例では、登録完了ページの読み込み時に発火します)。
setCustomerUserId関数は、ログインや会員登録後など、ユーザーの操作の流れのどの段階でも呼び出せます。 AppsFlyerは、最後に送信されたCUIDを使用して、過去または今後のタッチポイントやイベントに関連する、現在観測しているユーザーの情報を更新します。
モバイルアプリのsetCustomerUserd関数と同じCUIDの値を使用してください(モバイルのsetCustomerUserId:iOS、Android、Unityを参照)。
補足情報
Web SDKのCookie
以下の表に示すCookieは、Web SDKがWebサイトで設定または使用するものです。
表内では、以下の略語を使用しています。
- AMP:Accelerated Mobile Pages
- CDN:コンテンツデリバリーネットワーク
- 3PC:サードパーティCookie
| Cookie名 | ドメイン | 有効期間 | 使用条件 | 詳細 |
|---|---|---|---|---|
| afUserid | 自社Webサイトのドメイン | 395日 | AMP以外 | Webページの読み込みやページ遷移のイベントで、ユーザーを識別します。 |
| AF_SYNC | 自社Webサイトのドメイン | 1週間 | AMP以外 |
|
| af_id | appsflyer.com | 395日 | サードパーティCookieが許可されている、AMP以外のページ | アプリの起動や画面遷移のイベントで、ユーザーを識別します。 |
| af_id | onelink.me | 395日 | サードパーティCookieが許可されている、AMP以外のページ | バナーやOneLinkのエンゲージメントを、アプリ起動イベントに関連付けます。 |
| amp-afUserid | AMP CDNまたは自社Webサイトのドメイン | 1年 | AMPで配信されるページ | |
| AF_DEFAULT_MEASUREMENT_STATUS | 自社Webサイトのドメイン | 395日 | PBAへの同意状態を保存します。ユーザーの同意が得られるまで、SDKを動作させません。デフォルトでは設定されず、同意に基づく制御が設定されている場合にのみ使用されます。 | AMP以外 |
Web SDKのリリースノート
| 日付 | バージョン | 補足 |
|---|---|---|
| 2021-07-01 | 1.0 | クエリパラメータの破棄 |
| 2021-06-01 | 1.0 | コンテンツセキュリティポリシー(CSP)の適用 |
| 2020-08-31 | 1.0 | オプトインとオプトアウト機能を追加 |
| 2020-04-16 | 1.0 | 一意のCUIDの送信方法を、IDENTIFYイベントからcustomerUserId()関数に変更 |
| 2020-07-30 | 1.0 |
|
非推奨機能
- 非推奨の通知は、機能やメソッドのサポートを終了する予定であることを事前にお知らせするものです。その機能やメソッドは、サポート終了日まで引き続き動作します。
- 非推奨の通知を、コードを見直す機会として活用してください。
| 非推奨の通知日 | サポート終了日 | 詳細 |
|---|---|---|
| 2020-04-16 | 未定 |
非推奨の方法:eventTypeを"IDENTIFY"に設定し、イベントパラメータcustomUserIdでカスタマーユーザーID(CUID)を送信する方法 現在の方法:setCustomerUserId()関数を使用して、CUIDを送信します。 |