APICloud SDK
1. 概述
SensorsAnalyticsAPICloudSDK 封裝了 Sensors Analytics 數據統計 Android & iOS SDK,使用此模組可進行用戶行為數據採集。
神策分析,是針對企業級客戶推出的深度用戶行為分析產品,支援私有化部署,用戶端、伺服器、業務數據、第三方數據的全端採集和建模,驅動行銷管道效果評估、用戶精細化營運改進、產品功能及用戶體驗優化、老闆看板輔助管理決策、產品個性化推薦改造、用戶標籤體系構建等應用場景。作為 PaaS 平台支援二次開發,可透過 BI、大數據平台、CRM、ERP 等內部 IT 系統,構建用戶數據體系,讓用戶行為數據發揮深遠的價值。
2. 使用此模組需要在 config.xml 檔案中設定相應的 feature
設定範例:
<feature name="sensorsAnalyticsAPICloudSDK">
<param name="serverURL" value="數據接收網址URL"/>
<param name="debugMode" value="debugOff"/>
<param name="enableAutoTrack" value="true"/>
<param name="downloadChannel" value="應用寶" />
<param name="enableLog" value="false"/>
</feature>
設定說明:
- feature 名稱:sensorsAnalyticsAPICloudSDK
- param 參數
- serverURL:(必填選項,如果有特殊字元 & ,使用&) 數據接收網址 URL。
- debugMode:(必填選項) Debug 模式,有三種模式:
- debugOff - 關閉 Debug 模式,發版 App 時使用此模式
- debugAndTrack - 打開 Debug 模式,校驗數據,並將數據匯入神策分析系统中
- debugOnly - 打開 Debug 模式,校驗數據,但不進行數據匯入
- enableAutoTrack:(可選項) 是否採集 App 啟動、App 退出事件,傳入字串 true 表示採集啟動、退出事件
- downloadChannel:(可選項) App 的下載管道,設定此參數時,會觸發 App 安裝啟動事件(AppInstall),下載管道會儲存在 DownloadChannel 欄位中
- enableLog:(可選項) 是否開啟除錯 log,傳入字串 true 表示開啟除錯 log。
請注意:Debug 模式是為方便開發者除錯而設定的模式,該模式會逐條校驗數據並在校驗失敗時拋出異常,效能遠低於正常模式。線上環境使用 Debug 模式會嚴重影響效能並存在崩潰風險,產品上線前請務必替換掉/關閉 Debug 模式。
3. login
設定當前用戶的 loginId
login({params})
loginId:
- 型別:字串
- 描述:(必填選項)用戶的登入id,不能為空,且長度不能大於255
var sa = api.require('sensorsAnalyticsAPICloudSDK');
sa.login({
loginId: '123456'
});
4. registerSuperProperties
設定公共屬性,設定之後,觸發的事件會帶上設定的公共屬性
registerSuperProperties({params})
properties:
- 型別:json 格式
- 描述:(必填選項)公共屬性,屬性名需要滿足一般變數的命名規則
var sa = api.require('sensorsAnalyticsAPICloudSDK');
sa.registerSuperProperties({properties:{ PlatformType:"Android"}});
5. track
track 事件。
track({params})
event:
- 型別:字串
- 描述:(必填選項)事件名稱,名稱需要滿足一般變數的命名規則,即不能以數字開頭,且只包含:大小寫字母、數字、下底線和$
properties:
- 型別:json 格式
- 描述:(必填選項)事件名稱,名稱需要滿足一般變數的命名規則,即不能以數字開頭,且只包含:大小寫字母、數字、下底線和$
var sa = api.require('sensorsAnalyticsAPICloudSDK');
sa.track({
event:'ViewProduct',
properties:{
ProductID:123456,
ProductCatalog:'Laptop Computer',
IsAddedToFav: false
}
});
6. trackTimerStart
事件計時開始,需要和 trackTimerEnd 成對使用。
trackTimerStart({params})
event:
- 型別:字串
- 描述:(必填選項)事件名稱,名稱需要滿足一般變數的命名規則,即不能以數字開頭,且只包含:大小寫字母、數字、下底線和$
var sa = api.require('sensorsAnalyticsAPICloudSDK');
sa.trackTimerStart({event:'ViewPage'});
7. trackTimerEnd
trackTimerEnd 計時結束,並觸發事件,事件時常記錄在 event_duration 欄位中。計時開始和計時結束,所對應的 event 事件名必須一致。
trackTimerEnd({params})
event:
- 型別:字串
- 描述:(必填選填)事件名稱,名稱需要滿足一般變數的命名規則,即不能以數字開頭,且只包含:大小寫字母、數字、下底線和$
properties:
- 型別:json 格式
- 描述:(必填選項)事件名稱,名稱需要滿足一般變數的命名規則,即不能以數字開頭,且只包含:大小寫字母、數字、下底線和$
var sa = api.require('sensorsAnalyticsAPICloudSDK');
sa.trackTimerEnd({
event:'ViewPage',
properties:{
pageID:"111"
}
});
8. profileSet
profileSet 設定用戶屬性。
profileSet({params})
properties:
- 型別:json 格式
- 描述:(必填選項)事件名稱,名稱需要滿足一般變數的命名規則,即不能以數字開頭,且只包含:大小寫字母、數字、下底線和$
var sa = api.require('sensorsAnalyticsAPICloudSDK');
sa.profileSet({
properties:{
sex:"男"
}
});
9. profileSetOnce
profileSetOnce 設定用戶首次屬性。
profileSetOnce({params})
properties:
- 型別:json 格式
- 描述:(必填選項)事件名稱,名稱需要滿足一般變數的命名規則,即不能以數字開頭,且只包含:大小寫字母、數字、下底線和$
var sa = api.require('sensorsAnalyticsAPICloudSDK');
sa.profileSet({
properties:{
firstCharge:100
}
});
10. getDistinctId
getDistinctId 取得當前用戶的 distinctId ,如果用戶未登入時,回傳值為 匿名 ID ;登入(呼叫login)後,回傳值為 登入 ID 。
getDistinctId()
- 回傳值型別:String 字串
var sa = api.require('sensorsAnalyticsAPICloudSDK');
var distinctId = sa.getDistinctId();