Show Menu
トピック×

Adobe Analytics Frameworkのカスタマイズ

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

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

When a page is associated with a Adobe Analytics framework, and the page includes references to the Analytics module , a analytics.sitecatalyst.js file is automatically generated for the page.
The javascript in the page creates an s_gi object (that the s_code.js Adobe Analytics library defines) and assigns values to its properties. オブジェクトインスタンスの名前は s です。The code examples that are presented in this section makes several references to this s variable.
次のコード例は、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には、フレームワーク上で設定可能な定義済みの変数が多数あります。 The charset , cookieLifetime , currencyCode and trackInlineStats variables are included in the General Analytics Settings list by default.
このリストに、変数名と値を追加することができます。These predefined variables and any variables that you add are used to configure the properties of the s object in the analytics.sitecatalyst.js file. 次の例は、 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フレームワークページで、「一般的なAnalytics設定 」領域を展開します
  2. 変数のリストの下の「項目を追加」をクリックして、新しい変数をリストに追加します。
  3. 左側のセルに変数の名前(例: prop10 )を入力します。
  4. 右側の列に変数の値(例: CONSTANT )を入力します。
  5. 変数を削除するには、変数の横の(-)ボタンをクリックします。
変数と値を入力する際は、形式とスペルが正しいことを確認してください。そうでない場合は、正しい値と変数のペアを使用して​ 呼び出しが送信されません 。変数や値のスペルが間違っていると、呼び出しを実行することさえできない場合があります。
これらの変数が正しく設定されていることをAdobe Analyticsの担当者に確認してください。
Some of the variables in this list are mandatory in order for Adobe Analytics calls to function correctly, (e.g. currencyCode , charSet )
したがって、フレームワーク自体から削除されても、Adobe Analyticsの呼び出しが行われても、これらの変数にはデフォルト値が付加されます。

Adobe Analytics FrameworkへのカスタムJavaScriptの追加

The free-from javascript box in the General Analytics Settings area enables you to add custom code to a Adobe Analytics framework.
追加するコードは、analytics.sitecatalyst.js ファイルに付加されます。Therefore, you can access the s variable, which is an instance of the s_gi javascript object that is defined in s_code.js . 例えば、次のコードの追加は、前の節の例の値 prop10 の変数 CONSTANT の追加と同等です。
s.prop10= 'CONSTANT';
The code in the analytics.sitecatalyst.js file (which includes the content of the Adobe Analytics s-code.js file) contains the following code:
if (s.usePlugins) s.doPlugins(s)
次の手順は、javascriptボックスを使用してAdobe Analyticsの追跡をカスタマイズする方法を示しています。 If your javascript needs to use Adobe Analytics plugins, integrate them into 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. Add your javascript code in the s_doPlugins function.
次の例では、一般的な区切り文字「|」を使用して、ページ上でキャプチャされたデータを階層順に連結しています。
Adobe Analyticsフレームワークには次の設定があります。
  • Adobe Analytics変 prop2 数は、サイトのプロパティにマッピング pagedata.sitesection されます。
  • Adobe Analytics変 prop3 数は、サイトのプロパティにマッピング 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では次の値が生成されます。

Adding Global Custom Code for All Adobe Analytics Frameworks

すべてのAdobe Analyticsフレームワークに統合されるカスタムJavaScriptコードを提供します。 When a page's Adobe Analytics framework contains no custom free-form javascript , the javascript that the /libs/cq/analytics/components/sitecatalyst/config.js.jsp script generates is appended to the analytics.sitecatalyst.js file. デフォルトでは、このスクリプトはコメントアウトされているので無効です。The code also sets s.usePlugins to 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)
Therefore, your javascript should set s.usePlugins to true so that any code in the s_doPlugins function is executed. このコードをカスタマイズするには、独自の Javascript を使用するファイルで config.js.jsp ファイルをオーバーレイします。If your javascript needs to use Adobe Analytics plugins, integrate them into AEM.
/libs/cq/analytics/components/sitecatalyst/config.js.jsp ファイルは編集しないでください。特定の AEM アップグレードタスクまたはメンテナンスタスクによって、元のファイルが再インストールされ、変更内容が削除されることがあります。
  1. CRXDE Lite で、/apps/cq/analytics/components フォルダー構造を作成します。
    1. /apps フォルダーを右クリックして、作成/フォルダーを作成をクリックします。
    2. フォルダー名として「 cq 」を指定し、「OK」をクリックします。
    3. Similarly, create the analytics and components folders.
  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 コードを追加して、「すべて保存」をクリックします。
ページのフレームワークのフリーフォームの Javascript に何らかのテキストが存在する場合(スペースのみでも)、config.js.jsp は無視されます。

Using Adobe Analytics Plugins in AEM

Adobe AnalyticsプラグインのJavaScriptコードを取得し、AEMのAdobe Analyticsフレームワークに統合します。 カスタム Javascript コードで使用できるよう、コードを sitecatalyst.plugins カテゴリのクライアントライブラリフォルダーに追加します。
例えば、 getQueryParams プラグインを組み込む場合、カスタム Javascript の s_doPlugins 関数からプラグインを呼び出すことができます。The following example code sends the query string in "pid" from the referrer's URL as eVar1 , when a Adobe Analytics call is triggered.
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カテゴリにこれらのプラグインが含まれています。
プラグインを追加するときは、新しいクライアントライブラリフォルダーを作成してください。Do not add plugins to the /libs/cq/analytics/clientlibs/sitecatalyst/plugins folder. こうしておけば、AEM の再インストールやアップグレードをおこなっても、 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. Log in to sc.omniture.com using your Adobe Analytics account.
  2. ランディングページで、ヘルプ/ヘルプホームに移動します。
  3. 左側の目次で、「実装プラグイン」をクリックします。
  4. 追加するプラグインへのリンクをクリックし、ページが表示されたら、プラグインの Javascript ソースコードを探して、そのコードを選択し、コピーします。
  5. クライアントライブラリフォルダーを右クリックして、作成/ファイルを作成をクリックします。ファイル名として、組み込むプラグインの名前に「.js」を付けて入力し、「OK」をクリックします。例えば、getQueryParam プラグインを組み込む場合は、ファイルに「getQueryParam.js」という名前を付けます。
    作成したファイルが編集用に開かれます。
  6. プラグインの Javascript コードをファイルに貼り付け、「すべて保存」をクリックし、ファイルを閉じます。
  7. クライアントライブラリフォルダーの js.txt ファイルを開きます。
  8. 新しい行に、プラグインを格納しているファイルの名前(例:getQueryParam.js)を追加します。「すべて保存」をクリックして、ファイルを閉じます。
プラグインの使用時は、サポートプラグインも必ず組み込んでください。さもないと、プラグインの Javascript がサポートプラグイン内の関数に対しておこなわれる呼び出しを認識しません。例えば、getPreviousValue() プラグインを正しく機能させるには、split() プラグインが必要です。
サポートプラグインの名前も js.txt に追加する必要があります。