APIを使用してGuideアナリティクスをカスタマイズする

CXone Dashboardを使用しGuideメトリックを表示することで、Guideの訪問者の行動を追跡できます。

以下のAPIを使用して、カスタムイベントの定義、訪問者変数の保存、コンバージョンデータの保存、Webタグの割り当てと削除などを行います。

訪問者イベントの設定

定義済みの訪問者の行動(イベント)をレポート目的で保存します。この呼び出しをGuideで使用すると、'event_type''custom_event_type'に変更されます。'custom_event_data'を、オブジェクト構造体を含む任意のタイプのデータパラメーターで置換します。

cxone('analytics','setVisitorEvent', 'event_type', 'custom_event_data');

訪問者変数の設定

定義済みの訪問者の情報をレポート目的で保存します。

cxone('analytics','setVisitorVariable', 'variable_identifier', 'variable_value');

コンバージョンの保存

レポーティング目的で、訪問者の行動をコンバージョンとして保存します。conversion_dateパラメーターが省略された場合、現在の日付と時刻が変換に使用されます。

cxone('analytics','storeConversion', 'conversion_type', conversion_value, conversion_date);

これらを以下のように設定します:

  • 'conversion_type'をUSDなどの値で置換します。

  • conversion _valueを、エンゲージメントの効果を追跡するためのガイドレポートで使用する数値で置換します。

  • conversion_dateをJavaScriptの日付オブジェクトで置換します。省略された場合は、new Date()が使用されます。

ウェブ訪問者のタグを割り当てる

指定されたタグを訪問者に追加します。以下の構文例では、'tagID'をa visitor tagで置換します。

cxone('analytics','addVisitorTags', 'tagID');

ウェブ訪問者のタグを削除する

訪問者から特定のタグを削除します。以下の構文例では、'tagID'をa visitor tagで置換します。

cxone('analytics','removeVisitorTags', 'tagID');

訪問データをクリアする

現在の訪問に関する情報を削除します。訪問はブラウジングセッションです。ユーザーがページをリロードした場合、 Guideはそれを新規訪問と見なします。

cxone('analytics','clearVisit');

国を設定する

国のカスタム値を設定できるようにします。入力は文字列です。'Country'をブラウザーの国コードで置換します。

cxone('analytics','setDeviceCountry','Country');

場所を設定する

カスタムの場所の値を設定できるようにします。入力は文字列です。'Location'をブラウザーのロケーションコードで置換します。

cxone('analytics','setDeviceLocation','Location');

SPA検出をオフにする

単一ページアプリケーションの自動検出をオフにします。

cxone('analytics', 'setSPADetection', false);

ページがロードされました

Guideがページが更新されたことを認識できるようにします。これは、単一ページアプリケーション検出がオフの場合に使用されます。入力は文字列です。'page-url'をページURLで、または'page-title'をページタイトルで置換します。

cxone('analytics', 'sendPageView', url: 'page-url';
cxone('analytics', 'sendPageView', title: 'page-title';

ウェブトラッキングを無効にする

ウェブトラッキングモジュールを無効にします。

cxone('disableModule', 'analytics');