SNAnalytics - 클라이언트
SNAnalytics API는 사용자 지정 분석 데이터(이벤트, 페이지 및 사용자 속성)를 for 서비스 포털 대시보드로 푸시하는 사용자 경험 분석 메서드를 제공합니다.
사용자 경험 분석 는 서비스 포털 에 구축된 서비스 포털웹 애플리케이션의 핵심성과지표(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(객체 페이로드)
지정된 이벤트 정보를 분석 데이터 저장소에 저장합니다.
이벤트는 버튼 클릭 또는 양식 제출과 같이 사용자가 수행하는 작업입니다. 사용자 작업을 캡처할 때마다 웹 페이지 위젯 내에서 이 메서드를 호출합니다. 그러면 이러한 이벤트가 연결된 사용자 세션 타임라인 및 사용자 경험 분석 대시보드에 자동으로 나타납니다.
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() 호출에서 캡처된 속성을 반영합니다.
사용자가 웹 페이지에 액세스할 때 캡처하려면 이 메서드 대신 이 SNAnalytics - startPage(문자열 이름, 문자열 설명) 메서드를 사용합니다.
| 이름 | 유형 | 설명 |
|---|---|---|
| 페이로드 | 객체 | 분석 데이터 저장소에 저장할 이벤트입니다. 데이터 유형: 객체 |
| 페이로드.데이터 | 배열 각 요소는 문자열(대/소문자 구분), 부울, 숫자 또는 날짜일 수 있습니다. |
옵션입니다. 사용자 지정 이벤트 속성의 이름-값 쌍. 이러한 속성은 분석 대시보드에서 추적하고 확인하려는 값일 수 있습니다. 분석 대시보드의 연결된 이벤트 타임라인 아래에 표시됩니다. 페이지 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(문자열 이름, 문자열 값)
분석 데이터 저장소의 지정된 사용자 문자열 속성에 지정된 문자열을 추가합니다.
| 이름 | 유형 | 설명 |
|---|---|---|
| 이름 | 문자열 또는 문자열[] | 지정된 문자열을 추가할 속성의 이름입니다. 특수 문자는 허용되지 않습니다. 주:
연결된 속성은 string 또는 string[]이어야 합니다. 최대 길이: 속성 이름 및 속성 값의 길이는 300바이트를 초과할 수 없습니다. |
| 값 | 문자열 | 문자열 속성에 추가할 값입니다. 이 메서드에서 자동으로 변환되는 값은 다음과 같습니다.
|
| 유형 | 설명 |
|---|---|
| 없음 |
이 예제에서는 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(문자열 이름, 숫자 값)
분석 데이터 저장소에서 지정된 사용자 속성 값을 지정된 숫자 값으로 늘리거나 줄입니다.
| 이름 | 유형 | 설명 |
|---|---|---|
| 이름 | 문자열 | 증가할 속성의 이름입니다. 값은 대/소문자를 구분합니다. 주: 연결된 속성은 숫자여야 합니다. |
| 값 | 번호 | 속성을 증가시킬 금액입니다. 음수를 입력하면 값이 감소합니다. |
| 유형 | 설명 |
|---|---|
| 없음 |
다음 예제에서는 Grace days 속성을 5씩 증가시키는 방법을 보여 줍니다.
snAnalytics.incUserProperty('Grace days', 5)SNAnalytics - removeUserProperty(문자열 이름)
분석 데이터 저장소에서 현재 사용자에 대해 지정된 속성을 제거합니다.
또한 이 속성은 더 이상 분석 대시보드에 표시되지 않습니다.
| 이름 | 유형 | 설명 |
|---|---|---|
| 이름 | 문자열 | 제거할 속성의 이름입니다. 값은 대/소문자를 구분합니다. |
| 유형 | 설명 |
|---|---|
| 없음 |
다음 예제에서는 IsAdmin 속성을 제거하는 방법을 보여 줍니다.
snAnalytics.removeUserProperty('IsAdmin');SNAnalytics - setUserProperties(Object properties)
분석 데이터 저장소에서 현재 사용자에 대해 지정된 값을 사용하여 지정된 속성을 설정합니다.
이러한 속성은 분석 데이터 저장소에 저장되고 아래 그림과 같이 사용자 세션 세부 정보 페이지에 나타납니다. 분석 데이터 저장소에 속성이 이미 있는 경우 현재 값을 새 값으로 덮어씁니다.
| 이름 | 유형 | 설명 |
|---|---|---|
| 속성 | 객체 이 객체의 각 요소는 문자열, 부울, 숫자, 날짜, string[] 또는 null일 수 있습니다. |
다음과 같이 설정할 사용자 속성의 이름-값 쌍을 포함하는 객체입니다.이 메서드에서 자동으로 변환되는 값은 다음과 같습니다.
|
| 유형 | 설명 |
|---|---|
| 없음 |
다음 예제에서는 현재 사용자에 대해 여러 속성을 설정하는 방법을 보여 줍니다.
snAnalytics.setUserProperties({
level: 7,
lastPurchase: new Date(),
lastPurchaseId: '41563cd2-1666-4855-8c0d-b9ca778aed23',
isPremium: true,
tags: ['chair', 'table'],
});SNAnalytics - setUserProperty(문자열 이름, UserProperty 값)
분석 데이터 저장소에서 현재 사용자에 대해 지정된 값을 사용하여 지정된 속성을 설정합니다.
이러한 속성은 분석 데이터 저장소에 저장되고 아래 그림과 같이 사용자 세션 세부 정보 페이지에 나타납니다. 분석 데이터 저장소에 속성이 이미 있는 경우 현재 값을 새 값으로 덮어씁니다.
| 이름 | 유형 | 설명 |
|---|---|---|
| 이름 | 문자열 | 업데이트할 속성의 이름입니다. 이 이름은 속성의 레이블로 표시됩니다. 예를 들어, 이전 스크린샷에서 도메인, 인스턴스 이름, 회사, 역할 및 사용자 유형은 모두 이름 매개변수입니다. 특수 문자는 허용되지 않습니다. 최대 길이: 속성 이름 및 속성 값의 길이는 300바이트를 초과할 수 없습니다. |
| 값 | UserProperty 이 값은 문자열, 부울, 숫자, 날짜, string[] 또는 null일 수 있습니다. |
지정된 속성에 설정할 값입니다. 이 메서드에서 자동으로 변환되는 값은 다음과 같습니다.
|
| 유형 | 설명 |
|---|---|
| 없음 |
다음 예제에서는 Company 속성을 설정하는 방법을 보여 줍니다.
snAnalytics.setUserProperty('Company', "ABC Company")SNAnalytics - startPage(문자열 이름, 문자열 설명)
분석 데이터 저장소에 페이지의 이름과 설명을 저장합니다.
| 이름 | 유형 | 설명 |
|---|---|---|
| 이름 | 문자열 | 페이지 또는 페이지 섹션의 설명이 포함된 이름입니다. 특수 문자는 허용되지 않습니다. |
| 설명 | 문자열 | 옵션입니다. 타임라인 및 분석 대시보드에 표시할 페이지에 대한 설명입니다. 기본값: name 매개변수 값 |
| 유형 | 설명 |
|---|---|
| 없음 |
다음 예제에서는 startPage() 메서드를 호출하는 방법을 보여 줍니다.
snAnalytics.startPage('login_view', 'Login');