唐伟军

增加公共sdk事件埋点接入文档

1 +# 公共SDK事件埋点接入文档接入文档 #
2 +
3 +## 接入必读
4 + 事件埋点接口分为三部分:埋点接口,事件类型,事件参数集合的key
5 +
6 +### 埋点接口 (PoolSdkHelper)
7 + 、、、java
8 + PoolSdkHelper.trackEvent(上下文, 事件类型, 事件参数集合);
9 + 、、、
10 +
11 +### 事件类型 (PoolEventType)
12 +
13 +| 事件类型名称 | 描述 | 需要传的事件参数(PoolEventParameterName) |
14 +|-----------------------|---------------------|-------------------------|
15 +| POOL_RES_START | 开始加载资源 | 无 |
16 +| POOL_RES_LOADED | 资源加载完毕 | 无 |
17 +| POOL_REGISTER | 注册 | POOL_REGISTRATION_METHOD |
18 +| POOL_ENTER_GAME | 进入游戏 | 无 |
19 +| POOL_TUTORIAL_COMPLETION | 新手结束 | 无 |
20 +| POOL_FIRST_DAY_CHECKPOINT_TO_VALUE | 副本关卡(创角首日达到的某个关卡 | POOL_CHECKPOINT_ID , POOL_CHECKPOINT_NAME |
21 +| POOL_ENTER_PARTY | 进入公会 | POOL_GROUP_ID |
22 +| POOL_FIRST_DAY_UPDATE_TO_LEVEL1 | 首日更新到某个等级 ||
23 +| POOL_UPDATE_TO_LEVEL | 更新到某个等级 | POOL_ROLE_LEVEL |
24 +| POOL_CREATE_ORDER | 创建订单/点击任意计费点 | POOL_PRICE , POOL_CHECKOUT_PURCHASE_CONTENT_ID |
25 +| POOL_FIRST_RECHARGE | 首冲 | POOL_PRICE , POOL_CHECKOUT_PURCHASE_CONTENT_ID |
26 +| POOL_PAY_SUCCESS | 支付成功 | POOL_PRICE , POOL_CHECKOUT_PURCHASE_CONTENT_ID , POOL_ORDER_ID , POOL_CURRENCY|
27 +| POOL_FIRST_DAY_RECHARGE_TO_VALUE | 首日付费(创角首日达到的某个充值额度) | POOL_TOTAL_PAY_VALUE |
28 +| POOL_BUY_MOUTH_CARD | 购买月卡 | 无 |
29 +| POOL_BIG_RECHARGE | 大额充值 | POOL_PRICE , POOL_CHECKOUT_PURCHASE_CONTENT_ID |
30 +| POOL_FIRST_PURCHASE_FUND | 首次成长基金充值 | 无 |
31 +| POOL_VIP_LEVEL_TO_TARGET_LEVEL | vip达到某个等级 | POOL_VIP_LEVEL |
32 +| POOL_BUY_ANNUAL_CARD | 购买年卡 | 无 |
33 +| POOL_FRIENDS_NUM | 知己数量 | POOL_FRIENDS_VALUE |
34 +| POOL_ATTENDANT | 妖精的数量 | POOL_ATTENDANT_VALUE |
35 +| POOL_MAIN_MISSION | 已通过的主线任务 | POOL_MAIN_MISSION_NAME |
36 +| POOL_SIGN_IN | 签到(一般是七天签到活动) | POOL_SIGN_IN_DAY |
37 +
38 +
39 +### 事件参数集合的key (PoolEventParameterName)
40 +
41 +| 事件类型名称 | 描述 |
42 +|-----------------------|---------------------|
43 +| POOL_ORDER_ID | 订单号 |
44 +| POOL_PRICE | 价格 |
45 +| POOL_CURRENCY | 货币类型 USD:美元 CNY:人民币 |
46 +| POOL_FRIENDS_VALUE | 知己数量值 |
47 +| POOL_ATTENDANT_VALUE | 妖精数量 |
48 +| POOL_VIP_LEVEL | vip等级 |
49 +| POOL_ROLE_LEVEL | 角色等级 |
50 +| POOL_ROLE_STATE | 角色等级对应的称号,境界 |
51 +| POOL_MAIN_MISSION_NAME | 已通过的主线任务名称 |
52 +| POOL_SIGN_IN_DAY | 签到(一般是指七天签到活动中的第几天签到,传数字) |
53 +| POOL_REGISTRATION_METHOD | 注册方式 |
54 +| POOL_CHECKPOINT_ID | 关卡id |
55 +| POOL_CHECKPOINT_NAME | 关卡名 |
56 +| POOL_GROUP_ID | 加入群组时 |
57 +| POOL_CHECKOUT_PURCHASE_CONTENT_ID | 物品ID |
58 +| POOL_TOTAL_PAY_VALUE | 总额度 |
59 +
60 +#### 接入实例
61 +
62 +1.接入资源加载完毕的埋点
63 + 类型: POOL_RES_LOADED
64 + 需要传的参数集合: 无
65 + '''java
66 + PoolSdkHelper.trackEvent(上下文, PoolEventType.POOL_RES_LOADED,null);
67 + '''
68 +
69 +2.接入支付成功时的埋点
70 + 类型:POOL_PAY_SUCCESS
71 + 需要传的参数集合:POOL_PRICE , POOL_CHECKOUT_PURCHASE_CONTENT_ID
72 + '''java
73 + Map<String,Object> valueMap = new HashMap<>();
74 + valueMap.put(PoolEventParameterName.POOL_ORDER_ID,System.currentTimeMillis()+"");//订单号
75 + valueMap.put(PoolEventParameterName.POOL_CURRENCY,"USD");//货币类型 USD:美元 CNY:人民币
76 + valueMap.put(PoolEventParameterName.POOL_PRICE,6);//充值金额
77 + valueMap.put(PoolEventParameterName.POOL_CHECKOUT_PURCHASE_CONTENT_ID,"fdfdf");//物品id
78 + PoolSdkHelper.trackEvent(getApplicationContext(),PoolEventType.POOL_PAY_SUCCESS,valueMap);
79 + '''