小川 / SdkGitbook

Download as
Browse Code »

Commit e5e0d59bd4b8219452e939932721eccde59ae530

Authored by 小川 费
1 parent 6ef85167
Exists in master

添加新文档

Showing 8 changed files with 894 additions and 141 deletions   Show diff stats
@@ -7,7 +7,8 @@ @@ -7,7 +7,8 @@
7 ## SDK手册 7 ## SDK手册
8 * [SDK模块功能](modules.md) 8 * [SDK模块功能](modules.md)
9 9
10 -* [统计模块](stat_active.md) 10 +* [统计模块](stat.md)
11 * [启动注册打点](stat_active.md) 11 * [启动注册打点](stat_active.md)
12 - * [交叉推广位](stat_ads.md)  
13 - * [Gitbook命令行速览](installation/gitbook-cli.md)  
14 \ No newline at end of file 12 \ No newline at end of file
  13 + * [关卡分析打点](stat_level.md)
  14 + * [自定义事件打点](stat_event.md)
  15 + * [交叉推广位](stat_ads.md)
15 \ No newline at end of file 16 \ No newline at end of file
@@ -6,6 +6,10 @@ @@ -6,6 +6,10 @@
6 6
7 > *发布时间*：2019.09.04 7 > *发布时间*：2019.09.04
8 8
  9 +**修复：**
  10 +
  11 +1. 修复外部游戏stat launch api调用时序问题导致参数传递异常
  12 +
9 **新增：** 13 **新增：**
10 14
11 1. config.js配置ShareData新增share_wxad_id参数:视频广告uid，配置此参数，拉取不到对应的shareKey，推送看视频，不配置或者配置的uid无效则推送分享 15 1. config.js配置ShareData新增share_wxad_id参数:视频广告uid，配置此参数，拉取不到对应的shareKey，推送看视频，不配置或者配置的uid无效则推送分享
@@ -95,33 +95,34 @@ @@ -95,33 +95,34 @@
95 }; 95 };
96 ``` 96 ```
97 97
98 -  
99 - 参数详解：  
100 -  
101 - 1. **Env ( number )：**SDK统计执行环境，建议开发者调试测试阶段设置为110，提审阶段一定要设置为100。  
102 -  
103 - 100：正式环境，请求api域名地址为：https://dataapi.d3games.com  
104 -  
105 - 110：测试环境，请求api域名地址为：https://pre-dataapi.d3games.com  
106 -  
107 - 2. **IsDebug ( boolean )：**是否debug模式，debug模式会打印sdk中的console.log/error/warn log。  
108 -  
109 - false：关闭log打印，提审前建议设置为false，不打印log信息  
110 -  
111 - true：开启log打印，如遇到联调问题，可设置为true，查看log发给相关人员进行查看解决问题  
112 -  
113 - 此设置可在代码中通过动态设置：PCSDK.stat.setDebug( boolean )进行动态切换控制  
114 -  
115 - 3. **AdCacheDuration（number）：**表示获取广告位列表的缓存时间，例如30秒，sdk会对广告列表拉取后缓存30秒。此参数对接入噗嗤广告导出功能后有效，没有接入可不修改，使用默认值。  
116 -  
117 - 4. **IsUseShareModule( boolean )：**是否启用sdk分享视频功能（sdk把分享和视频封装为share模块，可以通过噗嗤后台配置分享还是视频类型进行分发控制）  
118 -  
119 - false：SDK启动不拉取分享列表，也就是不适用噗嗤游戏的分享模块功能  
120 -  
121 - true：SDK启动拉取噗嗤管理后台配置的分享视频列表，运营或者开发者在噗嗤后台配置分享视频的配置后，开发者可以通过PCSDK.share.shareDispatch( sharekey , ...)进行视频分享分发操作，具体操作请详看SDK分享视频模块。  
122 -  
123 - 5. **IsOnlineAutoUse( boolean )：**是否启用SDK启动获取噗嗤游戏后台配置的在线配置参数列表  
124 - 98 +参数详解：
  99 +
  100 +<div id="config_env"></div>
  101 +
  102 +1. **Env ( number )：**SDK统计执行环境，建议开发者调试测试阶段设置为110，提审阶段一定要设置为100。
  103 +
  104 + 100：正式环境，请求api域名地址为：https://dataapi.d3games.com
  105 +
  106 + 110：测试环境，请求api域名地址为：https://pre-dataapi.d3games.com
  107 +
  108 +2. **IsDebug ( boolean )：**是否debug模式，debug模式会打印sdk中的console.log/error/warn log。
  109 +
  110 + false：关闭log打印，提审前建议设置为false，不打印log信息
  111 +
  112 + true：开启log打印，如遇到联调问题，可设置为true，查看log发给相关人员进行查看解决问题
  113 +
  114 + 此设置可在代码中通过动态设置：PCSDK.stat.setDebug( boolean )进行动态切换控制
  115 +
  116 +3. **AdCacheDuration（number）：**表示获取广告位列表的缓存时间，例如30秒，sdk会对广告列表拉取后缓存30秒。此参数对接入噗嗤广告导出功能后有效，没有接入可不修改，使用默认值。
  117 +
  118 +4. **IsUseShareModule( boolean )：**是否启用sdk分享视频功能（sdk把分享和视频封装为share模块，可以通过噗嗤后台配置分享还是视频类型进行分发控制）
  119 +
  120 + false：SDK启动不拉取分享列表，也就是不适用噗嗤游戏的分享模块功能
  121 +
  122 + true：SDK启动拉取噗嗤管理后台配置的分享视频列表，运营或者开发者在噗嗤后台配置分享视频的配置后，开发者可以通过PCSDK.share.shareDispatch( sharekey , ...)进行视频分享分发操作，具体操作请详看SDK分享视频模块。
  123 +
  124 +5. **IsOnlineAutoUse( boolean )：**是否启用SDK启动获取噗嗤游戏后台配置的在线配置参数列表
  125 +
