AppMeasurementから Web SDK への移行

この実装パスには、AppMeasurement実装から Web SDK JavaScript ライブラリ実装に移行する系統的な移行アプローチが含まれます。 その他の実装パスについては、次の別のページで説明しています。

  • Analytics 拡張機能を Web SDK 拡張機能に:Adobe Analytics タグ拡張機能から Web SDK タグ拡張機能にスムーズかつ系統的なアプローチで移行します。 このアプローチにより、Customer Journey AnalyticsなどのAdobe Experience Platform サービスを使用する準備が整うまで XDM を使用する必要がなくなります。 データをAdobeに送信するには、xdm オブジェクトではなく data オブジェクトを使用します。
  • Web SDK JavaScript ライブラリ:Web SDK JavaScript ライブラリ(alloy.js)を使用した新規 Web SDK インストール。 タグ UI を使用する代わりに、自分で実装を管理します。 これには、XDM スキーマに含める一般的な Analytics 変数を含むAdobe Analytics ExperienceEvent フィールドグループが必要です。
  • Web SDK タグ拡張機能:Adobe Experience Platform Data Collection のタグを使用して実装を管理する、新しい Web SDK インストール。 これには、XDM スキーマに含める一般的な Analytics 変数を含むAdobe Analytics ExperienceEvent フィールドグループが必要です。

この実装パスのメリットとデメリット

この移行アプローチを使用すると、メリットとデメリットの両方が生じます。 各オプションを慎重に検討し、組織に最適なアプローチを決定します。

メリット
デメリット
  • 既存の実装を使用:このアプローチには実装の変更が必要ですが、完全に新しい実装をゼロから行う必要はありません。実装ロジックへの最小限の変更で、既存のデータレイヤーとコードを使用できます。
  • スキーマは必要ありません:Web SDK への移行のこの段階では、XDM スキーマは必要ありません。 代わりに、data オブジェクトにデータを入力し、Adobe Analyticsにデータを直接送信することができます。 Web SDK への移行が完了したら、組織のスキーマを作成し、データストリームマッピングを使用して適用可能な XDM フィールドを入力できます。 移行プロセスのこの段階でスキーマが必要だった場合、組織はAdobe Analytics XDM スキーマの使用を強制されます。 このスキーマを使用すると、組織が今後独自のスキーマを使用するのが難しくなります。
  • 実装の変更には開発者の介入が必要:Web SDK の実装を変更する場合は、開発チームと協力してサイトのコードを編集する必要があります。 Web SDK タグ拡張機能に移行するアプローチでは、この欠点を回避します。
  • 実装の技術的負債:このアプローチは既存の実装を変更した形式を使用するので、実装ロジックを追跡し、必要に応じて将来変更を実行するのは難しい場合があります。
  • Platform にデータを送信するにはマッピングが必要:組織で Customer Journey Analytics を使用する準備が整ったら、Adobe Experience Platform のデータセットにデータを送信する必要があります。このアクションでは、data オブジェクトのすべてのフィールドが、XDM スキーマフィールドに割り当てるデータストリームマッピングツールのエントリである必要があります。 このワークフローではマッピングを 1 回行うだけで済み、実装を変更する必要ありません。ただし、これは、XDM オブジェクトでデータを送信する際には必要ない追加の手順です。

Adobeでは、次のシナリオでこの実装パスを使用することをお勧めします。

  • 既存の実装がある場合は、Adobe Analytics AppMeasurement JavaScript ライブラリを使用します。 Adobe Analytics タグ拡張機能を使用した実装がある場合は、代わりに Adobe Analytics タグ拡張機能から Web SDK タグ拡張機能に移行に従います。
  • 今後Customer Journey Analyticsを使用するが、Analytics 実装を Web SDK 実装に最初から置き換える必要がない。 Web SDK で実装をゼロから置き換えることは最も努力が必要ですが、最も実行可能な長期的な実装アーキテクチャも提供します。 Web SDK をクリーンに実装する取り組みを行う意思がある場合は、Customer Journey Analyticsユーザーガイドの Adobe Experience Platform Web SDK を使用したデータの取り込みを参照してください。

Web SDK への移行に必要な手順

以下の手順には、取り組むべき具体的な目標が含まれています。 各手順をクリックすると、実行方法に関する詳細な手順が表示されます。

1.データストリームの作成と設定

Adobe Experience Platform Data Collection にデータストリームを作成します。 このデータストリームにデータを送信すると、データがAdobe Analyticsに転送されます。 今後、この同じデータストリームがCustomer Journey Analyticsにデータを転送します。

  1. experience.adobe.com に移動し、資格情報を使用してログインします。
  2. 右上のホームページまたは製品セレクターを使用して、データ収集 に移動します。
  3. 左側のナビゲーションで、「データストリーム」を選択します。
  4. 新しいデータストリーム ​を選択します。
  5. 目的の名前を入力し、「保存」を選択します。
  6. データストリームを作成したら、「サービスを追加」を選択します。
  7. サービス ドロップダウンメニューで、「Adobe Analytics」を選択します。
  8. 分析データを現在送信しているサイトと同じレポートスイート ID を入力します。 「保存」をクリックします。

