Pega Systems

アプリケーションのインストルメンテーションを開始する前に、アプリを作成してappKeyがあることを確認してください。

インストール

Pyze Analytics for Pegaのインストールは簡単で、依存関係としてPegaウェブ解析コンポーネントが必要です。

Pyzeコンポーネントをgithubのリリースからダウンロードしてください。

pegaマーケットプレイスからPegaコンポーネントをダウンロードする

• アプリケーション定義を開きます。(アプリケーション -> 定義)
• コンポーネントの管理] をクリックします。
• 新規インストールを選択し、コンポーネントを含むzipファイルを選択します。Web Analyticsコンポーネントでの起動
• 開く] をクリックします。
• このアプリケーションの新しいコンポーネントを有効にするには、[有効] を選択します。
• OK] をクリックします。

詳細については、リンクを確認してください。コンポーネントのインストール

初期化

Pyzeコンポーネントを初期化するには、AppタブでData-Admin-System-Settingsを開き、以下のようにData-Admin-System-Settingsを検索します。

PyzeIntegRSを見つけ、値をAppkeyに設定します。

pyze SDKは、多くの自動化されたメトリクスの取得を開始します。

カスタムイベント

イベントでは、アプリ内でのユーザーのユニークなアクションを簡単に追跡することができます。

イベント

Pyzeのカスタムイベントは、pegaのRun Scriptsから呼び出すことができます。

• 以下の画像のように、ボタンアクションにRunスクリプトを追加します。
• 以下のスニペットを関数名として渡します。

"PyzeEvents.postCustomEvent"

• 以下に示すように、イベント名として実行スクリプトアクションにパラメータを追加します。

これにより、ユーザーがいつアクションを実行したかを追跡し、そのイベントがどれくらいの頻度で発生しているかを簡単にカウントすることができます。

属性を持つイベント

属性とは、イベントにアタッチできるキーと値のペアのことです。どのイベントでも最大99個の属性を持つことができます。ベスト・プラクティスを遵守し、アトリビュートに大きく依存して、インストルメンテーションを可能な限り最小限にして有用にすることを強くお勧めします。典型的なアプリケーションでは、イベントよりも多くの属性を持つべきです。

• カスタムアトリビュートを送信するPyze APIは、JSON形式のアトリビュートを受け付けます。
• Records -> Technical -> HTML Fragment で HTML Fragment を作成します。
• 以下のようにスクリプトタグを追加し、Runスクリプトから呼び出されるjavascript関数を定義します。

<script>
function postCustomEventWithAttrbutes(){
  var attributes = {};
  attributes["screen"] = "Home";
  attributes["seconds spent"] = "50";
  PyzeEvents.postCustomEventWithAttributes("Blog Read", attributes);
}
</script>

• 最後にRun ScriptからpostCustomEventWithAttrbutes関数を呼び出します。関数を呼び出している間は、二重反転引用符を使わないようにしましょう。

タイムドイベント

ユーザーがアクションを完了するまでにかかる時間を計ることは、Pyze の一般的な使用例です。SDkには、タイマーを開始し、アクションの完了時にカスタムイベントを送信できるようにすることで、これを処理する機能が組み込まれています。

• startTimerForEvent - 名前を指定してタイマーを開始する
• postTimedEvent - 同じ名前を参照してタイマーを終了します。ミリ秒単位の時間が自動的にこのイベントに添付されます。また、以下の例のように、追加のパラメタとして属性を渡すこともできます。

//Start timer for event
PyzeEvents.startTimerForEvent("Screen Load Time");

//Post timed event. 
//Note : The event name attribute for the `startTimerForEvent` and  `postTimedEvent` should match.
PyzeEvents.postTimedEvent("Screen Load Time");

//Post timed event API when you want to send additional attributes
var customAttributes = {};
customAttributes["device"] = "iMac";
customAttributes["location"] = "CA";
PyzeEvents.postTimedEventWithAttributes("Screen Load Time", customAttributes);

Profile

プロフィール

プロファイルは、Pyzeにユーザーに関するデータを追加するための強力な方法です。プロファイルを使用して、ある時点（イベント）に固有のデータではなく、特定のユーザーに関連付けられたデータを追加することができます。

ユーザーがアプリにログインしたら、setUserProfileを呼び出してPyzeにユーザーを識別します。ユーザーが識別された後に発生したイベントはすべて、このユーザーに帰属します。このメソッドは、セッションの最初のログイン時に一度だけ呼び出す必要があります。

オプションでプロファイル属性を含めることができます。

Pyzeの組み込みプロファイル属性はpyze UIで特別な扱いを受けますが、受信したデータに基づいてカスタム属性のデータ型を判別しようとします。ビルトイン属性とカスタム属性の間には、適用されるフォーマット以外の違いはありません。

//Create Pyze Profile Attributes object
var pyzeProfileAttributes = {
   "email_id"        : "xyz@abc.com",
   "date_of_birth"   : "1984-06-01",
   "first_name"      : "John",
   "last_name"       : "Jacobs"
}
//Create Custom Profile Attributes object
var customProfileAttributes = {
   "age"       : 29,
   "pincode"   : "23200",
   "city"      : "XYZ"
}
//Call the setUserProfile API
PyzeIdentity.setUserProfile(userId,pyzeProfileAttributes,customProfileAttributes);

Pyzeのプロフィール属性

既存のユーザープロファイルの更新

既に設定されているユーザプロファイルの属性を更新するには、以下のAPIを使用します。

注意 : setUserProfileを呼び出す前にこのAPIを呼び出さないでください。

//Create Pyze Profile Attributes object
var pyzeProfileAttributes = {
   "email_id"        : "xyz2@abc.com",
   "date_of_birth"   : "1984-07-01",
   "first_name"      : "John M",
   "last_name"       : "Jacobs"
}
//Create Custom Profile Attributes object
var customProfileAttributes = {
   "age"       : 29,
   "pincode"   : "232001",
   "city"      : "XYZ2"
}
//Call the updateUserProfileAttributes API
PyzeIdentity.updateUserProfile(pyzeProfileAttributes,customProfileAttributes);

ユーザーのログアウト

ユーザがログアウトした際にこの API を呼び出します。このコールの後に送信されるイベントには ID は付与されず、匿名のユーザに帰属します。

PyzeIdentity.resetUserProfile(); 

ユーザーのプライバシー

Pyzeは、エンドユーザーがデータ収集からオプトアウトしたり、ユーザーのデータを忘れるようにPyzeシステムに指示したりするためのAPIを提供しています。

setUserOptOut

エンドユーザーがデータ収集からオプトアウトできるようにします。オプトアウトはTrueかFalseかを切り替えることができます。

Pyze.setUserOptOut(true) 

ユーザーデータの収集を再開するには、値を false に設定します。

削除ユーザー

エンドユーザがデータ収集からオプトアウトし、Pyzeシステム内のユーザを削除することができます。一度削除したユーザーは元に戻すことができませんので、確認することをお勧めします。

Pyze.deleteUser(true) 

API リファレンス

APIのリファレンスはこちらからご覧いただけます。