Adobe Analytics Framework のカスタマイズ customizing-the-adobe-analytics-framework

Adobe Analytics フレームワークは、Adobe Analytics で追跡される情報を決定します。デフォルトのフレームワークをカスタマイズするには、Javascript を使用してカスタムトラッキングを追加し、Adobe Analytics プラグインを組み込み、トラッキングに使用するフレームワーク内の一般設定を変更します。

フレームワーク用に生成される Javascript について about-the-generated-javascript-for-frameworks

ページを Adobe Analytics フレームワークと関連付け、そのページに Analytics モジュールへの参照を含めると、analytics.sitecatalyst.js ファイルがそのページ用に自動的に生成されます。

ページ内の Javascript が s_gi オブジェクト（s_code.js Adobe Analytics ライブラリが定義）を作成し、そのプロパティに値を割り当てます。オブジェクトインスタンスの名前は s です。この節に示すコード例では、この s 変数への参照を複数作成します。

次のコード例は、analytics.sitecatalyst.js ファイルのコードに似ています。

var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;

s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";

/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
    //add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/

カスタム JavaScript コードを使用してフレームワークをカスタマイズする場合、このファイルの内容を変更します。

Adobe Analytics プロパティの設定 configuring-adobe-analytics-properties

Adobe Analytics内には、フレームワーク上で設定できる定義済みの変数が多数あり​ す。 ​ charset, cookieLifetime, currencyCode および trackInlineStats 変数は 一般的な Analytics 設定 リストに表示されます。

このリストに、変数名と値を追加できます。これらの事前定義済みの変数と、追加したすべての変数を使用して、analytics.sitecatalyst.js ファイル内の s オブジェクトのプロパティを設定します。次の例は、追加された値 CONSTANT の prop10 プロパティが、Javascript のコードでどのように表現されるかを示しています。

var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.prop10= 'CONSTANT';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;

s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";

変数をリストに追加するには、以下の手順を実行します。

Adobe Analytics フレームワークへのカスタム JavaScript の追加 adding-custom-javascript-to-an-adobe-analytics-framework

Analytics の一般設定 ​領域にあるフリーフォームの Javascript ボックスを使用して、Adobe Analytics フレームワークにカスタムコードを追加できます。

追加するコードは、analytics.sitecatalyst.js ファイルに付加されます。そのため、s 変数にアクセスできます。この変数は、s_code.js で定義されている s_gi Javascript オブジェクトのインスタンスです。例えば、次のコードの追加は、前節の例で値 CONSTANT の prop10 という変数を追加することと同等です。

s.prop10= 'CONSTANT';

analytics.sitecatalyst.js ファイル（Adobe Analytics の s-code.js ファイルの内容を含む）のコードには、次のコードが含まれます。

if (s.usePlugins) s.doPlugins(s)

以下の手順は、Javascript ボックスを使用して Adobe Analytics の追跡機能をカスタマイズする方法を示しています。Javascript で Adobe Analytics プラグインを使用する必要がある場合は、AEM にプラグインを組み込んでください。

次の例では、一般的な区切り文字「|」を使用して、ページ上でキャプチャされたデータを階層順に連結しています。

Adobe Analytics フレームワークには、以下の設定があります。

例えば、次の値が Adobe Analytics で生成されます。

すべての Adobe Analytics フレームワーク用のグローバルカスタムコードの追加 adding-global-custom-code-for-all-adobe-analytics-frameworks

すべての Adobe Analytics フレームワークに組み込むカスタム Javascript コードを指定します。ページの Adobe Analytics フレームワークにカスタムのフリーフォームの Javascript が含まれていない場合、/libs/cq/analytics/components/sitecatalyst/config.js.jsp スクリプトが生成する Javascript が analytics.sitecatalyst.js ファイルに付加されます。デフォルトでは、このスクリプトはコメントアウトされているので効果はありません。また、このコードは s.usePlugins を false に設定します。

/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
    //add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/

analytics.sitecatalyst.js ファイル（Adobe Analytics の s_code.js ファイルの内容を含む）のコードには、次のコードが含まれます。

if (s.usePlugins) s.doPlugins(s)

したがって、s_doPlugins 関数内のすべてのコードが実行されるように、Javascript で s.usePlugins を true に設定する必要があります。このコードをカスタマイズするには、独自の Javascript を使用するファイルで config.js.jsp ファイルをオーバーレイします。Javascript で Adobe Analytics プラグインを使用する必要がある場合は、AEM にプラグインを組み込んでください。

AEM での Adobe Analytics プラグインの使用 using-adobe-analytics-plugins-in-aem

Adobe Analytics プラグイン用の Javascript コードを取得して、AEM で Adobe Analytics フレームワークに組み込みます。カスタム Javascript コードで使用できるよう、コードを sitecatalyst.plugins カテゴリのクライアントライブラリフォルダーに追加します。

例えば、getQueryParams プラグインを組み込む場合、カスタム Javascript の s_doPlugins 関数からプラグインを呼び出すことができます。次のコード例では、Adobe Analytics の呼び出しがトリガーされると、リファラーの URL の pid 内のクエリ文字列を eVar1 として送信します。

s.usePlugins=true;
function s_doPlugins(s) {
   // take the query string from the referrer
   s.eVar1=s.getQueryParam('pid','',document.referrer);
}
s.doPlugins=s_doPlugins;

AEM では次の Adobe Analytics プラグインをインストールして、デフォルトで使用できるようにします。

/libs/cq/analytics/clientlibs/sitecatalyst/plugins クライアントライブラリフォルダーには、sitecatalyst.plugins カテゴリのこれらのプラグインが含まれています。

次の手順を実行して、プラグインのクライアントライブラリフォルダーを作成します。 この手順は 1 回だけ実行する必要があります。 プラグインをクライアントライブラリフォルダーに追加するには、次の手順を実行します。

以下の手順を実行して、プラグインのコードを取得し、AEM リポジトリ内に保存し、クライアントライブラリフォルダーに追加します。