Adobe Analyticsフレームワークのカスタマイズ

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

フレームワーク用に生成される Javascript について

ページがAdobe Analyticsのフレームワークに関連付けられ、そのページにAnalyticsモジュール](/docs/experience-manager-65/administering/integration/adobeanalytics.html?lang=ja)への[参照が含まれる場合、そのページに対してanalytics.sitecatalyst.jsファイルが自動的に生成されます。

ページ内のjavascriptは、(s_code.jsAdobe Analyticsライブラリで定義する)s_giオブジェクトを作成し、そのプロパティに値を割り当てます。 オブジェクトインスタンスの名前は 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プロパティの設定

Adobe Analyticsには、フレームワーク上で設定可能な定義済みの変数が多数あります。 charset、cookieLifetime、currencyCode​および​trackInlineStats​変数は、デフォルトで​一般的な解析設定​リストに含まれます。

このリストに、変数名と値を追加することができます。これらの定義済み変数と追加する変数は、analytics.sitecatalyst.jsファイルのsオブジェクトのプロパティの設定に使用されます。 次の例は、prop10 という値を持つ追加プロパティ CONSTANT が 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";

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

1. Adobe Analyticsのフレームワークページで、「一般的な解析設定」領域を展開します。

2. 変数のリストの下の「項目を追加」をクリックして、新しい変数をリストに追加します。

3. 左側のセルに変数の名前（例：prop10）を入力します。

4. 右側の列に変数の値（例：CONSTANT）を入力します。

5. 変数を削除するには、変数の横の（-）ボタンをクリックします。

Adobe Analyticsフレームワークへのカスタムjavascriptの追加

「一般的なAnalytics設定」領域の「無料のjavascript」ボックスを使用すると、カスタムコードをAdobe Analyticsフレームワークに追加できます。

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

s.prop10= 'CONSTANT';

analytics.sitecatalyst.jsファイル内のコード(Adobe Analyticss-code.jsファイルの内容を含む)には、次のコードが含まれています。

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

次の手順では、javascriptボックスを使用してAdobe Analytics追跡をカスタマイズする方法を示します。 JavaScriptでAdobe Analyticsプラグインを使用する必要がある場合、それらのプラグインをAEMに統合します。

1. s.doPlugins を実行するように、次の Javascript コードをボックスに追加します。

   s.usePlugins=true;
   function s_doPlugins(s) {
       //add your custom code here
   }
   s.doPlugins=s_doPlugins;
   

   注意

   このコードは、基本的なドラッグ&ドロップインターフェイスまたはAdobe Analytics表示のインラインjavascriptを使用して実行できない方法でカスタマイズされたAdobe Analytics呼び出しで変数を送信する場合に必要です。

   カスタム変数がs_doPlugins関数の外部にある場合、Adobe Analytics呼び出しでは*undefined *として送信されます

2. 追加​s_doPlugins​関数内のjavascriptコード。

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

Adobe Analytics・フレームワークは、次の構成を備えています。

• prop2Adobe Analytics変数はpagedata.sitesectionサイトプロパティにマップされます。

• prop3Adobe Analytics変数はpagedata.subsectionサイトプロパティにマップされます。

• 次のコードがフリーフォームの Javascript ボックスに追加されます。

  s.usePlugins=true;
   function s_doPlugins(s) {
   s.prop1 = s.prop2+'|'+s.prop3;
   }
   s.doPlugins=s_doPlugins;
  

• フレームワークを使用するWebページにアクセスする（または編集モードでページが再読み込みまたはプレビューする）と、Adobe Analyticsへの呼び出しが実行されます。

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

すべてのAdobe Analyticsフレームワークに対するグローバルカスタムコードの追加

すべての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)

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

1. CRXDE Lite で、/apps/cq/analytics/components フォルダー構造を作成します。

   1. /apps フォルダーを右クリックして、作成／フォルダーを作成をクリックします。
   2. フォルダー名として「cq」を指定し、「OK」をクリックします。
   3. 同様に、analyticsフォルダーとcomponentsフォルダーを作成します。

2. 作成した components フォルダーを右クリックし、作成／コンポーネントを作成をクリックします。次のプロパティ値を指定します。

   • ラベル: sitecatalyst
   • タイトル: sitecatalyst
   • スーパータイプ：/libs/cq/analytics/components/sitecatalyst
   • グループ: hidden

3. 「OK」が有効になるまで「次へ」を繰り返しクリックしてから、「OK」をクリックします。

   sitecatalyst コンポーネントには、自動的に作成された sitecatalyst.jsp ファイルが含まれます。

4. sitecatalyst.jsp ファイルを右クリックして、「削除」をクリックします。

5. sitecatalyst コンポーネントを右クリックして、作成／ファイルを作成をクリックします。「config.js.jsp」という名前を指定して、「OK」をクリックします。

   config.js.jsp ファイルが自動的に編集用に開きます。

6. 次のテキストをファイルに追加して、「すべて保存」をクリックします。

   <%@page session="true"%>
   /* Plugin Config */
   s.usePlugins=true;
   function s_doPlugins(s) {
       //add your custom plugin code here
   }
   s.doPlugins=s_doPlugins;
   

   /apps/cq/analytics/components/sitecatalyst/config.js.jspスクリプトで生成されるjavascriptコードは、Adobe Analyticsフレームワークを使用するすべてのページのanalytics.sitecatalyst.jsファイルに挿入されるようになりました。

7. s_doPlugins 関数で実行する Javascript コードを追加して、「すべて保存」をクリックします。

AEMでのAdobe Analyticsプラグインの使用

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プラグインをインストールして、デフォルトで使用できるようにします。

• getQueryParam()
• getPreviousValue()
• split()

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

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

1. Web ブラウザーで CRXDE Lite を開きます。(http://localhost:4502/crx/de)

2. /apps/my-app/clientlibsフォルダーを右クリックし、作成/ノードを作成をクリックします。 次のプロパティ値を入力して、「OK」をクリックします。

   • 名前：クライアントライブラリフォルダーの名前（例：my-plugins）

   • タイプ：cq:ClientLibraryFolder

3. 作成したクライアントライブラリフォルダーを選択し、右下のプロパティバーを使用して、次のプロパティを追加します。

   • 名前：categories
   • タイプ：String
   • 値：sitecatalyst.plugins
   • マルチ：selected

   編集ウィンドウで「OK」をクリックして、プロパティの値を確認します。

4. 作成したクライアントライブラリフォルダーを右クリックし、作成／ファイルを作成をクリックします。ファイル名として「js.txt」と入力し、「OK」をクリックします。

5. 「すべて保存」をクリックします。

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

1. Adobe Analyticsアカウントを使用してsc.omniture.comにログインします。

2. ランディングページで、ヘルプ／ヘルプホームに移動します。

3. 左側の目次で、「実装プラグイン」をクリックします。

4. 追加するプラグインへのリンクをクリックし、ページが表示されたら、プラグインの Javascript ソースコードを探して、そのコードを選択し、コピーします。

5. クライアントライブラリフォルダーを右クリックして、作成／ファイルを作成をクリックします。ファイル名として、組み込むプラグインの名前に「.js」を付けて入力し、「OK」をクリックします。例えば、getQueryParam プラグインを組み込む場合は、ファイルに「getQueryParam.js」という名前を付けます。

   作成したファイルが編集用に開かれます。

6. プラグインの Javascript コードをファイルに貼り付け、「すべて保存」をクリックし、ファイルを閉じます。

7. クライアントライブラリフォルダーの js.txt ファイルを開きます。

8. 新しい行に、プラグインを格納しているファイルの名前（例：getQueryParam.js）を追加します。「すべて保存」をクリックして、ファイルを閉じます。