Adobe Analytics Framework のカスタマイズ

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

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

ページを 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 プロパティの設定

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";

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

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

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

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

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

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

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

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 にプラグインを組み込んでください。

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. Javascript コードを s_doPlugins 関数に追加します。

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

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

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

• prop3 Adobe 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)

したがって、s_doPlugins 関数内のすべてのコードが実行されるように、Javascript で s.usePlugins を true に設定する必要があります。このコードをカスタマイズするには、独自の 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
   • 複数：選択済み

   編集ウィンドウで「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）を追加します。「すべて保存」をクリックして、ファイルを閉じます。

Business.Adobe.com リソース

Cms Cloud Personalized Experiences Personalized Communications Managed Cloud Dynamic Media Digital Signage