125 false：两种处理 1）不启用噗嗤后台在线配置参数功能; 2）使用在线配置参数功能，但是启动不拉取后台在线配置参数列表，代码中调用api拉取在线参数 126 false：两种处理 1）不启用噗嗤后台在线配置参数功能; 2）使用在线配置参数功能，但是启动不拉取后台在线配置参数列表，代码中调用api拉取在线参数
126 127
127 示例：代码中控制拉取在线参数，例如噗嗤后台【游戏数据】=>【配置参数】栏配置了：是否显示微信插屏广告、噗嗤游戏广告导出动态开关 128 示例：代码中控制拉取在线参数，例如噗嗤后台【游戏数据】=>【配置参数】栏配置了：是否显示微信插屏广告、噗嗤游戏广告导出动态开关
@@ -165,8 +166,8 @@ @@ -165,8 +166,8 @@
165 166
166 示例：可以从噗嗤管理后台【游戏数据】=>【分享/视频配置】中选取一条：复制文案，点击分享素材icon->查看大图->右键查看分享图片的html源码复制src图片地址：**{** 167 示例：可以从噗嗤管理后台【游戏数据】=>【分享/视频配置】中选取一条：复制文案，点击分享素材icon->查看大图->右键查看分享图片的html源码复制src图片地址：**{**
167 168
168 - ​ **share_desc: ' 半夜传来啪啪啪！竟是隔壁老王偷偷打气球',**  
169 - 169 + ​ **share_desc: ' 半夜传来啪啪啪！竟是隔壁老王偷偷打气球',**
  170 +
170 ​ **share_wxad_id: 'adunit-6958dcfc3f0bed31',** 171 ​ **share_wxad_id: 'adunit-6958dcfc3f0bed31',**
171 172
172 ​ **share_icon: 'https://dep.miso-lab.com/data_analysis/games/res/5D57D4A3Yx.png'** 173 ​ **share_icon: 'https://dep.miso-lab.com/data_analysis/games/res/5D57D4A3Yx.png'**
stat.md 0 → 100644
  Diff comments   View file @e5e0d59
@@ -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
stat_active.md
  Diff comments   View file @e5e0d59
@@ -8,9 +8,9 @@ @@ -8,9 +8,9 @@
8 8
9 9
10 10
11 -#### **查看数据** 11 +#### **后台使用**
12 12
13 -完成启动注册打点后，登录后台->头部切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息： 13 +完成启动注册打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息：
14 ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png) 14 ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png)
15 15
16 点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息： 16 点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息：
@@ -65,7 +65,8 @@ @@ -65,7 +65,8 @@
65 65
66 // 资源加载完成 66 // 资源加载完成
67 private onLoadedMain() { 67 private onLoadedMain() {
68 - PCSDK.stat.loadingFinish() 68 + // 打点：loadingFinish
  69 + PCSDK.stat.loadingFinish();
69 } 70 }
70 71
71 // 更新资源加载进度条 72 // 更新资源加载进度条
@@ -4,34 +4,100 @@ @@ -4,34 +4,100 @@
4 4
5 #### **简介** 5 #### **简介**
6 6
7 -交叉推广位是在游戏中放置其他游戏icon，用户点击跳转到导出的游戏，达到共享用户的目的，噗嗤游戏对开发者提供了不同类型的广告导出。 7 +交叉推广位是在游戏中展示其他游戏icon，用户点击跳转到导出的游戏，达到共享用户的目的。
8 8
9 -噗嗤管理后台可对交叉推广位进行配置管理，对广告导出各项指标进行计算分析。 9 +噗嗤游戏提供了3种类型的广告导出，后台可对交叉推广位进行配置管理，对广告导出各项指标分析阅览。
10 10
  11 +**3种广告类型：交叉悬浮广告框、交叉抽屉式广告位、交叉猜你喜欢广告位**
11 12
  13 +1. 交叉悬浮广告框，放置到首页、结算页
