現在表示中:

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

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

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

ページ内の Javascript が s_gi オブジェクト(SiteCatalyst ライブラリ s_code.js が定義)を作成し、そのプロパティに値を割り当てます。オブジェクトインスタンスの名前は 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 コードを使用してフレームワークをカスタマイズする場合は、このファイルの内容を変更します。

SiteCatalyst のプロパティの設定

SiteCatalyst には、フレームワーク上で設定できる事前定義済みの変数が数多くあります。変数 charsetcookieLifetimecurrencyCode および trackInlineStats は、SiteCatalyst の一般設定リストにデフォルトで含まれています。

chlimage_1

このリストに、変数名と値を追加することができます。これらの事前定義済みの変数と、追加したすべての変数を使用して、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. SiteCatalyst フレームワークページで、SiteCatalyst の一般設定領域を展開します。
  2. 変数のリストの下の「項目を追加」をクリックして、新しい変数をリストに追加します。
  3. 左側のセルに 変数の名前(例:prop10)を入力します。
  4. 右側の列に 変数の値(例:CONSTANT)を入力します。
  5. 変数を削除するには、変数の横の(-)ボタンをクリックします。

注意:

変数と値を入力する際は、形式とスペルが正しいことを確認してください。そうでない場合は、正しい値と変数のペアを使用して呼び出しが送信されません。変数や値のスペルが間違っていると、呼び出しを実行することさえできない場合があります。

SiteCatalyst の担当者に相談して、これらの変数が正しく設定されていることを確認してください。

警告:

このリストの変数の一部は、SiteCatalyst の呼び出しを正しく機能させるうえで必須です(currencyCodecharSet など)。

そのため、フレームワーク自体から変数を削除しても、SiteCatalyst 呼び出しがおこなわれると、デフォルト値を持つ変数が付加されます。

SiteCatalyst フレームワークへのカスタム Javascript の追加

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

chlimage_1

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

s.prop10= 'CONSTANT';

analytics.sitecatalyst.js ファイル(SiteCatalyst の s_code.js ファイルの内容を含む)のコードには、次のコードが含まれます。

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

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

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

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

    警告:

    何らかの方法でカスタマイズ済みで、基本のドラッグアンドドロップインターフェイスまたは SiteCatalyst ビューのインライン Javascript からは実行できない SiteCatalyst 呼び出しに変数を含めて送信する場合は、このコードが必要です。

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

  2. Javascript コードを s_doPlugins 関数に追加します。

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

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

  • SiteCatalyst 変数 prop2 は、サイトプロパティ pagedata.sitesection にマップされます。
  • SiteCatalyst 変数 prop3 は、サイトプロパティ pagedata.subsection にマップされます。
  • 次のコードがフリーフォームの Javascript ボックスに追加されます。

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

  • このフレームワークを使用する Web ページが訪問される(または、編集モードでページが再読み込みまたはプレビューされる)と、SiteCatalyst への呼び出しが実行されます。

http://localhost:4402/cf#/content/geometrixx-outdoors/en/men.html ページの場合、次の値が SiteCatalyst で生成されます。

すべての SiteCatalyst フレームワーク用のグローバルカスタムコードの追加

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

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

analytics.sitecatalyst.js ファイル(SiteCatalyst の s_code.js ファイルの内容を含む)のコードには、次のコードが含まれます。

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

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

注意:

/libs/cq/analytics/components/sitecatalyst/config.js.jsp ファイルは編集しないでください。特定の 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 コードが、SiteCatalyst フレームワークを使用するすべてのページ用の analytics.sitecatalyst.js ファイルに挿入されます。

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

警告:

ページのフレームワークのフリーフォームの Javascript に何らかのテキストが存在する場合(スペースのみでも)、config.js.jsp は無視されます。 

AEM での SiteCatalyst プラグインの使用

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

例えば、getQueryParams プラグインを組み込む場合、カスタム Javascript の s_doPlugins 関数からプラグインを呼び出すことができます。次のコード例では、SiteCatalyst 呼び出しがおこなわれると、リファラーの 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 では次の SiteCatalyst プラグインがインストールされ、デフォルトで使用可能です。

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

/etc/clientlibs/foundation/sitecatalyst/plugins クライアントライブラリフォルダーには、上記の sitecatalyst.plugins カテゴリのプラグインが含まれています。

注意:

プラグインを追加するときは、新しいクライアントライブラリフォルダーを作成してください。/etc/clientlibs/foundation/sitecatalyst/plugins フォルダーにはプラグインを追加しないようにします。こうしておけば、AEM の再インストールやアップグレードをおこなっても、sitecatalyst.plugins カテゴリに加えた変更が上書きされずに済みます。

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

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

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

    • 名前:クライアントライブラリフォルダーの名前(例:my-plugins)
    • タイプ:cq:ClientLibraryFolder
  3. 作成したクライアントライブラリフォルダーを選択し、右下のプロパティバーを使用して、次のプロパティを追加します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

注意:

プラグインの使用時は、サポートプラグインも必ず組み込んでください。さもないと、プラグインの Javascript がサポートプラグイン内の関数に対しておこなわれる呼び出しを認識しません。例えば、getPreviousValue() プラグインを正しく機能させるには、split() プラグインが必要です。

サポートプラグインの名前も js.txt に追加する必要があります。

 

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー