イベント追跡の拡張

AEM Analytics では、Web サイトでのユーザーインタラクションを追跡できます。開発者は次の作業が必要になる場合があります。

• 訪問者がコンポーネントとどのようなやり取りをおこなっているかの追跡。これを行うには、カスタムイベントを使用します。
• ContextHub の値へのアクセス。
• レコードのコールバックの追加。

カスタムイベント

カスタムイベントはページ内の特定のコンポーネントの可用性に依存する要素を追跡します。これにはテンプレート特有のイベントも含まれます。ページコンポーネントは別のコンポーネントとして扱われています。

ページの読み込み時のカスタムイベントの追跡

これを行うには、疑似属性 data-tracking（下位互換性のために、古いレコード属性がまだサポートされています）を使用します。これは任意の HTML タグに追加できます。

data-tracking の構文は次のとおりです。

• data-tracking="{'event': ['eventName'], 'values': {'key': 'value', 'nextKey': 'nextValue'}, componentPath: 'myapp/component/mycomponent'}"

2 番目のパラメーターとして、任意の数のキーと値のペアを渡すことができます。これをペイロードと呼びます。

次に例を示します。

<span data-tracking="{event:'blogEntryView',
                                values:{
                                   'blogEntryContentType': 'blog',
                                   'blogEntryUniqueID': '<%= xssAPI.encodeForJSString(entry.getId()) %>',
                                   'blogEntryTitle': '<%= xssAPI.encodeForJSString(entry.getTitle()) %>',
                                   'blogEntryAuthor':'<%= xssAPI.encodeForJSString(entry.getAuthor()) %>',
                                   'blogEntryPageLanguage':'<%= currentPage.getLanguage(true) %>'
                                },
                                componentPath:'myapp/component/mycomponent'}">
</span>

ページの読み込み時に、すべての data-tracking 属性が収集されて ContextHub のイベントストアに追加され、Adobe Analytics イベントにマッピングできるようになります。マッピングされないイベントは Adobe Analytics では追跡されません。マッピングイベントについて詳しくは、Adobe Analytics への接続を参照してください。

ページの読み込み後のカスタムイベントの追跡

ページの読み込み後に発生するイベント（ユーザーインタラクションなど）を追跡するには、JavaScript 関数 CQ_Analytics.record を使用します。

• CQ_Analytics.record({event: 'eventName', values: { valueName: 'VALUE' }, collect: false, options: { obj: this, defaultLinkType: 'X' }, componentPath: '<%=resource.getResourceType()%>'})

ここで、

• events：文字列、または文字列の配列（イベントが複数の場合）。

• values：追跡するすべての値を格納します。

• collect：オプションで、イベントおよびデータオブジェクトを格納する配列を返します。

• options：オプションであり、HTML 要素 obj および [defaultLinkType](https://microsite.omniture.com/t2/help/en_US/sc/implement/index.html#linkType) などのリンク追跡オプションが含まれます。

• componentPath：必須の属性。<%=resource.getResourceType()%> に設定することを推奨します。

例えば、次のように定義した場合、「Jump to top」リンクをクリックすると jumptop と headlineclick の 2 つのイベントが実行されます。

<h1 data-tracking="{event: 'headline', values: {level:'1'}, componentPath: '<%=resource.getResourceType()%>'}">
  My Headline <a href="#" onclick="CQ_Analytics.record({event: ['jumptop','headlineclick'],  values: {level:'1'}, componentPath: '<%=resource.getResourceType()%>'})">Jump to top</a>
</h1>

ContextHub の値へのアクセス

ContextHub JavaScript API には、指定したストアを返す getStore(name) 関数があります（使用可能な場合）。このストアには、指定したキーの値を返す getItem(key) 関数があります（使用可能な場合）。getKeys() 関数を使用すると、特定のストアに対して定義されたキーの配列を取得できます。

ContextHub.getStore(name).eventing.on(ContextHub.Constants.EVENT_STORE_UPDATED, handler, selector, triggerForPastEvents) 関数を使用して関数をバインドすると、ストアの値が変更されたことを知らせる通知を受けることができます。

ContextHub の利用開始の通知を受けるには、ContextHub.eventing.on(ContextHub.Constants.EVENT_ALL_STORES_READY, handler, selector, triggerForPastEvents); 関数を使用するのが最適です。

ContextHub のその他のイベント：

すべてのストアに対応：

ContextHub.eventing.on(ContextHub.Constants.EVENT_ALL_STORES_READY, handler, selector, triggerForPastEvents);

ストア固有：

ContextHub.getStore(store).eventing.on(ContextHub.Constants.EVENT_STORE_READY, handler, selector, triggerForPastEvents)

レコードコールバックの追加

関数 CQ_Analytics.registerBeforeCallback(callback,rank) と CQ_Analytics.registerAfterCallback(callback,rank) を使用して、before コールバックと after コールバックを登録します。

どちらの関数も、先頭の引数では関数を、2 番目の引数ではランクを受け取ります。このランクによって、コールバックの実行順序が決定されます。

コールバックが false を返す場合、実行チェーンの後続のコールバックは実行されません。