12 14
13 -#### **接入准备** 15 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_013.png)
14 16
15 -由于微信对每个游戏可跳转其他游戏有10个限制，可跳转的游戏需要配置微信开发者工具项目的 17 +2. 交叉抽屉式广告位，放置到首页、结算页
16 18
17 -完成启动注册打点后，登录后台->头部切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息：  
18 -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png) 19 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_014.png)
19 20
20 -点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息： 21 +3. 交叉猜你喜欢广告位，推荐放置到结算页
21 22
22 -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png) 23 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_015.png)
23 24
24 25
25 26
26 27
27 28
  29 +#### **后台使用**
  30 +
  31 +完成接入交叉推广位后，登录后台->头部tab切换到【游戏数据】->【流量分析】->【广告导出】即可查看推广位的各项数据信息（需要后台管理人员添加权限）：
  32 +
  33 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_012.png)
  34 +
  35 +
  36 +
  37 +#### **接入必读**
  38 +
  39 +- 由于微信对每个游戏可跳转其他游戏有10个限制，可跳转的其它游戏需要在小游戏根目录下的全局配置文件game.json中进行添加配置：navigateToMiniProgramAppIdList，该参数定义请详读[小程序全局配置](https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html)。
  40 +
  41 +- 噗嗤游戏为了方便开发者接入调试交叉推广位，【后台测试服】已经配置了不同类型导出广告，并提供以下10个测试服广告位appid：
  42 +
  43 + 水果爆破 ："wx26822126b4d99eda",
  44 +
  45 + 球球涂涂涂："wxac0750884d5bed0c",
  46 +
  47 + 狂野漂移3D："wx019a09df638e6683",
  48 +
  49 + 星星爱消消："wx9ff47d13a88e5511",
  50 +
  51 + 土耳其方块消消乐："wx89efb2282d65a2d0",
  52 +
  53 + 成语小才子："wxd4d478c7d331ce80",
  54 +
  55 + 球球蹦蹦蹦："wxabee9afe62d0b114",
  56 +
  57 + 俄罗斯方块连连消："wx4cd087f19f4cb7c3",
  58 +
  59 + 球球爆爆爆："wxae33d68413f40641",
  60 +
  61 + 疯狂水果一刀切："wxdf26a04c53d6f1e9"
  62 +
  63 + ```javascript
  64 + "navigateToMiniProgramAppIdList": [
  65 + "wx26822126b4d99eda",
  66 + "wxac0750884d5bed0c",
  67 + "wx019a09df638e6683",
  68 + "wx9ff47d13a88e5511",
  69 + "wx89efb2282d65a2d0",
  70 + "wxd4d478c7d331ce80",
  71 + "wxabee9afe62d0b114",
  72 + "wx4cd087f19f4cb7c3",
  73 + "wxae33d68413f40641",
  74 + "wxdf26a04c53d6f1e9"
  75 + ]
  76 + ```
  77 +
  78 +
  79 +
  80 +- 完成下面的操作步骤可调用相应的api读取到广告位数据：
  81 +
  82 + 1、开发者复制上面的10个其他游戏的appid，配置到game.json的navigateToMiniProgramAppIdList参数：
  83 +
  84 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_010.png)
  85 +
  86 + 2、修改[config.js的Env配置](install.md#config_env)为110，对接联调阶段，请走测试服后台，调试环境走测试环境
  87 +
  88 + > 提示：广告位接入完毕测试通过，提交审核前，修改Env为100。
  89 +
  90 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_011.png)
  91 +
  92 +
  93 +
28 #### **接入API：** 94 #### **接入API：**
29 95
30 -| **名称** | **功能说明** |  
31 -| ------------------------ | ------------------------------------------------------------ |  
32 -| PCSDK.stat.loadingFinish | 加载游戏资源完成时打点，不是微信代码包白屏加载完成 |  
33 -| PCSDK.stat.setLogind | 游戏登录成功后，获取用户信息用户userId、第一次创建角色的注册时间regTime，调用此接口设置SDK统计上报需要的用户信息 |  
34 -| PCSDK.stat.active | 用户活跃/新增注册上报，切记在setLogind设置需要的信息过后使用，不然会导致新增注册数据统计异常。setLogind后，此接口不限使用位置。 | 96 +| **名称** | **功能说明** |
  97 +| --------------------------- | ------------------------------------------------------------ |
  98 +| PCSDK.stat.bannerList | 根据类型获取对应类型噗嗤交叉广告列表，目前sdk支持3种类型：40（交叉悬浮广告框）、70（交叉抽屉式广告位）、50（交叉猜你喜欢广告位） |
  99 +| PCSDK.stat.bannerNavigateTo | 交叉推广位点击跳转到对应appid的其他游戏，该接口封装了小游戏的跳转功能（navigateToMiniProgram） |
  100 +| PCSDK.stat.addExposure | 交叉推广位一条或者多条广告展示，添加曝光数据，SDK在onHide时候上报数据到后台 |
35 101
36 102
37 103
@@ -39,141 +105,440 @@ @@ -39,141 +105,440 @@
39 105
40 106
41 107
42 -1. **loadingFinish** 108 +1. ##### **bannerList**
43 109
44 ```javascript 110 ```javascript
45 - PCSDK.stat.loadingFinish(): void 111 + PCSDK.stat.loadingFinish(banner_type): Promise<any>
46 ``` 112 ```
47 113
48 - 定义：加载游戏资源完成（不是微信白屏加载完成）时打点  
49 - 114 + 定义：根据类型获取对应类型噗嗤交叉广告列表，目前sdk支持3种类型；返回Promise类型
  115 +
50 参数： 116 参数：
51 - 117 +
52 ``` 118 ```
53 - 无 119 + banner_type: number 必填 目前支持三种广告类型：40、50、70
54 ``` 120 ```
  121 +
  122 + 返回值：Promise<any>
  123 +
  124 + 返回的是Promise类型，Promise resolve成功回调数据结构为：
  125 +
  126 + ```json
  127 + {
  128 + "banner_list": [
  129 + {
  130 + "banner_id": "3568",
  131 + "banner_name": "土耳其方块",
  132 + "banner_type": "40",
  133 + "banner_location": "100",
  134 + "banner_ad_id": "50",
  135 + "banner_launch_appid": "",
  136 + "banner_launch_path": "",
  137 + "banner_appid": "wx89efb2282d65a2d0",
  138 + "banner_path": "?channel_id=20361",
  139 + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CB97RK.png",
  140 + "banner_user_num": "0",
  141 + "banner_exposure_num": "0",
  142 + "banner_sort": "1",
  143 + "banner_game_id": "1000053",
  144 + "banner_qqgame": "0",
  145 + "banner_qqgame_id": "0",
  146 + "banner_game_type": 0,
  147 + "banner_bone": "0",
  148 + "banner_system": "0",
  149 + "banner_online": "1",
  150 + "banner_reddot": "0",
  151 + "banner_gender": "0",
  152 + "banner_resident": "0",
  153 + "banner_qrcode": "0",
  154 + "banner_qrcode_img": "",
  155 + "banner_bone_info": false,
  156 + "banner_img_info": {
  157 + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CB97RK.png"
  158 + }
  159 + },
  160 + {
  161 + "banner_id": "3571",
  162 + "banner_name": "水果一刀切",
  163 + "banner_type": "40",
  164 + "banner_location": "100",
  165 + "banner_ad_id": "99",
  166 + "banner_launch_appid": "",
  167 + "banner_launch_path": "",
  168 + "banner_appid": "wxdf26a04c53d6f1e9",
  169 + "banner_path": "?channel_id=20361",
  170 + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CBACTt.png",
  171 + "banner_user_num": "0",
  172 + "banner_exposure_num": "0",
  173 + "banner_sort": "1",
  174 + "banner_game_id": "1000053",
  175 + "banner_qqgame": "0",
  176 + "banner_qqgame_id": "0",
  177 + "banner_game_type": 0,
  178 + "banner_bone": "0",
  179 + "banner_system": "0",
  180 + "banner_online": "1",
  181 + "banner_reddot": "0",
  182 + "banner_gender": "0",
  183 + "banner_resident": "0",
  184 + "banner_qrcode": "0",
  185 + "banner_qrcode_img": "",
  186 + "banner_bone_info": false,
  187 + "banner_img_info": {
  188 + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CBACTt.png"
  189 + }
  190 + }
  191 + ]
  192 + }
55 193
56 - 示例：加载完成游戏主界面图片、json资源打点  
57 -  
58 - ```javascript  
59 - private async initEnv() {  
60 - await SDKTools.env(Const.VERSION);  
61 - this.loadRes();  
62 - this.loadLogin();  
63 - } 194 + ```
64 195
65 - // 开始加载资源  
66 - private loadRes() {  
67 - LoaderManager.I.setCallback(this.onLoadedMain, this.onProgressMain, null, this).loadMain();  
68 - } 196 + > **返回的数据banner_list列表解析为 Array< BannerData >，BannerData是banner_list每一项数据实体，下面的bannerNavigateTo与addExposure接口api参数banner_data属于此BannerData结构**。
69 197
70 - // 资源加载完成  
71 - private onLoadedMain() {  
72 - PCSDK.stat.loadingFinish()  
73 - } 198 + 示例：
74 199
75 - // 更新资源加载进度条  
76 - private onProgressMain(ret) {  
77 - let progress = ret.data;  
78 - this.skin.txtProgress.text = Math.floor(progress * 100) + '%'; 200 + ```javascript
  201 + /**
  202 + * 演示交叉推广位使用示例
  203 + */
  204 + export default class TestBannerSample {
  205 + constructor() {
  206 + // 示例：加载交叉悬浮广告框
  207 + this.loadBannerList(BannerType.TYPE_CROSS)
  208 + .then((dataList: Array<BannerData>) => {
  209 + // 渲染广告位数据
  210 + this.renderAdCrossList(dataList);
  211 + }).catch(err => {
  212 + // bannerList不存在获取请求拉取失败
  213 + });
  214 + }
  215 +
  216 + /**
  217 + * 渲染广告位列表
  218 + * @param dataList 广告位列表
  219 + */
  220 + private renderAdCrossList(dataList: Array<BannerData>) {
  221 + // ...
  222 + }
  223 +
  224 + /**
  225 + * 根据类型获取交叉推广位列表
  226 + * @param banner_type 广告位类型
  227 + */
  228 + private loadBannerList(banner_type: BannerType): Promise<any> {
  229 + return new Promise((resolve, reject) => {
  230 + PCSDK.stat.bannerList(banner_type)
  231 + .then(data => {
  232 + let bannerList: Array<BannerData> = data.banner_list || [];
  233 + if (bannerList.length) {
  234 + // 处理bannerList数据列表
  235 + resolve(bannerList);
  236 + } else {
  237 + // 处理数据为空情况
  238 + reject(null);
  239 + }
  240 + }).catch(err => {
  241 + // 请求接口报错情况
  242 + reject(err);
  243 + });
  244 + });
  245 + }
  246 + }
  247 +
  248 + // 广告位类型的枚举
  249 + enum BannerType {
  250 + TYPE_CROSS = 40, // 交叉悬浮广告框
  251 + TYPE_LIKE = 50, // 交叉猜你喜欢广告位
  252 + TYPE_LIST = 70, // 交叉抽屉广告位
  253 + }
  254 +
  255 + /*
  256 + * banner数据实体结构
  257 + */
  258 + class BannerData {
  259 + public banner_id: string;
  260 + public banner_appid: string;
  261 + public banner_diamond: number;
  262 + public banner_type: string;
  263 + public banner_icon: string;
  264 + public banner_name: string;
  265 + public banner_resident: string; // 是否常驻
79 } 266 }
80 ``` 267 ```
81 268
82 -2. **setLogind** 269 +2. ##### **bannerNavigateTo**
83 270
84 ```javascript 271 ```javascript
85 - PCSDK.stat.setLogind( data: object ): void 272 + PCSDK.stat.bannerNavigateTo( location:number, banner_data: any, opts?: { extraData?: string; envVersion?: string }): Promise<any>
86 ``` 273 ```
87 274
88 - 定义：游戏登录完成，得到登录用户的用户id和用户第一次注册时间，设置SDK必需的用户信息 275 + 定义：交叉推广位点击游戏跳转到对应appid的其他游戏，该接口封装了小游戏的跳转功能（navigateToMiniProgram）, 第三个参数配置可参考[wx.navigateToMiniProgram extraData、envVersion配置信息](https://developers.weixin.qq.com/minigame/dev/api/open-api/miniprogram-navigate/wx.navigateToMiniProgram.html)
89 276
90 参数： 277 参数：
91 278
92 ```javascript 279 ```javascript
93 - data: object  
94 -{  
95 - userId: string | number 必传, 用户唯一标识id  
96 - regTime: number 必传，用户第一次创建角色的注册时间戳 280 + location: number 必传，统一传递为：100
  281 +
  282 + banner_data：any 必传，点击跳转项对应数据，该数据的结构为BannerData，为bannerList获取的Array<BannerData>的单元实体项
  283 +
  284 + opts: object 选传，调试阶段可参照[wx.navigateToMiniProgram(Object object) extraData配置信息]进行裴旭
  285 + {
  286 + extraData: string 选传, 需要传递给目标小程序的数据，目标小程序可在 App.onLaunch，App.onShow 中获取到这份数据
  287 + envVersion: string 选传，要打开的小程序版本，合法值：develop、trial、release
97 } 288 }
98 ``` 289 ```
99 290
100 - 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟使用环境） 291 + 示例：获取猜你喜欢广告位，以列表的形式显示在界面上，点击任意一项游戏跳转其他游戏
101 292
102 ```javascript 293 ```javascript
103 // 发起登录请求，得到登录数据信息，调用setLogind设置SDK用户信息 294 // 发起登录请求，得到登录数据信息，调用setLogind设置SDK用户信息
104 - Api.login().then( data => {  
105 - let { user_id, user_reg_time } = data;  
106 - PCSDK.stat.setLogind({  
107 - userId: data.user_id,  
108 - regTime: data.user_reg_time  
109 - });  
110 - }); 295 + /**
  296 + * 演示交叉推广位使用示例
  297 + */
  298 + export default class TestBannerSample extends ui.shop.ShopPopwinUI {
  299 + private list: Laya.List;
  300 +
  301 + constructor() {
  302 + super();
  303 +
  304 + // 创建List ui
  305 + this.list = new Laya.List();
  306 + this.list.itemRender = AdItem;
  307 + this.list.vScrollBarSkin = "";
  308 + this.list.scrollBar.elasticBackTime = 500;
  309 + this.list.scrollBar.elasticDistance = 350;
  310 + this.list.x = 0;
  311 + this.list.y = 0;
  312 + this.list.spaceY = 10;
  313 + this.list.height = 1000;
  314 + this.list.renderHandler = new Laya.Handler(this, this.renderAdItem);
  315 + this.boxList.addChild(this.list);
  316 +
  317 + // 示例：加载猜你喜欢广告位数据列表
  318 + this.loadBannerList(BannerType.TYPE_LIKE)
  319 + .then((dataList: Array<BannerData>) => {
  320 + this.renderAdLikeList(dataList);
  321 + }).catch(err => {
  322 + // bannerList不存在获取请求拉取失败
  323 + });
  324 + }
  325 +
  326 + /**
  327 + * 渲染单个广告位ui
  328 + * @param cell
  329 + */
  330 + private renderAdItem(cell: AdItem) {
  331 + cell.init();
  332 + }
  333 +
  334 + /**
  335 + * 渲染广告位列表
  336 + * @param dataList 广告位列表
  337 + */
  338 + private renderAdLikeList(dataList: Array<BannerData>) {
  339 + this.list.array = dataList;
  340 + }
  341 +
  342 + /**
  343 + * 根据类型获取交叉推广位列表
  344 + * @param banner_type 广告位类型
  345 + */
  346 + private loadBannerList(banner_type: BannerType): Promise<any> {
  347 + return new Promise((resolve, reject) => {
  348 + PCSDK.stat.bannerList(banner_type)
  349 + .then(data => {
  350 + let bannerList: Array<BannerData> = data.banner_list || [];
  351 + if (bannerList.length) {
  352 + // 处理bannerList数据列表
  353 + resolve(bannerList);
  354 + } else {
  355 + // 处理数据为空情况
  356 + reject(null);
  357 + }
  358 + }).catch(err => {
  359 + // 请求接口报错情况
  360 + reject(err);
  361 + });
  362 + });
  363 + }
  364 + }
  365 +
  366 + class AdItem extends ui.ads.GameIconUI {
  367 + constructor() {
  368 + super();
  369 + this.on(Laya.Event.CLICK, this, this.onJumpGame);
  370 + }
  371 +
  372 + init() {
  373 + let { banner_icon, banner_name, banner_reddot } = this.dataSource;
  374 + this.iconTex.skin = banner_icon;
  375 + this.nametxt.text = banner_name;
  376 + this.hot.visible = banner_reddot + '' === '1';
  377 + }
  378 +
  379 + private onJumpGame(ev: Laya.Event) {
  380 + PCSDK.stat.bannerNavigateTo(100, { ...this.dataSource }).catch(err => {
  381 + // 跳转游戏微信弹出二次确认框，点击取消执行此处
  382 + });
  383 + }
  384 + }
  385 +
  386 + // 广告位类型的枚举
  387 + enum BannerType {
  388 + TYPE_CROSS = 40, // 交叉悬浮广告框
  389 + TYPE_LIKE = 50, // 交叉猜你喜欢广告位
  390 + TYPE_LIST = 70, // 交叉抽屉广告位
  391 + }
  392 +
  393 + /*
  394 + * banner数据实体结构
  395 + */
  396 + class BannerData {
  397 + public banner_id: string;
  398 + public banner_appid: string;
  399 + public banner_diamond: number;
  400 + public banner_type: string;
  401 + public banner_icon: string;
  402 + public banner_name: string;
  403 + public banner_resident: string; // 是否常驻
  404 + }
111 ``` 405 ```
112 406
113 407
114 -3. **active** 408 +3. ##### **addExposure**
115 409
116 ```javascript 410 ```javascript
117 - PCSDK.stat.active(): void 411 + PCSDK.stat.addExposure( location: number, banner_data: Array< any > | any ): void
118 ``` 412 ```
119 413
120 - 定义：用户活跃/新增注册上报，切记在使用setLogind设置用户信息过后调用此接口，不然会导致新增注册数据统计异常 414 + 定义：对展示的一个或者多个广告位添加曝光，SDK在onHide时候上报曝光数据到后台，后台会进行统计展示
121 415
122 参数： 416 参数：
123 417
124 ```javascript 418 ```javascript
125 - 无 419 + location: number 必传，统一传递为：100
  420 +
  421 + banner_data：any 必传，添加展示广告位曝光数据，可添加一个或者多个曝光数据，banner_data参数数据结构为上面bannerList api返回的列表数据的项BannerData实体结构：Array<BannerData> | BannerData
  422 +
126 ``` 423 ```
127 424
128 - 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟该接口使用环境） 425 + > 提示：
  426 + >
  427 + > 展示猜你喜欢/抽屉广告位：获取到9个广告位数据，展示了5个其中广告位，调用曝光接口传入广告数据为展示的5个，剩余的4个需展示的时候再调用曝光api接口传入。
  428 + >
  429 + > 展示交叉悬浮框广告位：展示一个，将此广告位传入曝光接口，点击展示下一个广告，则把这个最新展示广告数据传入曝光api
  430 + 示例：交叉悬浮框广告位显示及添加曝光实现（拉取广告列表后，每次只显示一个，点击一个切换下一个，定时器4秒切换下一个，直到列表为空，请求新的广告位列表）
129 431
  432 + 思路：根据交叉悬浮框类型调用PCSDK.stat.bannnerList接口获取交叉悬浮框广告位列表，显示第一个，每隔4秒切换到下一个，点击一个切换下一个展示。此示例没有使用定时器方式，采用的是监听动画帧实现。
130 ```javascript 433 ```javascript
131 - // 使用场景1：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息后立即调用active  
132 - Api.login().then( data => {  
133 - let { user_id, user_reg_time } = data;  
134 - // 设置用户信息  
135 - PCSDK.stat.setLogind({  
136 - userId: data.user_id,  
137 - regTime: data.user_reg_time  
138 - });  
139 - // 用户活跃注册打点  
140 - PCSDK.stat.active();  
141 - });  
142 -  
143 - // 使用场景2：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息。在其他界面调用active  
144 - // 资源加载loading界面  
145 - class LoadingScene(){  
146 - constructor(){  
147 - this.login();  
148 - }  
149 -  
150 - private login(){  
151 - // 登录  
152 - Api.login().then( data => {  
153 - let { user_id, user_reg_time } = data;  
154 - // 设置用户信息  
155 - PCSDK.stat.setLogind({  
156 - userId: data.user_id,  
157 - regTime: data.user_reg_time  
158 - });  
159 - // 进入home主页场景  
160 - SceneManager.I.switchScene(HomeScene);  
161 - });  
162 - }  
163 - }  
164 -  
165 - // Home页面  
166 - class HomeScene(){  
167 - constructor(){  
168 - this.btnStarGame.on('click', this.onGame, this);  
169 - }  
170 -  
171 - private onGame(){  
172 - // 用户活跃注册打点  
173 - PCSDK.stat.active();  
174 - // 进入游戏页面  
175 - SceneManager.I.switchScene(GameScene);  
176 - } 434 +/**
  435 + * 演示交叉推广位使用示例
  436 + */
  437 +export default class TestBannerSample extends ui.ads.ADbtnUI {
  438 + private data;
  439 + private count: number;
  440 + private adList: Array<BannerData>;
  441 +
  442 + constructor() {
  443 + super();
  444 + this.count = 0;
  445 + this.adList = [];
  446 + this.on(Laya.Event.CLICK, this, this.onJumpGame);
  447 + }
  448 +
  449 + // 初始化显示交叉悬浮框广告位
  450 + init(isFirst: boolean) {
  451 + isFirst && (this.count = 0);
  452 + this.anim_entice.play(0, true);
  453 + this.anim_entice.addLabel('refresh', 38);
  454 + // 交叉悬浮框动画执行到第38帧，自动更新下一个，开发者可根据实际使用定时器实现切换下一个
  455 + this.anim_entice.on(Laya.Event.LABEL, this, this.handleAutoRrefresh);
  456 + // 第一次
  457 + this.refresh();
177 } 458 }
178 - 459 +
  460 + // 清理交叉悬浮框广告位
  461 + clear() {
  462 + this.anim_entice.gotoAndStop(0);
  463 + this.anim_entice.removeLabel('refresh');
  464 + this.anim_entice.off(Laya.Event.LABEL, this, this.handleAutoRrefresh);
  465 + }
  466 +
  467 + private refresh() {
  468 + let list = this.adList;
  469 + if (!list || !list.length) {
  470 + this.loadBannerList(BannerType.TYPE_CROSS).then(() => this.refresh());
  471 + return;
  472 + }
  473 + let data = list.pop();
  474 + this.renderAdui(data);
  475 + this.data = data;
  476 + // 添加曝光数据
  477 + PCSDK.stat.addExposure(100, data);
  478 + // 也可以采用传递多个方式
  479 + // PCSDK.stat.addExposure(100, [{...data}]);
  480 + }
  481 +
  482 + private renderAdui(data) {
  483 + let { banner_bone_info, banner_img_info } = data;
  484 + if (banner_bone_info) {
  485 + this.imgIcon.visible = false;
  486 + } else {
  487 + this.imgIcon.visible = true;
  488 + this.imgIcon.skin = banner_img_info.banner_icon;
  489 + }
  490 + this.imgHot.visible = data.banner_reddot + '' === '1';
  491 + }
  492 +
  493 + private onJumpGame(ev: Laya.Event) {
  494 + this.anim_entice.gotoAndStop(39);
  495 + this.anim_entice.play(39, true);
  496 + // 切换下一个
  497 + this.refresh();
  498 + PCSDK.stat.bannerNavigateTo(100, { ...this.data }).catch(err => {
  499 + // 跳转游戏微信弹出二次确认框，点击取消执行此处
  500 + });
  501 + }
  502 +
  503 + /**
  504 + * 处理自动切换下一个
  505 + * @param name
  506 + */
  507 + private handleAutoRrefresh(name) {
  508 + if (name === 'refresh' && this.count !== 0) {
  509 + this.refresh();
  510 + }
  511 + this.count++;
  512 + }
  513 +
  514 + /**
  515 + * 根据类型获取交叉推广位列表
  516 + * @param banner_type 广告位类型
  517 + */
  518 + private loadBannerList(banner_type: BannerType): Promise<any> {
  519 + return new Promise((resolve, reject) => {
  520 + PCSDK.stat.bannerList(banner_type)
  521 + .then(data => {
  522 + let bannerList: Array<BannerData> = data.banner_list || [];
  523 + if (bannerList.length) {
  524 + // 处理bannerList数据列表
  525 + resolve(bannerList);
  526 + } else {
  527 + // 处理数据为空情况
  528 + reject(null);
  529 + }
  530 + }).catch(err => {
  531 + // 请求接口报错情况
  532 + reject(err);
  533 + });
  534 + });
  535 + }
  536 + }
  537 +
  538 + // 广告位类型的枚举
  539 + enum BannerType {
  540 + TYPE_CROSS = 40, // 交叉悬浮广告框
  541 + TYPE_LIKE = 50, // 交叉猜你喜欢广告位
  542 + TYPE_LIST = 70, // 交叉抽屉广告位
  543 + }
179 ``` 544 ```
180 \ No newline at end of file 545 \ No newline at end of file
stat_event.md 0 → 100644
  Diff comments   View file @e5e0d59
@@ -0,0 +1,140 @@ @@ -0,0 +1,140 @@
  1 +# 自定义事件打点
  2 +
  3 +------
  4 +
  5 +#### **简介**
  6 +
  7 +自定义事件是噗嗤游戏为开发者提供的自助分析功能。用户在小游戏上的行为，我们定义为事件。 游戏的任意位置需要统计触达人数我们通用可以使用事件来进行统计，后台进行分析后阅览。
  8 +
  9 +#### **后台使用**
  10 +
  11 +接入自定义事件打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】可查看自定义事件次数、去重人数等详细信息（此功能需要管理员添加权限）：
  12 +
  13 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_018.png)
  14 +
  15 +
  16 +
  17 +#### **接入必读**
  18 +
  19 +接入自定义事件打点前，请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件的key：登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】->点击【新增】添加自定义事件（事件key可语义化的自定义，推荐_连接）。
  20 +
  21 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_016.png)
  22 +
  23 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_017.png)
  24 +
  25 +> 提示：游戏新增自定义事件如果很多，一个个复制可能比较繁琐，进入噗嗤后台【事件列表】后，chrome浏览器打开【开发者工具】，在console栏下方输入下面的命令后，可自动生成自定义事件key的枚举（如果事件很多出现翻页，则每一页都执行后，手动合并为一个枚举），复制到项目中使用，枚举key生成规则为事件key转换为大驼峰式，枚举value为事件key：
  26 +
  27 +```javascript
  28 +// 第1个参数表示生成枚举的名字：EventKeys
  29 +// 第2个参数表示事件key所在列索引（第2列）：1
  30 +// 第3个参数表示事件key注释所在列索引（第3列）：2
  31 +// 最后一个参数选填，any传递false表示枚举字符串不带any转换
  32 +PCPlugins.transform('EventKeys', 1 , 2 , { any: false});
  33 +```
  34 +
  35 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_019.png)
  36 +
  37 +
  38 +
  39 +示例：使用PCPlugins.transform('EventKeys', 1 , 2 , { any: false}); 生成的自定义事件key枚举
  40 +
  41 +```
  42 +enum EventKeys {
  43 + // 关卡7进入,
  44 + Level7Enter = 'level7_enter',
  45 + // 关卡6进入,
  46 + Level6Enter = 'level6_enter',
  47 + // 关卡5进入,
  48 + Level5Enter = 'level5_enter',
  49 + // 关卡4进入,
  50 + Level4Enter = 'level4_enter',
  51 + // 关卡3进入,
  52 + Level3Enter = 'level3_enter',
  53 + // 关卡2进入,
  54 + Level2Enter = 'level2_enter',
  55 + // 关卡1进入,
  56 + Level1Enter = 'level1_enter',
  57 + // 关卡失败双倍奖励,
  58 + MapFailDouble = 'map_fail_double',
  59 + // 引导10-主界面再次进入游戏,
  60 + Guide109 = 'guide_109',
  61 + // 引导9-合成确认,
  62 + Guide108 = 'guide_108',
  63 + // 引导8-合成成功后,
  64 + Guide107 = 'guide_107',
  65 + // 引导7-合成,
  66 + Guide106 = 'guide_106',
  67 + // 引导6-第二次购买,
  68 + Guide105 = 'guide_105',
  69 + // 引导5-第一次购买,
  70 + Guide104 = 'guide_104',
  71 + // 引导4-结算引导,
  72 + Guide103 = 'guide_103',
  73 + // 引导3-开始射击,
  74 + Guide102 = 'guide_102',
  75 + // 引导2-开始游戏,
  76 + Guide101 = 'guide_101',
  77 + // 引导1-欢迎,
  78 + Guide100 = 'guide_100',
  79 + // 金币加速，关闭,
  80 + SpeedUpClose = 'speed_up_close',
  81 + // 金币加速，免费领取,
  82 + SpeedUpFree = 'speed_up_free'
  83 +}
  84 +```
  85 +
  86 +
  87 +
  88 +
  89 +
  90 +#### **接入API**：
  91 +
  92 +| **名称** | **功能说明** |
  93 +| ---------------- | ------------------------------------------------------------ |
  94 +| PCSDK.stat.event | 自定义事件打点，使用前请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件key |
  95 +
  96 +
  97 +
  98 +1. **event**
  99 +
  100 + ```javascript
  101 + PCSDK.stat.event(event_key: string , event_source: string , opts?: { ext_val?: string | number} ): Promise<any>
  102 + ```
  103 +
  104 + 定义：自定义事件打点，可在游戏任何位置定义事件打点
  105 +
  106 + 参数：
  107 +
  108 + ```
  109 + event_key: string 必传，后台配置的事件key
  110 +
  111 + event_source: string 必传，触发该事件所在页面位置，例如：结算页面、排行榜界面、签到页面。。。
  112 +
  113 + opts?: object 选传，自定义扩展参数，一些特定的事件想传递更多信息，此参数使用请咨询相关对接人员目前只支持对象一个key（evt_val），多个扩展参数使用'|'连接
  114 + {
  115 + ext_val: '100|1000'
  116 + }
  117 + ```
  118 + 示例：
  119 +
  120 + ```javascript
  121 + // 签到功能
  122 + private onSign() {
  123 + PCSDK.stat.event(EventKeys.FunctionSign, '主界面');
  124 + }
  125 +
  126 + // 开始加载资源
  127 + private loadRes() {
  128 + PCSDK.stat.event(EventKeys.LoadingExhibition, '加载界面');
  129 + LoaderManager.I.setCallback(this.onLoadedMain, this.onProgressMain, null, this).loadMain();
  130 + }
  131 +
  132 + // 升级领奖
  133 + private onReward(e: Laya.Event) {
  134 + PCSDK.stat.event(EventKeys.LvUpRewards, '升级界面');
  135 + SDKTools.shareDispatch(ShareKey.LevelUpDiamond, {
  136 + success: this.handleDoubleReward,
  137 + context: this
  138 + });
  139 + }
  140 + ```