Adobe Analytics サービスを追加

これで、データストリームがデータを受け取り、Adobe Analyticsに渡す準備が整いました。 データストリーム ID をメモします。この ID は、コードで Web SDK を設定する際に必要になるからです。

2. Web SDK JavaScript ライブラリをインストールし す。
メソッド呼び出しを使用できるように、alloy.js の最新バージョンを参照します。 詳細および使用するコードブロックについては、JavaScript ライブラリを使用した Web SDK のインストールを参照してください。
3.Web SDK の設定

Web SDK configure コマンドを使用して、前の手順で作成したデータストリームを指すように実装を設定します。 configure コマンドは、ライブラリのインストールコードと一緒に含めることができるように、すべてのページで設定する必要があります。

Web SDK configure コマンド内で datastreamId および orgId プロパティを使用します。

  • datastreamId を、前の手順で取得したデータストリーム ID に設定します。
  • 組織の IMS 組織に orgId を設定します。
code language-js
alloy("configure", {
    datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
    orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg"
});

組織の実装要件に応じて、configure コマンドで他のプロパティをオプションで設定できます。

4. JSON ペイロードを使用するようにコードロジックを更新し す。

AppMeasurement.jss オブジェクトに依存しないように、Analytics 実装を変更します。 代わりに、正しい形式のJavaScript オブジェクトに変数を設定し、Adobeに送信する際に JSON オブジェクトに変換します。 サイトに データレイヤーがあると、値を設定する際に非常に役立ちます。これは、同じ値を引き続き参照できるからです。

データをAdobe Analyticsに送信するには、Web SDK ペイロードは、このオブジェクト内で設定されたすべての分析変数と data.__adobe.analytics を使用する必要があります。 このオブジェクト内の変数は、対応するAppMeasurement変数と同じ名前と形式を共有します。 例えば、products 変数を設定する場合、XDM の場合とは異なり、変数を個々のオブジェクトに分割しないでください。 代わりに、s.products の変数を設定した場合に、文字列として正確に含めます。

code language-json
{
  "data": {
    "__adobe": {
      "analytics": {
        "products": "Shoes,Men's sneakers,1,49.99"
      }
    }
  }
}

最終的に、このペイロードには、必要な値がすべて含まれ、実装内の s オブジェクトへのすべての参照が削除されます。 JavaScriptが提供する任意のリソースを使用して、このペイロードオブジェクトを設定できます(個々の値を設定するドット表記を含む)。

code language-js
// Define the payload and set objects within it
var dataObj = {data: {__adobe: {analytics: {}}}};
dataObj.data.__adobe.analytics.pageName = window.document.title;
dataObj.data.__adobe.analytics.eVar1 = "Example value";

// Alternatively, set values in an object and use a spread operator to achieve identical results
var a = new Object;
a.pageName = window.document.title;
a.eVar1 = "Example value";
var dataObj = {data:{__adobe:{analytics:{...a}}}};
5. Web SDK を使用するようにメソッド呼び出しを更新しま

s.t() および s.tl() を呼び出すすべてのインスタンスを更新し、sendEvent コマンドで置き換えます。 考慮すべきシナリオは次の 3 つです。

  • ページビュートラッキング:ページビュートラッキング呼び出しを Web SDK sendEvent コマンドに置き換えます。

    code language-js
    // If your current implementation has this line of code:
    s.t();
    
    // Replace it with this line of code. The dataObj object contains the variables to send.
    alloy("sendEvent", dataObj);
    
  • 自動リンクトラッキング:clickCollectionEnabled 設定プロパティは、デフォルトで有効になっています。 Adobe Analyticsにデータを送信するための適切なリンクトラッキング変数が自動的に設定されます。 自動リンクトラッキングを無効にする場合は、configure コマンド内でこのプロパティを false に設定します。

  • 手動のリンクトラッキング:Web SDK には、pageview 呼び出しと非 pageview 呼び出しの間に別のコマンドはありません。 ペイロードオブジェクト内でその区別をしてください。

    code language-js
    // If your current implementation has this line of code:
    s.tl(true,"o","Example custom link");
    
    // Replace it with these lines of code. Add the required fields to the dataObj object.
    dataObj.data.__adobe.analytics.linkName = "Example custom link";
    dataObj.data.__adobe.analytics.linkType = "o";
    dataObj.data.__adobe.analytics.linkURL = "https://example.com";
    alloy("sendEvent", dataObj);
    
6.変更を検証して公開する

AppMeasurementおよび s オブジェクトへの参照をすべて削除したら、変更内容を開発環境に公開して、新しい実装が機能することを検証します。 すべてが正しく動作することを検証したら、更新を実稼動環境に公開できます。

正しく移行されると、AppMeasurement.js はサイトで不要になり、このスクリプトへのすべての参照を削除できます。

この時点で、Analytics 実装は Web SDK に完全に依存しており、将来Customer Journey Analyticsに移行するための準備が十分にあります。

recommendation-more-help
b4f6d761-4a8b-4322-b801-c85b9e3be690