SNAnalytics - クライアント
SNAnalytics API は、カスタム分析データ (イベント、ページ、ユーザープロパティ) を サービスポータル ダッシュボードの使用状況インサイトにプッシュするメソッドを提供します。
使用状況インサイト for サービスポータル は、 サービスポータル 上にビルドされた Web アプリケーションの重要業績評価指標 (KPI) を監視するためのダッシュボードビューを提供します。これらのインサイトを使用して、ポータルを最適化できます。たとえば、 使用状況インサイト は、ユーザーがいつカタログアイテムを注文したか、いつナレッジ記事を閲覧したかを追跡します。このデータを使用して、どのアイテムまたは記事がユーザーの間で最も人気があるかを推測できます。
この API にアクセスするには、サービスポータルアナリティクス (com.glide.service-portal.analytics) プラグインをインスタンスでアクティブ化する必要があります。さらに、アプリケーション内で、次のような snAnalytics Angular サービスをインポートする必要があります。
<client_script><![CDATA[function($rootScope, $scope, $window, $timeout, spUtil, $sce, spModal, $uibModal, $location, cabrillo, snAnalytics)詳細については、「 サービスポータルの使用状況インサイト」を参照してください。
SNAnalytics - addEvent(オブジェクトペイロード)
指定されたイベント情報をアナリティクスデータストアに保存します。
イベントは、ボタンのクリックやフォームの送信など、ユーザーが実行するアクションです。ユーザーアクションをキャプチャする場合は常に、Web ページウィジェット内でこのメソッドを呼び出します。これらのイベントは、関連するユーザーセッションタイムラインとユーザーエクスペリエンスアナリティクスダッシュボードに自動的に表示されます。
var payload= {};
payload.name = "Manage Account";
payload.data = {};
payload.data["Function Name"] = c.data.function_name;
payload.data["User Type"] = c.data.user_type;
payload.data["Company"] = c.data.company_name;
snAnalytics.addEvent(payload);以下のスクリーン キャプチャは、イベント「アカウントの管理」のアナリティクス ダッシュボードに表示される情報を示しています。上部のタイムラインは、イベントが発生した回数を表します。タイムラインの下の円グラフには、 addEvent() 呼び出しでキャプチャされたプロパティが反映されています。
ユーザーが Web ページにアクセスしたときにキャプチャする場合は、このメソッドの代わりに SNAnalytics - startPage(文字列名, 文字列説明) メソッドを使用します。
| 名前 | タイプ | 説明 |
|---|---|---|
| payload | オブジェクト | アナリティクスデータストアに保存するイベント。 データタイプ: オブジェクト |
| payload.data | アレイ 各要素は、文字列 (大文字と小文字を区別)、ブーリアン、数値、または日付にすることができます。 |
オプション。カスタムイベントプロパティの名前と値のペア。これらのプロパティには、追跡してアナリティクスダッシュボードで表示する任意の値を指定できます。これらは、アナリティクスダッシュボードの関連イベントタイムラインの下に表示されます。すべてのベースシステムイベントのダッシュボードでは、 ページ ID プロパティが常に最初に表示され、他のすべてのプロパティはアルファベット順にソートされます。 イベントに必要なプロパティがない場合、アナリティクスダッシュボードにはイベントタイムラインのみが表示されます。プロパティは後で追加できます。 このメソッドでは、次の値が自動的に変換されます。
デフォルト値:Null |
| payload.name | 文字列 | イベントのわかりやすい名前。特殊文字は使用できません。 最大長:イベント名と値の長さは 300 バイトを超えることはできません。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、ウィジェットの初期化中に addEvent() メソッドを呼び出す方法を示しています。
function initialize() {
c.options.glyph = c.options.glyph || 'search';
c.options.title = c.options.title || c.data.searchMsg;
c.options.color = c.options.color || "default";
c.searchTerm = c.data.q;
c.searchQuery = "";
c.pageID = $scope.page && $scope.page.id;
c.showSuggestions = c.data.searchTypeBehavior === "suggestions" && c.data.isSuggestionsEnabled === "true";
c.suggestionsLimit = c.options.limit || "";
c.latitude = null;
c.longitude = null;
c.isLocationTrackerDisabled = c.data.isLocationTrackerDisabled === "true";
c.isTypeAheadEnabled = c.data.isTypeAheadEnabled === "true";
c.sendAnalytics = function(type){
var payload= {};
payload.name = "Initiate Search";
payload.data = {};
payload.data["Keyword"] = (type == 'User Entered' ? c.searchTerm : c.searchQuery);
payload.data["Type"] = type;
snAnalytics.addEvent(payload);
};
}SNAnalytics - appendToUserProperty(文字列名, 文字列値)
指定された文字列を、アナリティクスデータストアの指定されたユーザー文字列プロパティに追加します。
| 名前 | タイプ | 説明 |
|---|---|---|
| name | 文字列または文字列[] | 指定された文字列を追加するプロパティの名前。特殊文字は使用できません。 注:
関連付けられたプロパティは、文字列または string[] である必要があります。 最大長:プロパティ名とプロパティ値の長さは 300 バイトを超えることはできません。 |
| value | 文字列 | 文字列プロパティに追加する値。 このメソッドでは、次の値が自動的に変換されます。
|
| タイプ | 説明 |
|---|---|
| なし |
この例では、tags プロパティにテレビを追加する方法を示します。
snAnalytics.setUserProperties({
level: 7,
lastPurchase: new Date(),
lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
isPremium: true,
tags: ['chair', 'table'],
});
// Append television to the tags property (now 'tags' will have 'chair', 'table', and 'television')
snAnalytics.appendToUserProperty('tags', 'television');SNAnalytics - incUserProperty(文字列名, 数値)
アナリティクスデータストアで指定されたユーザープロパティ値を指定された数値でインクリメントまたはデクリメントします。
| 名前 | タイプ | 説明 |
|---|---|---|
| name | 文字列 | インクリメントするプロパティの名前。値では大文字と小文字が区別されます。 注: 関連するプロパティは数値である必要があります。 |
| value | 番号 | プロパティをインクリメントする金額。負の数を入力すると、値はデクリメントされます。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、プロパティ の猶予日数を 5 インクリメントする方法を示しています。
snAnalytics.incUserProperty('Grace days', 5)SNAnalytics - removeUserProperty(文字列名)
現在のユーザーの指定されたプロパティをアナリティクスデータストアから削除します。
また、プロパティはアナリティクスダッシュボードに表示されなくなります。
| 名前 | タイプ | 説明 |
|---|---|---|
| name | 文字列 | 削除するプロパティの名前。値では大文字と小文字が区別されます。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、IsAdmin プロパティを削除する方法を示しています。
snAnalytics.removeUserProperty('IsAdmin');SNAnalytics - setUserProperties(オブジェクトプロパティ)
アナリティクスデータストア内の現在のユーザーに対して、指定されたプロパティに指定された値を設定します。
これらのプロパティはアナリティクスデータストアに保存され、次の図に示すようにユーザーセッションの詳細ページに表示されます。プロパティがアナリティクスデータストアに既に存在する場合、現在の値は新しい値で上書きされます。
| 名前 | タイプ | 説明 |
|---|---|---|
| プロパティ | オブジェクト このオブジェクトの各要素は、文字列、ブーリアン、数値、日付、string[]、または null にすることができます。 |
設定するユーザープロパティの名前と値のペアを含むオブジェクト。例:このメソッドでは、次の値が自動的に変換されます。
|
| タイプ | 説明 |
|---|---|
| なし |
次の例は、現在のユーザーに対して複数のプロパティを設定する方法を示しています。
snAnalytics.setUserProperties({
level: 7,
lastPurchase: new Date(),
lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
isPremium: true,
tags: ['chair', 'table'],
});SNAnalytics - setUserProperty(文字列名, UserProperty 値)
アナリティクスデータストア内の現在のユーザーに対して、指定されたプロパティを指定された値で設定します。
これらのプロパティはアナリティクスデータストアに保存され、次の図に示すようにユーザーセッションの詳細ページに表示されます。プロパティがアナリティクスデータストアに既に存在する場合、現在の値は新しい値で上書きされます。
| 名前 | タイプ | 説明 |
|---|---|---|
| name | 文字列 | 更新するプロパティの名前。この名前はプロパティのラベルとして表示されます。たとえば、前のスクリーンショットでは、[ドメイン]、[インスタンス名]、[会社]、[ロール]、および [ユーザータイプ] がすべて名前パラメーターです。特殊文字は使用できません。 最大長:プロパティ名とプロパティ値の長さは 300 バイトを超えることはできません。 |
| value | ユーザープロパティ この値は、文字列、ブーリアン、数値、日付、string[]、または null にすることができます。 |
指定されたプロパティに設定する値。 このメソッドでは、次の値が自動的に変換されます。
|
| タイプ | 説明 |
|---|---|
| なし |
次の例は、 プロパティ Company の設定方法を示しています。
snAnalytics.setUserProperty('Company', "ABC Company")SNAnalytics - startPage(文字列名, 文字列説明)
ページの名前と説明をアナリティクスデータストアに保存します。
| 名前 | タイプ | 説明 |
|---|---|---|
| name | 文字列 | ページまたはページセクションのわかりやすい名前。特殊文字は使用できません。 |
| 説明 | 文字列 | オプション。タイムラインとアナリティクスダッシュボードに表示されるページの説明。 デフォルト: name パラメーター値 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、 startPage() メソッドを呼び出す方法を示しています。
snAnalytics.startPage('login_view', 'Login');