小川 / SdkGitbook

Download as
Browse Code »

Commit 8ca54279028d48797a26f9d2a55b00982f811c9c

Authored by 小川 费
1 parent e5e0d59b
Exists in master

新文档

Showing 5 changed files with 494 additions and 34 deletions   Show diff stats
1 # Summary 1 # Summary
2 ## SDK入门 2 ## SDK入门
3 -* [SDK简介](README.md)  
4 -* [SDK下载](download.md)  
5 -* [安装步骤](install.md) 3 +* [SDK简介✔️](intro.md)
  4 +* [SDK下载✔️](download.md)
  5 +* [安装步骤️️️️✔️](install.md)
6 6
7 ## SDK手册 7 ## SDK手册
8 -* [SDK模块功能](modules.md) 8 +* [模块概览](modules.md)
9 9
10 * [统计模块](stat.md) 10 * [统计模块](stat.md)
11 - * [启动注册打点](stat_active.md)  
12 - * [关卡分析打点](stat_level.md)  
13 - * [自定义事件打点](stat_event.md)  
14 - * [交叉推广位](stat_ads.md)  
15 \ No newline at end of file 11 \ No newline at end of file
  12 + * [启动注册打点️✔️](stat_active.md)
  13 + * [关卡分析打点️️✔️](stat_level.md)
  14 + * [自定义事件打点✔️](stat_event.md)
  15 + * [交叉推广位✔️](stat_ads.md)
  16 +* [分享视频模块](share.md)
  17 +* [在线配置模块](online.md)
  18 +* [多平台接口模块](platform.md)
  19 + * [支付打点](platform_pay.md)
  20 + * [授权按钮](platform_common.md#userbtn)
  21 + * [检测自动更新](platform_common.md#autoupdate)
  22 + * [打开客服消息](platform_common.md#service)
  23 + * [震动接口](platform_common.md#vibrate)
  24 + * [其他接口](platform_common.md#other)
  25 +* [数据模块](data.md)
  26 +* [事件模块](event.md)
  27 +* [FAQ](faq.md)
16 \ No newline at end of file 28 \ No newline at end of file
@@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@
12 12
13 **新增：** 13 **新增：**
14 14
15 -1. config.js配置ShareData新增share_wxad_id参数:视频广告uid，配置此参数，拉取不到对应的shareKey，推送看视频，不配置或者配置的uid无效则推送分享 15 +1. config.js配置ShareData新增share_wxad_id参数：视频广告uid，配置此参数，推送看视频，不配置或者配置的uid无效则推送分享
16 16
17 17
18 18
intro.md 0 → 100644
  Diff comments   View file @8ca5427
@@ -0,0 +1,59 @@ @@ -0,0 +1,59 @@
  1 +# 噗嗤SDK
  2 +PCSDK（噗嗤SDK）是一款封装了微信小游戏、QQ小游戏平台常用api接口和用户行为数据上报的一款产品。
  3 +PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，后台对数据进行统计分析后多样化的展示数据统计。
  4 +
  5 +**PCSDK提供的模块功能：**
  6 +
  7 +- 统计模块
  8 +- 数据模块
  9 +- 分享视频模块
  10 +- 在线参数模块
  11 +- 跨平台功能模块
  12 +
  13 +
  14 +
  15 +# 噗嗤管理后台
  16 +噗嗤管理后台统计sdk中上报的各项数据进行分析；管理各种sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、噗嗤游戏导出广告配置、用户事件行为配置。
  17 +
  18 +为了开发联调测试阶段不影响游戏已上线运营相关数据或者配置信息，特意对管理后台做了测试和线上服划分，噗嗤管理后台分为：测试服后台，正式服后台：
  19 +
  20 +噗嗤管理后台后台地址：
  21 +
  22 +- 正式服后台，地址：https://data.d3games.com/#/login
  23 +
  24 +- 测试服后台，地址：http://pre-data.d3games.com/#/login
  25 +
  26 +**友情提示：**
  27 +
  28 +- **之后文案中后台指的是噗嗤管理后台，而不是微信小程序/小游戏后台。**
  29 +- **后台登录账号获取，需提供手机信息给我方运营，运营创建后台登录账号、密码后反馈；登录后台即可使用后台提供的各项服务**
  30 +
  31 +
  32 +
  33 +**噗嗤后台概览：**
  34 +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png)
  35 +
  36 +
  37 +
  38 +**后台提供数据分析功能：**
  39 +
  40 +- 注册/活跃用户，在线时长实时数据分享。
  41 +- 分享数据分析
  42 +- 用户事件行为分析
  43 +- 渠道数据统计分析
  44 +
  45 +
  46 +
  47 +**后台提供配置相关功能：**
  48 +
  49 +- 分享视频配置
  50 +- 动态配置参数
  51 +
  52 +
  53 +
  54 +# 更多：
  55 +- 快速接入，请详读 [安装步骤](install.md)
  56 +
  57 +
  58 +
  59 +- 遇到问题可以查看 [FAQ](faq.md)
0 \ No newline at end of file 60 \ No newline at end of file
platform.md 0 → 100644
  Diff comments   View file @8ca5427
@@ -0,0 +1,174 @@ @@ -0,0 +1,174 @@
  1 +# 启动注册打点
  2 +
  3 +------
  4 +
  5 +#### **简介**
  6 +
  7 +启动注册打点上报用户注册活跃数据，噗嗤管理后台为游戏提供用户数据统计：实时获取活跃、新增用户数、打开次数、在线时长......；注册转化统计。
  8 +
  9 +
  10 +
  11 +#### **后台使用**
  12 +
  13 +完成启动注册打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息：
  14 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png)
  15 +
  16 +点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息：
  17 +
  18 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png)
  19 +
  20 +
  21 +
  22 +
  23 +
  24 +#### **接入API：**
  25 +
  26 +| **名称** | **功能说明** |
  27 +| ------------------------ | ------------------------------------------------------------ |
  28 +| PCSDK.stat.loadingFinish | 加载游戏资源完成时打点，不是微信代码包白屏加载完成，游戏loading自身cdn资源加载完成调用 |
  29 +| PCSDK.stat.setLogind | 设置sdk必须要使用的用户id、第一次创建角色的注册时间，游戏接入方登录游戏服务器后调用 |
  30 +| PCSDK.stat.active | 用户活跃/新增注册上报，切记在setLogind设置需要的信息过后使用（不限于使用位置），不然会导致新增注册数据统计异常 |
  31 +
  32 +
  33 +
  34 +
  35 +
  36 +
  37 +
  38 +1. **loadingFinish**
  39 +
  40 + ```javascript
  41 + PCSDK.stat.loadingFinish(): void
  42 + ```
  43 +
  44 + 定义：加载游戏加载资源完成时打点
  45 +
  46 + 参数：
  47 +
  48 + ```
  49 + 无
  50 + ```
  51 +
  52 + 示例：加载完成游戏主界面图片、json资源打点
  53 +
  54 + ```javascript
  55 + private async initEnv() {
  56 + await SDKTools.env(Const.VERSION);
  57 + this.loadRes();
  58 + this.loadLogin();
  59 + }
  60 +
  61 + // 开始加载资源
  62 + private loadRes() {
  63 + LoaderManager.I.setCallback(this.onLoadedMain, this.onProgressMain, null, this).loadMain();
  64 + }
  65 +
  66 + // 资源加载完成
  67 + private onLoadedMain() {
  68 + PCSDK.stat.loadingFinish()
  69 + }
  70 +
  71 + // 更新资源加载进度条
  72 + private onProgressMain(ret) {
  73 + let progress = ret.data;
  74 + this.skin.txtProgress.text = Math.floor(progress * 100) + '%';
  75 + }
  76 + ```
  77 +
  78 +2. **setLogind**
  79 +
  80 + ```javascript
  81 + PCSDK.stat.setLogind( data: object ): void
  82 + ```
  83 +
  84 + 定义：游戏登录完成，得到登录用户的用户id和用户第一次注册时间，设置SDK必需的用户信息
  85 +
  86 + 参数：
  87 +
  88 + ```javascript
  89 + data: object
  90 +{
  91 + userId: string | number 必传, 用户唯一标识id
  92 + regTime: number 必传，用户第一次创建角色的注册时间戳
  93 + }
  94 + ```
  95 +
  96 + 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟使用环境）
  97 +
  98 + ```javascript
  99 + // 发起登录请求，得到登录数据信息，调用setLogind设置SDK用户信息
  100 + Api.login().then( data => {
  101 + let { user_id, user_reg_time } = data;
  102 + PCSDK.stat.setLogind({
  103 + userId: data.user_id,
  104 + regTime: data.user_reg_time
  105 + });
  106 + });
  107 + ```
  108 +
  109 +3. **active**
  110 +
  111 + ```javascript
  112 + PCSDK.stat.active(): void
  113 + ```
  114 +
  115 + 定义：用户活跃/新增注册上报，切记在使用setLogind设置用户信息过后调用此接口，不然会导致新增注册数据统计异常
  116 +
  117 + 参数：
  118 +
  119 + ```javascript
  120 + 无
  121 + ```
  122 +
  123 + 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟该接口使用环境）
  124 +
  125 + ```javascript
  126 + // 使用场景1：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息后立即调用active
  127 + Api.login().then( data => {
  128 + let { user_id, user_reg_time } = data;
  129 + // 设置用户信息
  130 + PCSDK.stat.setLogind({
  131 + userId: data.user_id,
  132 + regTime: data.user_reg_time
  133 + });
  134 + // 用户活跃注册打点
  135 + PCSDK.stat.active();
  136 + });
  137 +
  138 + // 使用场景2：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息。在其他界面调用active
  139 + // 资源加载loading界面
  140 + class LoadingScene(){
  141 + constructor(){
  142 + this.login();
  143 + }
  144 +
  145 + private login(){
  146 + // 登录
  147 + Api.login().then( data => {
  148 + let { user_id, user_reg_time } = data;
  149 + // 设置用户信息
  150 + PCSDK.stat.setLogind({
  151 + userId: data.user_id,
  152 + regTime: data.user_reg_time
  153 + });
  154 + // 进入home主页场景
  155 + SceneManager.I.switchScene(HomeScene);
  156 + });
  157 + }
  158 + }
  159 +
  160 + // Home页面
  161 + class HomeScene(){
  162 + constructor(){
  163 + this.btnStarGame.on('click', this.onGame, this);
  164 + }
  165 +
  166 + private onGame(){
  167 + // 用户活跃注册打点
  168 + PCSDK.stat.active();
  169 + // 进入游戏页面
  170 + SceneManager.I.switchScene(GameScene);
  171 + }
  172 + }
  173 +
  174 + ```
0 \ No newline at end of file 175 \ No newline at end of file
@@ -18,50 +18,265 @@ @@ -18,50 +18,265 @@
18 18
19 | **名称** | **功能说明** | 19 | **名称** | **功能说明** |
20 | ---------------- | ------------------------------------------------------------ | 20 | ---------------- | ------------------------------------------------------------ |
21 -| PCSDK.stat.event | 自定义事件打点，使用前请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件key | 21 +| PCSDK.stat.logLevelRelive | 游戏关卡复活上报 |
  22 +| PCSDK.stat.logLevelHide | 游戏关卡onHide上报，在游戏界面注册wx.onHide事件，判断不属于复活、失败、成功状态下上报此数据 |
  23 +| PCSDK.stat.logLevelFail | 游戏关卡失败上报 |
  24 +| PCSDK.stat.logLevelWin | 游戏关卡成功上报 |
  25 +| PCSDK.stat.logMerge | 游戏二合一合成最高等级上报 |
22 26
23 27
24 28
25 -1. **event** 29 +1. #### **logLevelRelive**
26 30
27 ```javascript 31 ```javascript
28 - PCSDK.stat.event(event_key: string , event_source: string , opts?: { ext_val?: string | number} ): Promise<any> 32 + PCSDK.stat.logLevelRelive(levelId: string | number , opts?: { attr: number } ): void
29 ``` 33 ```
30 34
31 - 定义：自定义事件打点，可在游戏任何位置定义事件打点 35 + 定义：关卡复活成功数据上报
32 36
33 参数： 37 参数：
34 38
35 ``` 39 ```
36 - event_key: string 必传，后台配置的事件key 40 + levelId: string | number 必传，游戏关卡id
37 41
38 - event_source: string 必传，触发该事件所在页面位置，例如：结算页面、排行榜界面、签到页面。。。 42 + opts: object 选传，扩展参数，目前只支持传递一个属性: attr
  43 + {
  44 + attr: number 战斗属性（例如:关卡战斗中所使用的枪支等级）
  45 + }
  46 + ```
  47 +
  48 + [点此查看完整示例](stat_level.md#sample)如何添加关卡失败打点代码
  49 +
  50 +2. #### **logLevelHide**
  51 +
  52 + ```javascript
  53 + PCSDK.stat.logLevelHide(levelId: string | number , opts?: { attr: number } ): void
  54 + ```
  55 +
  56 + > 定义：游戏中onHide时（监听wx.onHide事件）关卡退出数据上报。
  57 + > 需要屏蔽掉复活、失败、成功状态下onHide
  58 +
  59 + 参数：
  60 +
  61 + ```
  62 + levelId: string | number 必传，游戏关卡id
39 63
40 - opts?: object 选传，自定义扩展参数，一些特定的事件想传递更多信息，此参数使用请咨询相关对接人员目前只支持对象一个key（evt_val），多个扩展参数使用'|'连接 64 + opts: object 选传，扩展参数，目前只支持传递一个属性: attr
41 { 65 {
42 - ext_val: '100|1000' 66 + attr: number 战斗属性（例如:关卡战斗中所使用的枪支等级）
43 } 67 }
44 ``` 68 ```
45 - 示例： 69 +
  70 + [点此查看完整示例](stat_level.md#sample)如何添加关卡失败打点代码
  71 +
  72 +3. #### **logLevelFail**
46 73
47 ```javascript 74 ```javascript
48 - // 签到功能  
49 - private onSign() {  
50 - PCSDK.stat.event(EventKeys.FunctionSign, '主界面');  
51 - } 75 + PCSDK.stat.logLevelFail(levelId: string | number , opts: { ctime: number, first: number, attr?: number } ): void
  76 + ```
  77 +
  78 + 定义：关卡失败数据上报
  79 +
  80 + 参数：
  81 +
  82 + ```
  83 + levelId: string | number 必传，游戏关卡id
52 84
53 - // 开始加载资源  
54 - private loadRes() {  
55 - PCSDK.stat.event(EventKeys.LoadingExhibition, '加载界面');  
56 - LoaderManager.I.setCallback(this.onLoadedMain, this.onProgressMain, null, this).loadMain();  
57 - } 85 + opts: object 必传，扩展参数，目前只支持传递一个属性: attr
  86 + {
  87 + ctime: number 必传 关卡耗时 = 当前时间-关卡进入时间，单位秒
  88 + first: number 必传 是否第一次体验关卡，1是，0否
  89 + attr: number 选传 战斗属性（例如:关卡战斗中所使用的枪支等级）
  90 + }
  91 + ```
  92 + [点此查看完整示例](stat_level.md#sample)如何添加关卡失败打点代码
  93 +
  94 +4. #### **logLevelWin**
  95 +
  96 + ```javascript
  97 + PCSDK.stat.logLevelWin(levelId: string | number , opts: { ctime: number, first: number, attr?: number } ): void
  98 + ```
  99 +
  100 + 定义：关卡成功通关数据上报
  101 +
  102 + 参数：
  103 +
  104 + ```
  105 + levelId: string | number 必传，游戏关卡id
58 106
59 - // 升级领奖  
60 - private onReward(e: Laya.Event) {  
61 - PCSDK.stat.event(EventKeys.LvUpRewards, '升级界面');  
62 - SDKTools.shareDispatch(ShareKey.LevelUpDiamond, {  
63 - success: this.handleDoubleReward,  
64 - context: this  
65 - }); 107 + opts: object 必传，扩展参数
  108 + {
  109 + ctime: number 必传 关卡耗时 = 当前时间-关卡进入时间，单位秒
  110 + first: number 必传 是否第一次体验关卡，1是，0否
  111 + attr: number 选传 战斗属性（例如:关卡战斗中所使用的枪支等级）
  112 + }
  113 + ```
  114 + <div id="sample"></div> 完整示例，以上四个接口使用场景：
  115 +> 监听游戏wx.onHide关卡数据上报后上报（需要屏蔽掉复活、失败、成功状态），在执行wx.onHide时候，SDK会发出名为'app.hide'的自定义事件，可使用PCSDK.event.bindEvent监听该事件，使用PCSDK.event.removeEvent移除对应监听事件，[详细文档event模块文档请阅读event事件模块](evennt.md)。
  116 +
  117 + ```javascript
  118 + /**
  119 + * 游戏界面
  120 + **/
  121 + exports class GameScene extends BaseView{
  122 + // 关卡id
  123 + private missionId: number;
  124 + // 当前选中使用的枪支等级
  125 + private currSelectGun: number;
  126 + // 游戏状态机
  127 + private gameState: GameState;
  128 + // 关卡开始时间
  129 + private enterTime: number;
  130 +
  131 + constructor(){
  132 + this.gameState = GameState.Idle;
  133 + }
  134 +
  135 + // 游戏界面打开
  136 + open(){
  137 + super.open();
  138 + this.gameState = GameState.Idle;
  139 + this.enterTime = new Date().getTime();
  140 + this.addEvent();
  141 + }
  142 +
  143 + // 游戏界面关闭
  144 + close(){
  145 + super.close();
  146 + this.removeEvent();
  147 + }
  148 +
  149 + // 添加游戏事件监听
  150 + private addEvent(){
  151 + // 监听SDK中app.hide事件事件消息
  152 + PCSDK.event.bindEvent( 'app.hide', this.handleHide, this);
  153 + // 监听游戏中level.relive事件消息
  154 + EventCenter.I.add('level.relive', this, this.handleLevelRelive);
  155 + }
  156 +
  157 + // 移除游戏事件监听
  158 + private removeEvent(){
  159 + PCSDK.event.removeEvent( 'app.hide', this.handleHide, this);
  160 + EventCenter.I.remove('level.relive', this, this.handleLevelRelive);
  161 + }
  162 +
  163 + // 游戏复活
  164 + private doGameRelive(){
  165 + this.setState(GameState.Relive);
  166 + }
  167 +
  168 + // 游戏通关失败
  169 + private doGameFail(){
  170 + this.setState(GameState.Fail);
  171 + }
  172 +
  173 + // 游戏通关成功
  174 + private doGameWin(){
  175 + this.setState(GameState.Win);
  176 + }
  177 +
  178 + // SDK发出的app.hide事件监听
  179 + private handleHide() {
  180 + // 关卡onHide上报（成功、失败、复活不进行logLevelHide上报）
  181 + if(!(this.isState(GameState.Win) || this.isState(GameState.Fail) || this.isState(GameState.Relive)))
  182 + PCSDK.stat.logLevelHide(this.missionId, {
  183 + attr: this.currSelectGun
  184 + });
  185 + }
  186 +
  187 + // 监听关卡复活消息
  188 + private handleLevelRelive(){
  189 + // 关卡复活成功上报
  190 + PCSDK.stat.logLevelRelive(this.missionId, {
  191 + attr: this.currSelectGun
  192 + });
  193 + }
  194 +
  195 + private isState(state: GameState) {
  196 + return this.state === state;
  197 + }
  198 +
  199 + // 设置状态机
  200 + private setState(state: GameState) {
  201 + if (this.isState(state)) return;
  202 +
  203 + this.state = state;
  204 + let costTime: number; // 关卡消耗时间
  205 + let failNum: number; // 关卡失败次数
  206 + switch (state) {
  207 + case GameState.Win: // 处理成功
  208 + // 关卡成功上报
  209 + costTime = new Date().getTime() - this.enterTime;
  210 + failNum = DataManager.I.LocalModel.getMissionFailNum(this.missionId);
  211 + PCSDK.stat.logLevelWin(this.missionId, {
  212 + ctime: costTime,
  213 + first: failNum ? 0 : 1,
  214 + attr: this.currSelectGun
  215 + });
  216 + break;
  217 +
  218 + case GameState.Fail: // 处理失败
  219 + // 关卡失败上报
  220 + costTime = new Date().getTime() - this.enterTime;
  221 + failNum = DataManager.I.LocalModel.getMissionFailNum(this.missionId);
  222 + PCSDK.stat.logLevelFail(this.missionId, {
  223 + ctime: costTime,
  224 + first: failNum ? 0 : 1,
  225 + attr: this.currSelectGun
  226 + });
  227 + break;
  228 +
  229 + case GameState.Relive:// 处理复活
  230 + // 弹出复活操作界面
  231 + PopWinManager.I.openPopwin(RelivePopwinn);
  232 + break;
  233 + }
  234 + }
  235 + }
  236 +
  237 + /**
  238 + * 复活界面
  239 + **/
  240 + exports class RelivePopwinn extends BaseView{
  241 + // 复活界面关闭
  242 + close(){
  243 + super.close();
  244 + // 关闭模拟复活成功，发送消息
  245 + EventCenter.I.emit('level.relive');
  246 + }
66 } 247 }
  248 +
  249 + // 游戏状态状态机
  250 + enum GameState{
  251 + Idle, // 初始状态
  252 + Fail, // 失败状态
  253 + Win, // 成功通关状态
  254 + Relive // 正在复活状态
  255 + }
  256 + ```
  257 +
  258 +5. #### **logMerge**
  259 +
  260 + ```javascript
  261 + PCSDK.stat.logMerge(mergeLv: number): void
67 ``` 262 ```
  263 +
  264 + 定义：游戏二合一合成最高等级上报
  265 +
  266 + 参数：
  267 +
  268 + ```
  269 + mergeLv: number 必传，二合一合成最高等级
  270 + ```
  271 +
  272 + 示例：二合一部分，合成最高等级时候上报
  273 +
  274 + ```javascript
  275 + // 合成最新等级合成
  276 + private handleMergeLastestLv(lastestLv: number){
  277 + // 合成最新等级上报
  278 + PCSDK.stat.logMerge( lastestLv );
  279 + }
  280 + ```
  281 +
  282 +
68 \ No newline at end of file 283 \ No newline at end of file