stat_level.md 0 → 100644
  Diff comments   View file @e5e0d59
@@ -0,0 +1,67 @@ @@ -0,0 +1,67 @@
  1 +# 关卡分析打点
  2 +
  3 +------
  4 +
  5 +#### **简介**
  6 +
  7 +关卡分析，为开发者提供小游戏详细的关卡数据，分析各关卡玩家的通关状况，帮助开发者从数据角度衡量游戏设计的合理性，调节难易度，观察各关卡道具使用情况和奖励获取状况，对比分析各个指标，通过量化玩家数据，提高游戏体验。
  8 +
  9 +#### **后台使用**
  10 +
  11 +接入关卡分析接口后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【关卡分析】可查看关卡进入用户数据、失败次数、失败率、平均完成时间等）：
  12 +
  13 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_020.png)
  14 +
  15 +
  16 +
  17 +#### **接入API**：
  18 +
  19 +| **名称** | **功能说明** |
  20 +| ---------------- | ------------------------------------------------------------ |
  21 +| PCSDK.stat.event | 自定义事件打点，使用前请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件key |
  22 +
  23 +
  24 +
  25 +1. **event**
  26 +
  27 + ```javascript
  28 + PCSDK.stat.event(event_key: string , event_source: string , opts?: { ext_val?: string | number} ): Promise<any>
  29 + ```
  30 +
  31 + 定义：自定义事件打点，可在游戏任何位置定义事件打点
  32 +
  33 + 参数：
  34 +
  35 + ```
  36 + event_key: string 必传，后台配置的事件key
  37 +
  38 + event_source: string 必传，触发该事件所在页面位置，例如：结算页面、排行榜界面、签到页面。。。
  39 +
  40 + opts?: object 选传，自定义扩展参数，一些特定的事件想传递更多信息，此参数使用请咨询相关对接人员目前只支持对象一个key（evt_val），多个扩展参数使用'|'连接
  41 + {
  42 + ext_val: '100|1000'
  43 + }
  44 + ```
  45 + 示例：
  46 +
  47 + ```javascript
  48 + // 签到功能
  49 + private onSign() {
  50 + PCSDK.stat.event(EventKeys.FunctionSign, '主界面');
  51 + }
  52 +
  53 + // 开始加载资源
  54 + private loadRes() {
  55 + PCSDK.stat.event(EventKeys.LoadingExhibition, '加载界面');
  56 + LoaderManager.I.setCallback(this.onLoadedMain, this.onProgressMain, null, this).loadMain();
  57 + }
  58 +
  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 + });
  66 + }
  67 + ```