基礎(chǔ)功能
1 SDK原理概述
1.1 原理
SDK 提供一種指令形態(tài)的埋點調(diào)用方式,您通過對 aplus 環(huán)境變量的指令隊列 aplus_queue發(fā)送指令,由 aplus 環(huán)境變量來執(zhí)行指令,進而完成您的需求,指令格式如下:
aplus_queue.push({
'action': "$APIName",
'arguments': [$arguments] //arguments 為指定 API 的入?yún)ⅲ?})
action 參數(shù)代表發(fā)送指令的 API 名稱,其入?yún)橐粋€字符串,取值為枚舉值,可用的枚舉值如下
setMetaInfo:覆蓋SDK的已有默認設(shè)置
appendMetaInfo: 追加SDK的默認配置
getMetaInfo:獲取 SDK 的當前配置
record:用于發(fā)送事件日志
sendPV:用于發(fā)送頁面日志
arguments 參數(shù)為 action 中指定 API 的入?yún)ⅲ袷绞且粋€數(shù)組,數(shù)組內(nèi)的元素順序與 API 定義的入?yún)㈨樞蛞恢?/p>
1.2 示例
//變更 SDK 的默認設(shè)置
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: [metaName, metaValue]
});
//獲取 SDK 的當前配置
aplus.getMetaInfo(metaName);
//用于發(fā)送事件日志
aplus_queue.push({
action: 'aplus.record',
arguments: [trackerEventCode, eventType, eventParams]
});
//用于發(fā)送頁面日志
aplus_queue.push({
action: 'aplus.sendPV',
arguments: [pageEventConfig, userData]
});
2 日志打印
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['DEBUG', true]
});
3 日志發(fā)送策略
事件觸發(fā)時就會上報,為準實時上報
4 應(yīng)用基礎(chǔ)信息配置
在SDK引入部分,可以修改或者追加一些默認設(shè)置
//集成應(yīng)用的appKey
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['appKey', 'xxxxxxx']
})
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['aplus-rhost-v', 'quickaplus-Web-api.xxx.com.cn']
});
//開啟調(diào)試模式
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['DEBUG', true]
});
MetaName | 元配置說明 | metaValue賦值說明 | 支持版本 |
DEBUG | 開啟后,控制臺將輸出SDK 埋點日志 | true為打開日志,false為關(guān)閉日志 | all |
appVersion | 設(shè)置當前Web的版本 | 請?zhí)顚懏斍癢eb的版本 | all |
appKey | 平臺系統(tǒng)中創(chuàng)建應(yīng)用時填寫的Appkey | 需要在平臺中獲取埋點Web應(yīng)用對應(yīng)的appkey | all |
aplus-rhost-v | 采集上報域名(Deprecated) | 在平臺的采集信息中可以獲取 | all |
trackDomain | 采集上報域名 | 在平臺的采集信息中可以獲取 | v2.0.0開始 |
_dev_id | 自定義設(shè)備ID | 該方式將覆蓋掉QuickTracking SDK自動生成的設(shè)備ID | all |
_user_id | 設(shè)置userid | 業(yè)務(wù)自定義的登錄賬號ID | all |
_hold | 發(fā)送Hold信號. 在 SDK整個生命周期內(nèi), _hold可設(shè)置多次,但BLOCK與START需成對出現(xiàn),否則會影響日志發(fā)送 | 枚舉類型, 可用值及說明如下:
| all 注:僅對使用 aplus_queue.push 方式的API調(diào)用生效 |
aplus-jsbridge-only | H5上報日志開關(guān) |
| all |
aplus-utm-expire-days | 設(shè)置utm參數(shù)過期時間 | 默認為當前會話期有效,支持按天為單位自定義utm參數(shù)過期時間,結(jié)果保存在cookie中,最大時間設(shè)置以各瀏覽器支持的cookie實際最大過期時間說明為準 | v2.0.7開始 |
aplus-preset-events-disabled | 用于關(guān)閉SDK默認采集的預(yù)制事件 | 默認值為undefined, 支持以數(shù)組類型來賦值,示例:
| v2.0.9 開始 |