概要:WebサイトにAppsFlyer Web SDK(ピクセルとも呼ばれます)を実装すると、ユーザーの訪問やイベントをAppsFlyerに送信できます。永続的なカスタマーユーザーID(CUID)を設定することで、プラットフォームをまたぐユーザージャーニーを紐付けられます。
概要
Web SDKは、Webサイトでのユーザーの行動を記録し、その情報をAppsFlyerに送信します。サイズは40〜60KBで、Webサイトへの訪問やサイト上の操作をAppsFlyerに送信するプラグインモジュールです。
SDKの手動実装
以下の手順に従い、Web SDKのインストールから動作確認、プライバシー設定までを行います。
- キーの取得: Web SDK ID(Web Dev Keyとも呼ばれます)を取得します。
- コードスニペットの選択:実装方法とセキュリティ要件に合ったスニペットを選択します。
- Web SDKの設置:スニペットの直接追加、Google Tag Manager、Adobe Launch Tag Managerのいずれかの方法でSDKを設置します。
- SDKの動作確認:ブラウザの開発者ツールでネットワーク通信を確認し、SDKがリクエストを送信していることを検証します。
- イベントの設定と記録: JavaScriptまたはGoogle Tag Managerを使用してカスタムイベントを定義し、ページの読み込み時やユーザーの操作時に送信します。
- カスタマーユーザーIDの設定:永続的なCUIDを設定して、Web上の行動を他のプラットフォームでの行動と紐付けます。
- プライバシー管理:計測のオプトイン・オプトアウトを制御し、セキュリティとデータのフィルタリング(Content Security Policyとクエリパラメータの破棄)を設定します。
- Web SDKのCookie一覧: Web SDKが設定または使用するCookieについて、用途、有効期間、適用範囲を確認します。
AIコーディングエージェントによるSDKの実装
Web SDKを手動で実装する代わりに(手順は後述)、AIコーディングツール(Cursor、Claude Code、Codex、Copilot)を使って実装全体を行えます。プロンプトをコピーし、2つのプレースホルダーを置き換えてからAIコーディングツールに貼り付けてください。
この方法なら、以下の手順をまとめて効率よく進められます。ただし、実装後にはSDKの動作確認とプライバシー設定の確認が必要です。
プロンプトをコピーする前に、以下を置き換えてください。
-
<WEB_SDK_ID>:AppsFlyerで[アプリ設定]を開き、Webアプリ(Webサイトのドメインに「website-」が付いたアプリ)を選択します。[SDK認証]から[Web SDK ID]をコピーします。 -
<PRODUCTION_URL>:本番サイトのURLです。デプロイ後の検証に使用します。
AIツールはコードベースを調べてイベントの実装計画を作成し、承認を得てから実装に進みます。計画を確認する際は、収益と通貨の値が、実際に収益が発生するイベントにのみ設定されていることを確認してください。また、プロンプトに記載されたデプロイ後の検証手順に従って、結果を確認してください。
AI実装用プロンプト
# **AppsFlyer Web SDK | AI実装用プロンプト**
以下のプロンプトを、プロジェクトを編集できるAIコーディングツール(Cursor、Claude Code、Codex、Copilot)に貼り付けてください。コピーする前に、2つのプレースホルダーを置き換えてください。
- <WEB_SDK_ID>:AppsFlyerの[マイアプリ]でWebアプリ(ドメインにwebsite-が付いたアプリ)を選択し、[SDK認証]からWeb SDK ID(Web Dev Keyとも呼ばれます)をコピーします。
- <PRODUCTION_URL>:本番サイトのURLです。デプロイ後の検証に使用します。
このWebサイトにAppsFlyer Web SDK(Webアトリビューションピクセル)を実装してください。マーケティングの効果計測に必要なイベントも実装してください。
Web SDK ID:<WEB_SDK_ID>
本番サイトのURL:<PRODUCTION_URL>
## ステップ0 | 設定情報の確認
上記のWeb SDK IDが未入力、またはプレースホルダーのままの場合は、IDを尋ねる短いメッセージのみを返し、作業を停止してください(AppsFlyerの[マイアプリ]>「website-」が付いたアプリ>[SDK認証]>[Web SDK ID])。 IDが提供されるまでコードを書かないでください。本番サイトのURLも未入力の場合は、同じ返信で確認してください。デプロイ後の検証に必要です。
変更は最小限にしてください。リポジトリからファイルの場所を特定し、この実装に必要な箇所のみを変更して、プロジェクトの既存の実装パターンを維持してください。
## ステップ1 | サイトの事前分析
コードを書く前にコードベースを確認し、イベントの実装計画を作成してください。イベントの一覧を私に尋ねないでください。
1. フレームワーク(HTML、React、Next.js、Vueなど)と、ドキュメントの<head>を管理している場所を特定してください。
2. コードからコンバージョンにつながる操作を見つけてください。信頼性の高い順に、以下を確認してください。
- 既存のアナリティクス呼び出し:gtag()/GA4イベント、Segmentのanalytics.track()、fbq('track')、dataLayer.push(ecommerceオブジェクトを含む)。これらから、対象の操作と、金額・通貨・注文IDの値を取得している場所を確認できます。
- コマース関連の処理:チェックアウト・カートのモジュール、注文確認ページやサンクスページとそのルート、決済成功時のコールバック。
- 認証関連の処理:新規登録・ログインのフローと、クライアント側のコードで内部ユーザーIDを取得できるタイミング。
- フォームとCTA:リード獲得フォーム、サブスクリプションや無料トライアルの開始、ダウンロード。
- コマース以外のサービスやツール:サイトに購入、カート、チェックアウト、新規登録、ログインのフローがない場合、コマースや認証のイベントを独自に追加しないでください。実際の製品内の操作(生成、コピー、出力、ダウンロード、共有、テンプレート選択、パラメータ編集など)を特定し、内容がわかるカスタムイベント名にマッピングしてください。
3. 見つけた各操作を、AppsFlyerの標準イベント名にマッピングしてください。
- 注文完了 / "Order Completed" / purchase_success -> af_purchase(eventRevenueを設定)
- 新規登録 / 登録 / アカウント作成 -> af_complete_registration
- ログイン / サインイン -> af_login
- カートに追加 / "Product Added" -> af_add_to_cart(af_priceを設定し、eventRevenueは設定しない)
- チェックアウト開始 / "Checkout Started" -> af_initiated_checkout(af_priceを設定し、eventRevenueは設定しない)
- 商品またはコンテンツの閲覧 -> af_content_view
- サブスクリプション開始 -> af_subscribe、無料トライアル開始 -> af_start_trial
- 検索 -> af_search
対応する標準イベントがない場合は、内容がわかるカスタムイベント名を使用してください。
4. 各イベントについて、実際の請求額(af_purchaseの場合)、通貨、注文ID・取引ID、ユーザーIDの取得元をコード内で特定してください。既存のアナリティクスが参照しているデータソースを再利用してください。
5. OneTrustやDidomiなど、既存の同意管理プラットフォーム(CMP)があるか確認してください。サイト独自の同意切り替え機能や保存済みのプライバシー設定も確認し、それによって計測をどう制御するかは独断で決めず、私に確認してください。
注意:既存のアナリティクスは調査の参考にのみ使用してください。AppsFlyerのイベントはAF()を直接呼び出して実装し、SegmentやGA4を経由してそれらのイベント名で転送しないでください。
その後、イベントの実装計画を表形式(AppsFlyerのイベント名、トリガーとファイル、収益・af_priceの取得元、重複排除用IDの取得元)で提示し、私の承認を得てから実装してください。値の取得元を見つけられないイベントは、推測せずに明示してください。
## ステップ2 | SDKスニペットの設置
すべてのページの<head>の先頭近くに、私のWeb SDK IDを指定して以下のスニペットを追加してください。
<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.appsflyer.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_SDK_ID>"}})
</script>
必ず守る事項:
- スニペットはそのまま使用してください。独自のコンポーネントやラッパーモジュールに書き換えないでください。 SDKをラッパーで囲むと、カスタムイベントは送信できても、自動訪問イベント(SDKのLOADイベント)が発生しないことがあります。その場合、サイトの訪問数は0になり、アトリビューションもできなくなります。
- SDKの読み込みは、ページの読み込み1回につき必ず1回にしてください。 ReactやNext.jsでは、再レンダリングや二重マウントによる重複読み込みを防いでください。たとえば、再マウントされるコンポーネント内ではなく、ルートのHTMLテンプレートやドキュメントテンプレートで読み込みます。複数回読み込むと、SDKが動作しなくなることがあります。
- タグマネージャー(GTM)経由ですでにAppsFlyer SDKを読み込んでいる場合は、コードにも追加しないでください。読み込み元は1つにしてください。既存のAppsFlyerタグが見つかった場合は、私に知らせてください。
- ページビューイベントや訪問イベントを手動で実装しないでください。 SDKは読み込み時に訪問を自動で記録します。独自に実装した「page_view」イベントは、訪問としてカウントされません。
- 設定キーはwebAppIdです(appIdではありません)。
- サイトがnonceを使用する厳格なContent Security Policyを適用している場合は、インラインスニペットのタグにnonceを追加し、ポリシーに'strict-dynamic'が含まれていることも確認してください。スニペットはSDKスクリプトを動的に挿入するため、nonceのみのポリシーでは、'strict-dynamic'がないとブロックされます。
## ステップ3 | イベントの実装
イベント呼び出しの形式:
AF('pba', 'event', {
eventType: 'EVENT', // always the literal string 'EVENT'
eventName: 'af_purchase',
eventRevenue: 49.99, // top level - only on realized revenue
eventRevenueCurrency: 'USD', // top level - 3-letter ISO code, defaults to USD if omitted
eventValue: { // JSON metadata, max 1000 characters
"af_order_id": "TXN-12345",
"af_customer_event_id": "evt-abc-001"
}
});
イベントのルール(必ず従ってください):
1. クロスプラットフォームレポートやファネルのイベントを揃えるため、AppsFlyerの標準イベント名を使用してください:af_purchase、af_complete_registration、af_login、af_add_to_cart、af_initiated_checkout、af_content_view、af_subscribe。モバイルアプリがある場合は、モバイルSDKと同じイベント名を使用してください。 「_web」など、プラットフォームを示す接尾辞を付けないでください。
例外として、サイトで明確に異なる商品プランやカテゴリを販売しており、ダッシュボードで個別の内訳が必要な場合(2種類のサブスクリプション商品など)は、共通のイベント1つにまとめず、分けたイベント名(af_purchase_<tier>)を計画に含め、その理由を示してください。 eventValueだけで分類しても、標準のダッシュボードにはその内訳は表示されません。同じ購入について、プラン別のイベントと共通のイベントの両方を送信しないでください。データが重複します。
2. 収益は必ず最上位のeventRevenueフィールドに設定し、実際に金銭の授受が発生したイベント(購入完了、サブスクリプション契約完了、予約確定)にのみ含めてください。 eventValue内の値(af_revenue、revenue、price、amount、total)は、収益としてカウントされません。ここに収益を入れることは最も多い実装ミスで、すべての購入の収益が$0になります。
3. 通貨がUSD以外の場合は、必ずeventRevenueとともにeventRevenueCurrencyを送信してください。省略すると、すべての金額がUSDとして記録されます。
4. 1回の取引で実際に請求された金額を、数値のみで送信してください。通貨記号やセント単位での表記は使用せず、カートの合計金額と商品金額の二重計上や、生涯価値の設定を避けてください。
5. 実際の収益ではない金額(カート追加時の金額、チェックアウト開始時の金額、閲覧した商品の価格)には、eventRevenueを設定しないでください。 eventValue内の"af_price"に金額、"af_currency"に通貨を設定してください。 af_initiated_checkoutとaf_purchaseの両方にeventRevenueを送信すると、収益が二重計上されます。
6. 購入イベントでは、eventValue内に"af_order_id"(取引ID)を含めてください。その時点のコードで実際の取引IDを取得できない場合は、プレースホルダーで代用せず、実装計画にその旨を記載してください。
7. すべてのコンバージョンイベントで、eventValue内に一意の"af_customer_event_id"を含めてください。同じイベント名と同じIDの組み合わせで2回送信しないでください。IDは操作ごとに生成し、SPAの再レンダリングでハンドラーが2回実行されないようにしてください。このIDは、同じコンバージョンをサーバー間(S2S)通信でも送信する場合の重複排除にも使用されます。
8. ユーザーの操作1回につきイベントは1つにしてください。同じ操作について2つのイベント名で送信したり、AppsFlyerへの直接送信と転送レイヤー経由の送信で異なる名前を使ったりしないでください。
9. 複数商品が入ったカートでは、eventValue内に"af_order_info"配列を追加してください。商品ごとに1つのオブジェクトを作成し、キーとしてsku、revenue(単価)、qty、content_name、content_type、content_category、brandを含めます。購入イベントの最上位のeventRevenueには、注文の合計金額を設定します。
10. イベントは、ページでSDKスニペットが読み込まれてから送信してください。確認ページやサンクスページへの遷移で完了するコンバージョンは、そのページの読み込み時に送信してください。ページ内の操作(SPAでのボタンクリック)は、操作ハンドラーから送信します。
11. ペイロードは必要なフィールドだけにしてください。
- 実際に金銭の授受が発生したイベント以外では、eventRevenueとeventRevenueCurrencyを含めないでください。念のためにeventRevenue: 0やデフォルトの通貨を送信することは避けてください。
- eventCategory、eventLabelなど、GAやSegmentの形式に固有のフィールドは含めないでください。これらはAppsFlyer Web SDKのイベントAPIの項目ではありません。
- eventValue内で値が空文字列、null、undefined、falseのキーは省略してください。ただし、そのプロパティでfalse自体に意味がある場合は除きます。
- 特定のイベントに関係のないパラメータは、ペイロードに含めないでください。該当するフィールドだけを含む最小限のオブジェクトにしてください。
- AppsFlyerレポートで収益や通貨の列が空でも、クライアントからゼロやデフォルト値を送る必要はありません。そのフィールドは省略してください。
## ステップ4 | カスタマーユーザーID(CUID)の設定
ユーザーのログイン・新規登録直後、および認証済みユーザーのページ読み込み時に、以下を呼び出してください。
AF('pba', 'setCustomerUserId', '<the user's internal ID, as a string>');
ルール:
- モバイルアプリがある場合は、モバイルアプリがsetCustomerUserIdに渡す識別子と同じものを使用してください。この識別子で、Webとモバイルをまたぐユーザージャーニーを紐付けます。
- 値から意味を読み取れない内部IDを使用してください。メールアドレス、電話番号、その他の個人を特定できる情報(PII)は使用しないでください。
- 可能な限り早く呼び出してください。呼び出し前に送信したイベントにはCUIDが含まれません。
- setCustomerUserIdを呼び出すだけでは、レポートに表示されるイベントは作成されません。 CUIDを設定してから、新規登録時にはaf_complete_registration、ログイン時にはaf_loginも送信し、これらのイベントにCUIDが含まれるようにしてください。
## ステップ5 | 同意(CMPがある場合のみ)
サイトで同意管理プラットフォームを使用している場合:
- 計測をオフにしてSDKを初期化します:{pba: {webAppId: "<WEB_SDK_ID>", measurementStatus: false}}
- 同意取得時:window.AF_SDK.PLUGINS.PBA.enableMeasurement()
- 同意撤回時:window.AF_SDK.PLUGINS.PBA.disableMeasurement()
注意:
- これらのプラグインメソッドは、SDKスクリプトの読み込み完了後にのみ使用できます。すぐに利用できるキュー用のスタブであるAF()とは異なります。この実行順序を考慮してください。
- 計測をオフにして開始した場合、同意が得られるまで訪問は記録されません。実装前に、この影響を明確に説明してください。
CMPがない場合は、通常のスニペットを使用してください(計測はデフォルトでオンです)。
## ステップ6 | 検証
### 6a. ローカル環境での検証(実装中)
プロジェクトを起動し、ブラウザを操作して(Playwright/Puppeteer、または利用可能なブラウザツールを使用)、AppsFlyerドメインへのすべての呼び出しでリクエストのペイロードとHTTPレスポンスステータスの両方を記録してください。以下を確認してください。
- SDKローダーのリクエストが200を返し、ページの読み込み1回につき1回だけ発生すること。ページ間の移動やコンポーネントの再レンダリングを行い、二重読み込みがないことを確認します。
- ページの読み込み時に、eventTypeが"LOAD"でafWebUserIdが入力されたリクエストが発生し、2xxが返ること。これが訪問の記録であり、これがないとアトリビューションできません。
- 実装した各コンバージョンでイベントリクエストが1回だけ発生し、いずれも2xxを返すこと。購入ではeventRevenueとeventRevenueCurrencyが最上位にあり、af_customer_event_idが入力され、値が一意であること。
- ログインをシミュレーションした後のリクエストに、カスタマーユーザーIDが含まれること。
リクエストを記録できただけでは、成功の証拠になりません。 4xxが返ったイベントは拒否されており、レポートには表示されません。送信したすべてのイベントのステータスコードを報告し、ステータスコードを確認していないイベントを検証済みとしないでください。
ブラウザを実行できない場合は、コード上で確認してください。スニペットの挿入箇所が1つだけで二重マウントされないこと、各イベントハンドラーが1回の操作につき1回だけ実行されること、収益と通貨が最上位のフィールドにあること、すべての認証済みアクセス経路でsetCustomerUserIdを呼び出せることを確認します。レスポンスステータスを確認できなかったことを明記してください。
### 6b. 本番ドメインでのデプロイ後の検証(必須)
ローカルでの実行で確認できるのはコードの処理経路であり、本番ページの動作ではありません。ビルドパイプラインやアセット処理によって、インラインスクリプトが削除されたり、実行を遅らされたり、配置を変えられたりするため、ソースファイルの確認だけでは不十分です。デプロイ後:
- 本番URLを取得し、実際に配信されるHTMLにスニペットが含まれることを確認してください。
- 本番ページをブラウザで開き、6aのすべての確認を本番ページでも行ってください。
- 送信リクエストのaf_idクエリパラメータがWeb SDK IDと完全に一致することを確認してください。IDが誤っていたり途中で切れていたりすると、アカウントに存在しないIDにイベントが送信され、通知されることなく処理されません。
- QA専用のカスタマーユーザーID(例:qa_<yyyymmdd>_01)を使用し、後でローデータから今回の実行分を抽出できるようにしてください。
まだデプロイしていない場合は、6bが未実施であることを伝え、デプロイ後に実行する具体的なコマンドと確認事項を示してください。
### 6c. QAの記録
後でAppsFlyerのローデータと照合できるよう、検証結果をイベントごとに1行の表にまとめてください。項目は、UTCタイムスタンプ、イベント名、CUID、af_order_id、af_customer_event_id、HTTPステータスです。検証全体の開始時刻と終了時刻をUTCで示し、わかる場合はデプロイ時刻もUTCで示してください。
## ステップ7 | データの確認方法
訪問とコンバージョンは異なる種類のレコードで、混同しやすいため、AppsFlyerでイベントを確認する具体的な手順をレポートに含めてください。
- 訪問は自動で記録され、イベントレベルのデータではイベント名が空欄、収益がゼロのSESSION行として表示されます。これはスキーマの仕様であり、不具合ではありません。初回訪問と再訪問は、名前の付いたイベントとしてではなく、コンバージョンレベルのデータ(FIRST_VISIT / REVISIT)に表示されます。セッションを対象とした出力には、実装が正しくてもアプリ内イベントは含まれません。
- 実装したコンバージョンは、イベント名(af_purchase、af_loginなど)が入力された個別の行として表示され、収益は購入の行にのみ記録されます。
- デプロイ前の期間のデータを取得しても、新しいイベントは含まれません。デプロイ時刻をUTCで示し、それ以降の期間のみをクエリするよう伝えてください。アトリビューション時刻のフィールドは、イベントの発生時刻よりはるかに古い場合があり、今回の検証ではなく過去の訪問を示すことを説明してください。
- レポートに反映されるまでの想定所要時間を示し、その時間内にレポートが空でも失敗と判断しないよう注意してください。
- 6cのQA実行分を抽出する正確なフィルター(期間とQA用CUID)と、正常な結果の例を示してください。
- イベントに2xxが返っているのに反映所要時間を過ぎても表示されない場合は、コードの不具合ではなく、アカウント側の問題(Webアプリでイベントが有効になっていない、レポートの対象範囲、データアクセス権限)であることを明確にし、AppsFlyerのUIで確認すべき項目を挙げてください。
## 出力
完了後、以下を提示してください。
- 実装したすべてのイベントの表:イベント名、トリガーの場所(ファイル)、収益の処理方法、重複排除用ID。
- スニペットの設置場所と、読み込みが1回に限られることを保証する方法。
- setCustomerUserIdの呼び出し箇所。
- 6cのQA記録表。自ら検証した内容(レスポンスステータスを含む)と、私が手動で確認すべき内容(開くページ、行う操作、想定されるリクエストとステータス)を明確に分けてください。
- ステップ7のデータ確認ガイド。
- 実装できなかった事項や私からの情報が必要な事項(ユーザーIDの保存場所、最終請求総額に該当する購入金額のフィールド、推測を避けた値の取得元など)。
ここに記載されたAppsFlyer Web SDKの実装以外は行わないでください。
1. キーの取得
Web SDK ID(Web Dev Keyとも呼ばれます)を取得します。
- AppsFlyerの上部メニューから[アプリ設定]を開きます。
- ページ上部のアプリ選択メニューから、Webアプリ(Webサイトのドメインに「website-」が付いたアプリ)を選択します。
- [SDK認証]で[Web SDK ID]をコピーします。
必要に応じてSmart Bannerキーを取得します。
- AppsFlyerのサイドメニューから[Engage]>[Web to App]>[Smart Banners]を開きます。
- 必要なSmart Bannerキーをコピーします。
2. コードスニペットの選択
実装方法とセキュリティ要件に合ったスニペットを選択します。以下の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)));
};
// Replace WEB_DEV_KEY with your Web SDK ID
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;
// Replace WEB_DEV_KEY with your Web SDK ID
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)));
};
// Replace WEB_DEV_KEY with your Web SDK ID
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;
// Replace WEB_DEV_KEY with your Web SDK ID
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を使用したContent Security Policy(CSP)を適用している場合は、「プライバシー管理」のContent Security Policy(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)));
};
// Replace WEB_DEV_KEY with your Web SDK ID
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)));
};
// Replace WEB_DEV_KEY with your Web SDK ID
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>3. スニペットの設置
ステップ2で選択したスニペットを、以下のいずれかの方法で設置します。ページの読み込み1回につき、SDKが1回だけ読み込まれるようにしてください。
方法A:Webサイトに直接追加
すべてのページで、以下を行います。
- ステップ2のスニペット内の
WEB_DEV_KEYをWeb SDK IDに置き換えます。該当する場合はYOUR_BANNER_KEYも置き換えます。 - Webサイトの
<head>タグの先頭近くにスニペットを貼り付けます。
方法B:Google Tag Manager(GTM)経由で設置
ページの読み込み1回につきSDKが1回だけ読み込まれるようにし、GTMの優先順位設定を使って、ページの読み込み開始後すぐにSDKが読み込まれるようにしてください。
- Google Tag Managerを開きます。
- AppsFlyer Web SDK用の新しいタグを作成します。
- タグの種類として[Custom HTML]を選択します。
- 用途がわかるタグ名を付けます。
- [Tag Configuration]にステップ2のスニペットを貼り付けます。
- [Save]をクリックします。
- トリガーを追加します。
- すべてのページを対象とする場合:
- [Add Trigger]をクリックします。
- [All Pages]を選択します。
- [Save]をクリックします。
- タグ名を入力し、[Save]をクリックします。
- 特定のページを対象とする場合:
- [Save Tag]をクリックします。
- GTMのメイン画面で[Triggers]を選択します。 [New]をクリックします。
- 鉛筆アイコンをクリックします。
- トリガーの種類として[Page View]を選択します。
- [Some Page Views]を選択します。
- 必要に応じて、ページとトリガーの条件を設定します。
- [Save]をクリックします。
- トリガーをAppsFlyer Web SDKのタグに紐付けます。
- GTMのメイン画面で[Tags]を選択します。
- 作成したタグを選択します。
- トリガーのパネルで鉛筆アイコンをクリックします。
- 作成したページビュートリガーを選択します。
- [Save]をクリックします。
- すべてのページを対象とする場合:
GTMのカスタムテンプレートはAdvanced SDK Verificationに対応していません。サンドボックス環境の制約により、検証に必要なintegrity属性を設定できないためです。代わりに[Custom HTML]タグを使用してください。
方法C:Adobe Launch Tag Manager経由で設置
Adobe Experience Cloudでプロパティを作成
- Adobe Experience Cloud>Launchを開きます。
- Adobe Experience Cloud Launchで[Go to Launch]をクリックします。
- [New Property]をクリックします。
- プロパティ名を付けます。
- [Platform]で[Web]を選択します。
- Webサイトのドメインを入力します。
- [Save]をクリックします。
Adobe Launchのプロパティにスニペットを追加
- [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]を選択し、ステップ2のスニペットを貼り付けます(コードを囲む行は除きます)。
- [Keep Changes]をクリックしてコードエディターを閉じます。
- [Save]をクリックします。
WebサイトにAdobe Launchタグを追加
- [My web property]ページで[Environments]タブを選択します。
- 公開する環境(開発または本番)の行を探します。
- 該当する行の[Install]列にあるボックスアイコンをクリックします。
- [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]を選択します。
4. SDKの動作確認
インストール後、ブラウザの開発者ツールでネットワークリクエストを調べ、SDKがリクエストを送信していることを検証します。
SDKの動作を確認するには、以下の手順に従います。
- Webサイトを開きます。
- ブラウザの開発者ツールを開きます。
- (A)[Network]タブを開きます。
- ページを再読み込みします。
- (B)
appsflyerで絞り込みます。以下の2つのリクエストが表示される場合があります。-
SDKローダー:リクエストURLが
https://websdk.appsflyersdk.comで始まります。 SDKスクリプトが正常に読み込まれたことを確認できます。 -
イベントデータ:リクエストURLが
https://wa.appsflyer.com/eventsで始まります。 SDKがAppsFlyerにイベントデータを送信していることを確認できます。
-
SDKローダー:リクエストURLが
- (C)[events]のメッセージ(
wa.appsflyer.comへの呼び出し)を選択します。 - [Headers]の(D)で以下を確認します。
- リクエストURLが
https://wa.appsflyer.com/events?site-id=で始まること。 -
site_idクエリパラメータがWEB_DEV_KEYと一致すること。 - ステータスコードが200であること。
- リクエストURLが
-
site_idが、AppsFlyerの上部メニューの[マイアプリ]にあるWEB_DEV_KEYと一致することを確認します。 - SDKが1回だけ読み込まれていることを確認します。 SDKを複数回読み込むと、動作しなくなることがあります。
Web SDKのインストール状況やイベントが正しく発生することを、リアルタイムに画面で確認するには、Web SDKテストページを使用してください。
5. イベントの設定と記録
Web SDKの初期化後は、基本的な訪問の計測に加えて、ユーザーの具体的な操作も記録できます。このセクションでは、JavaScriptまたはGoogle Tag Managerを使って、購入や新規登録などのカスタムイベントを定義し、記録する方法を説明します。
イベントの設定
イベントはWeb計測の基本となる要素で、ビジネスにとって価値のあるユーザーの具体的な操作を表します。これらの操作を記録するには、各イベントの処理とパラメータを定義し、収益やカスタムメタデータなどの適切なイベントパラメータがAppsFlyerに送信されるようにする必要があります。
イベントの例(収益を伴う購入イベント)
AF('pba', 'event', {eventType: 'EVENT', eventName: 'purchase', eventRevenue: 12, eventValue: {"key1": 123, "key2": "name", "af_customer_event_id": "evt-abc-001"}});
Web SDKのイベントパラメータ一覧
| パラメータ名 | 必須 | 説明 |
eventType |
はい | イベントの種類。形式:文字列。このパラメータには、常にEVENTを設定します。例:eventType: "EVENT"
|
eventName |
はい | イベント名。形式:文字列。例:Purchase、Subscription |
eventRevenue |
いいえ | コンバージョンイベントに計上する収益。形式:浮動小数点数。 |
eventRevenueCurrency |
いいえ | 収益の通貨。 ISO 4217に準拠した3文字の通貨コード。デフォルト:USD。形式:文字列。 |
eventValue |
いいえ | イベントの詳細を表すパラメータのマップ。商品SKUや商品ごとの価格など、詳細なアプリ内イベント情報を送信するために使用します。形式:JSON。例:{"sku": "ABC123", "color": "blue", "unit_price": 3.99, "currency": "USD"}。上限:3,000文字(超過分は切り捨てられます)。 |
ページの読み込み時にイベントを記録
サンクスページや確認ページなど、リダイレクトで完了するコンバージョンに使用する標準的な方法です。
JavaScriptにウィンドウの読み込みメソッドを追加するか、Google Tag Managerでページビュートリガーを設定して実装できます。
以下のコードは説明用のサンプルです。そのまま使用せず、サイトの構造に合わせて調整してください。
例:AF Web SDKでイベントを記録
ニュースレター登録後のサンクスページなど、リダイレクトによって発生するコンバージョンの記録に適した方法です。
使用例:ユーザーがニュースレターへの登録を完了し、確認ページにリダイレクトされます。そのページが表示された時点で、登録イベントを記録します。
JavaScriptでのページ読み込みの例:
window.onload = function(){
AF('pba', 'event', {eventType: 'EVENT', eventValue: {'category': 'holiday_promotion'}, eventName: 'subscription'});
}
処理の流れ:
- ページに必要なコンテンツが読み込まれます。
- ウィンドウの読み込みが完了すると(
window.onload)、スクリプトがAF()メソッドを自動で呼び出します。 - subscriptionイベントが、関連するメタデータ(カテゴリとラベル)とともにAppsFlyerに直接送信されます。
例:GTMでイベントを記録
サンクスページの読み込み時にタグを発火させることで、ニュースレター登録などのコンバージョンの完了を記録します。
1. サンクスページの設定
以下のHTML構造ではGTMを読み込み、GTM経由でWeb SDKを読み込みます。関数やlocalStorageを使ってGTMにデータを渡す方法も示しています。
<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-XXXX');
</script>
<script>
function getResponseFromServer() {
return JSON.stringify({ action: 'subscribe', category: 'site actions', label: userEmail })
}
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>
2. GTMタグの設定
- GTMで新しいタグを作成し、タグの種類として[Custom HTML]を選択します。
- 区別しやすい名前(例:AF Subscription Event)を付けます。
-
HTMLの入力欄に以下のスクリプトを貼り付けます。
AF('pba', 'event', {eventType: 'EVENT', eventValue: {'category' : 'holiday_promotion'}, eventName: 'subscription'}); - [Advanced Settings]>[Tag Sequencing]を展開します。メインのWeb SDK初期化タグの後に発火するよう設定されていることを確認します。
- サンクスページの[Page View]で、このタグが発火するトリガーを設定します。
ユーザーの操作時にイベントを記録
ページの再読み込みを伴わない操作(ボタンクリック、ダウンロード、カートへの追加)の計測に使用します。
通常は、HTML要素にクリックリスナーを紐付けるか、Google Tag Managerの変数を使って対象の要素IDやCSSセレクターを特定し、操作を計測します。
以下のコードは説明用のサンプルです。そのまま使用せず、サイトの構造に合わせて調整してください。
例:AF Web SDKでイベントを記録
CheckoutボタンやDownloadボタンのクリックなど、ページ上の特定の操作を計測する場合に使用します。
使用例:ECサイトで、ユーザーがカート内の[Checkout]ボタンをクリックした瞬間に、checkoutイベントを記録します。
JavaScriptでのユーザー操作の例:
<html>
<head>
<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>
<button id='checkout'>Checkout</button>
</body>
</html>
処理の流れ:
- ページの読み込み時に、スクリプトがID
checkoutの要素にclickイベントリスナーを紐付けます。 - ユーザーがボタンをクリックすると、コールバック関数が呼び出されます。
- 関数は必要なデータ(例:
localStorageのデータ)を取得し、AF()メソッドに渡すことができます。 - SDKがcheckoutイベントをAppsFlyerに送信します。
例:GTMでイベントを記録
GTMの組み込み変数とトリガーを使って、[Checkout]ボタンのクリックなど、特定の操作を記録します。
1. チェックアウトページの設定
<html>
<head>
<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>
<button id='checkout'>Checkout</button>
</body>
</html>
2. GTMの変数とトリガーの設定
- GTMで[Variables]>[Configure]をクリックし、組み込み変数の一覧で[Click Element]を有効にします。
- 新しいユーザー定義変数を作成します(種類:[All Elements])。
- 新しいトリガーを作成します。
- トリガーの種類:[Click - All Elements]。
- 発火条件:[Some Clicks]。
- 条件:[Click Element]がCSSセレクター
#checkoutに一致すること。
3. 操作時に発火するタグの作成
- チェックアウト操作用の新しい[Custom HTML]タグを作成します。
-
操作時に実行するスクリプトを貼り付けます。
<script> AF('pba', 'event', {eventType: 'EVENT', eventValue: {'category' : 'holiday_promotion'}, eventName: 'checkout'}); </script> - 前の手順で作成した「Checkout Click」トリガーを割り当てます。
イベント実装のベストプラクティス
データを正確に記録し、正常に送信するため、以下の技術要件を確認してください。
- 読み込み順序:イベントを呼び出す前に、Web SDKの関数タグがページ内で完全に読み込まれていることを確認してください。
-
データ形式:イベントの値に特殊文字を含めないでください。たとえば、収益には通貨記号を含めず数値を使用します(
$10.50ではなく10.50)。 -
文字数制限:
eventValueの文字列は簡潔にしてください。3,000文字を超えた部分は切り捨てられます。 -
イベントの重複排除:
eventValue内でaf_customer_event_idを送信し、イベントごとに一意の値を設定することを推奨します。特に、同じイベントをWeb SDKとサーバー間(S2S)APIの両方で送信する場合に重要です。 AppsFlyerはこの値をアドネットワークに転送します。アドネットワークは、AppsFlyerから受信したサーバー側イベントと、自社のピクセルから受信した同じイベントとの重複排除に使用します。 -
収益の設定先:
eventRevenueは、購入やサブスクリプションの確定など、実際に金銭の授受が発生したイベントにのみ設定してください。金額を伴っていても実際の収益ではないイベント(カート追加、チェックアウト開始、コンテンツ閲覧など)では、eventValue内のaf_priceとaf_currencyを使用します。チェックアウトと購入の両方でeventRevenueを送信すると、すべてのレポートで収益が二重計上されます。 -
イベント名:イベント名に
_webなど、プラットフォームを示す接尾辞を付けないでください。ダッシュボードやローデータでは、プラットフォームはすでに分析軸として用意されています。クロスプラットフォームレポートを統一するため、モバイルアプリと同じイベント名を使用してください。
6. カスタマーユーザーIDの設定
イベント計測の実装後、setCustomerUserIdで永続的な識別子を設定し、Web上の行動を他のプラットフォーム(モバイル、PC、CTV)と紐付けます。これにより、プラットフォームをまたぐユーザージャーニーを一元的に把握できます。
主なルール
-
一貫性:モバイルアプリの実装と同じCUIDを使用してください(モバイルの
setCustomerUserIdについては、iOS、Android、Unityを参照)。 - 設定タイミング:CUIDは、ログイン後や新規登録後など、どの段階でも送信できます。 CUIDを取得できたら、可能な限り早く設定してください。多くの場合、ログインや新規登録によってユーザーを識別できるようになるまで待つ必要があります。
-
構文:値は引用符で囲んだ文字列として送信してください。例:
AF('pba', 'setCustomerUserId', '663274') - プライバシー:メールアドレスや電話番号など、個人を特定できる情報(PII)を含めないでください。
例:新規登録後のCUIDの設定(JavaScript)
以下のコードは参考用です。そのまま使用しないでください。コードの使用方法が不明な場合は、Web開発者に相談してください。
前提:イベント送信前にWeb SDKがページに読み込まれているものとします。再度読み込まないでください。
シナリオ:
- ユーザーがWebサイトで新規登録します。
- Webサイトのコードがユーザー情報を収集し、サーバーに送信します。
- サーバーがユーザーに一意のCUIDを発行します。
- 新規登録後のサンクスページで、サーバーに新しいCUIDを問い合わせます。
- サーバーのレスポンスを使い、Web SDKの
setCustomerUserId()メソッドでAppsFlyerのCUIDを設定します。
新規登録フォームの例
以下のコードは、簡単な新規登録フォームの例です。フォームが送信されると、メールアドレスが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>
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>
サンクスページの例
このコードはFetch APIを使用します。ユーザーが入力したメールアドレスをサーバーに送信します。サーバーが新規登録時に一意のCUIDを持つユーザーを作成している場合は、メールアドレスを送信すると、そのユーザーの一意のCUIDが返されます。サーバーから返された一意のCUIDを、setCustomerUserIdメソッドに渡します。
<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>
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>
例:新規登録後のCUIDの設定(Google Tag Manager)
-
新規登録ページを設定します。
以下のコードは、簡単な新規登録フォームの例です。フォームが送信されると、メールアドレスが
localStorageに保存されます。サンクスページへの移動後、ユーザーのメールアドレスをサーバーに送信し、そのアドレスに対応する一意のCUIDを取得します。<html> <head> <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-5VJ6C7R'); 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> -
新規登録したユーザー向けのサンクスページを設定します。以下のコードは、GTMトリガーを使って、ユーザーが登録フォームに入力したメールアドレスをサーバーに送信するサンクスページの例です。新規登録時にサーバーが一意のCUIDを持つユーザーを作成している場合は、メールアドレスを送信すると、そのユーザーの一意のCUIDが返されます。サーバーから返された一意のCUIDを、
setCustomerUserId()メソッドで送信します。<script> 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> -
サンクスページの読み込み後に登録のアトリビューションを行うための新しいタグを追加します。
-
区別しやすいタグ名を付け、タグの種類として[Custom 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> -
入力欄の下にある[Advanced Settings]、続いて[Tag Sequencing]を展開し、タグの実行後にコンバージョンが発火するよう設定されていることを確認します。
-
コンバージョンタグの発火タイミングを指定するトリガーを設定します。以下の例では、サンクスページの読み込み時に発火します。
7. プライバシー管理
イベント計測の実装後、組織内や地域の基準に従うため、セキュリティやプライバシーに関する制限の適用が必要になる場合があります。
イベント送信のオプトイン・オプトアウト
計測は以下の2つの方法で制御できます。
SDKの初期状態の設定(スニペット内)
Webページの初回読み込み時にSDKがイベントの送信を開始するか、明示的な開始指示があるまで待機するかを決定します。この設定はWebスニペット内で定義します。
- イベントを送信する:
{pba: {webAppId: "...", measurementStatus:true}} - イベントを送信しない:
{pba: {webAppId: "...", measurementStatus:false}}
measurementStatusが空またはNULLの場合、AppsFlyerはmeasurementStatus:trueとして扱います。
明示的な制御
明示的な制御は初期状態の設定より優先され、永続的なファーストパーティCookieを使用します。このCookieには、以下の特徴があります。
- Webサイトのドメインに設定されます。
- Web SDKまたはブラウザが定める期間後に失効します。
- 常にブラウザのCookie設定の影響を受けます。
コマンド
- イベント送信を開始する(オプトイン):
window.AF_SDK.PLUGINS.PBA.enableMeasurement() - イベント送信を停止する(オプトアウト):
window.AF_SDK.PLUGINS.PBA.disableMeasurement()
データの保護とフィルタリング
Webサイトで厳格なセキュリティやデータプライバシーの規約が求められる場合は、以下の仕組みで、Web SDKとサイト環境・データとの連携方法を設定してください。
Content Security Policy(CSP)
WebサイトでCSPによるJavaScriptの保護が必要な場合、CSPの設定とステップ2で選択したスニペットに応じて、以下の2つの方法を利用できます。
-
selfを使用するCSP:
script-srcの許可リストにhttps://websdk.appsflyersdk.comを追加します。標準のWeb SDKとAdvanced SDK Verificationのどちらでも使用できます。 -
nonceを使用するCSP:ポリシーに
script-src 'nonce-...'を使用している場合は、以下のnonce対応版のAdvanced SDK Verificationを使用します。検証処理に必要な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のタグにも渡されます。 |
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)));
};
// Replace WEB_DEV_KEY with your Web SDK ID
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)));
};
// Replace WEB_DEV_KEY with your Web SDK ID
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>クエリパラメータの破棄
URLのクエリパラメータに機密情報が含まれる場合は、AppsFlyerに破棄させることができます。URL、リファラ、header_refererが対象です。
-
すべてのクエリパラメータを破棄する:
af_url=trueを追加します。 -
特定のパラメータを破棄する:
af_url_mask=paramを使用します。複数のパラメータは;で区切ります。
例:
- 元の値:
param1=value1¶m2=value2¶m3=value3&af_url_mask=param2;param3 - 結果:
param1=value1&af_url_mask=param2;param3
Web SDKのCookie一覧
Web SDKは、以下のCookieを設定または使用します。
| Cookie名 | ドメイン | 有効期間 | 使用する条件 | 詳細 |
| afUserid | Webサイトのドメイン | 395日 | Accelerated Mobile Pages以外のページ | Webページの読み込みやページ間の移動時にユーザーを識別します。 |
| AF_SYNC | Webサイトのドメイン | 1週間 | Accelerated Mobile Pages以外のページ | 最終的なユーザー識別子が設定されたことを示します。サイトの読み込み時間を短縮するために使用します。 |
| af_id | appsflyer.com | 395日 | サードパーティCookieが許可されている、Accelerated Mobile Pages以外のページ | アプリの起動や画面間の移動時にユーザーを識別します。 |
| af_id | onelink.me | 395日 | サードパーティCookieが許可されている、Accelerated Mobile Pages以外のページ | リンクバナーやOneLink、またはその両方のエンゲージメントをアプリの起動イベントに紐付けます。 |
| amp-afUserid | AMP CDNまたはWebサイトのドメイン | 1年 | Accelerated Mobile Pages | |
| AF_DEFAULT_MEASUREMENT_STATUS | Webサイトのドメイン | 395日 | Accelerated Mobile Pages以外のページ | 同意の状態を保存します。ユーザーが同意するまでSDKの動作を停止します。デフォルトでは設定されません。同意に基づく制御を設定している場合にのみ使用します。 |