小川 / SdkGitbook

Download as
Browse Code »

Commit 97a07a9ec4d713f56ebfb38a69b172ba6870aee3

Authored by 小川 费
1 parent a46d4782
Exists in master

1

Showing 3 changed files with 88 additions and 12 deletions   Show diff stats
data.md
  Diff comments   View file @97a07a9
... ... @@ -19,8 +19,12 @@
19 19 | PCSDK.data.RegTime | 获取用户注册时间 |
20 20 | PCSDK.data.ShareId | 获取进入游戏的分享会话ID，不是从分享会话进入ShareId为0 |
21 21 | PCSDK.data.ShareKey | 接入SDK的分享视频模块后，从分享会话进去游戏，获取到分享会话的分享key |
22   -| PCSDK.data.Platform | 获取游戏运行平台环境：devtools（开发者调试工具）、ios(苹果设备)、android（安卓设备） |
  22 +| PCSDK.data.Platform | 获取游戏运行平台环境，字符串形式：devtools、ios、android。devtools（开发者调试工具）、ios(苹果设备)、android（安卓设备） |
  23 +| PCSDK.data.SystemId | 获取游戏运行平台环境，整数形式：0、1。0（开发者调试工具或ios）、1（安卓设备） |
23 24 | PCSDK.data.QueryUserInviteUid | 获取此次分享会话进入游戏，分享来源者用户ID |
  25 +| PCSDK.data.IsCross | 获取是否显示/隐藏交叉悬浮框推广位，true：显示，false：隐藏 |
  26 +| PCSDK.data.IsDrawer | 获取是否显示/隐藏交叉抽屉推广位，true：显示，false：隐藏 |
  27 +| PCSDK.data.IsGuessLike | 获取是否显示/隐藏交叉猜你喜欢推广位，true：显示，false：隐藏 |
24 28  
25 29  
26 30  
... ... @@ -132,7 +136,29 @@
132 136 break;
133 137 }
134 138 ```
135   -8. ##### **QueryUserInviteUid**
  139 +8. ##### **SystemId**
  140 +
  141 + ```javascript
  142 + PCSDK.data.SystemId: number
  143 + ```
  144 +
  145 + 定义：获取游戏运行平台环境：0（开发者调试工具或ios）、1（安卓设备）
  146 +
  147 + 示例：
  148 +
  149 + ```javascript
  150 + let systemId = PCSDK.data.SystemId;
  151 + switch (systemId) {
  152 + case 0: // 开发者工具 or 苹果设备
  153 +
  154 + break;
  155 +
  156 + case 1: // 安卓设备
  157 +
  158 + break;
  159 + }
  160 + ```
  161 +9. ##### **QueryUserInviteUid**
136 162  
137 163 ```javascript
138 164 PCSDK.data.QueryUserInviteUid: any
... ... @@ -152,4 +178,49 @@
152 178 ```javascript
153 179 // 从分享会话邀请链接进入，获得的值为邀请者用户id，不是分享会话邀请进入获取值为0
154 180 let inviteUid = PCSDK.data.QueryUserInviteUid;
  181 + ```
  182 +10. ##### **IsCross**<div id="ad_cross"></div>
  183 +
  184 + ```javascript
  185 + PCSDK.data.IsCross: boolean
  186 + ```
  187 +
  188 + 定义：获取是否显示/隐藏交叉悬浮框推广位，true：显示，false：隐藏
  189 +
  190 + 示例：获取是否显示交叉悬浮框推广位
  191 +
  192 + ```javascript
  193 + // 设置交叉悬浮框推广位ui的显示隐藏
  194 + let isShow = PCSDK.data.IsCross;
  195 + this.uiCross.visible = isShow;
  196 + ```
  197 +11. ##### **IsDrawer**
  198 +
  199 + ```javascript
  200 + PCSDK.data.IsDrawer: boolean
  201 + ```
  202 +
  203 + 定义：获取是否显示/隐藏交叉抽屉推广位，true：显示，false：隐藏
  204 +
  205 + 示例：
  206 +
  207 + ```javascript
  208 + // 设置交叉抽屉推广位ui的显示隐藏
  209 + let isShow = PCSDK.data.IsDrawer;
  210 + this.uiDrawer.visible = isShow;
  211 + ```
  212 +12. ##### **IsGuessLike**
  213 +
  214 + ```javascript
  215 + PCSDK.data.IsGuessLike: boolean
  216 + ```
  217 +
  218 + 定义：获取是否显示/隐藏交叉猜你喜欢推广位，true：显示，false：隐藏
  219 +
  220 + 示例：
  221 +
  222 + ```javascript
  223 + // 设置交叉猜你喜欢推广位ui的显示隐藏
  224 + let isShow = PCSDK.data.IsGuessLike;
  225 + this.uiGuessLike.visible = isShow;
155 226 ```
156 227 \ No newline at end of file
... ...
stat_ads.md
  Diff comments   View file @97a07a9
... ... @@ -38,6 +38,8 @@
38 38  
39 39 - 由于微信对每个游戏可跳转其他游戏有10个限制，可跳转的其它游戏需要在小游戏根目录下的全局配置文件game.json中进行添加配置：navigateToMiniProgramAppIdList，该参数定义请详读[小程序全局配置](https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html)。
40 40  
  41 +- **接入3种交叉推广位后，为了防止微信审核被拒（被拒理由：微信认定游戏跳转到其他游戏太多，判断游戏是一个游戏盒子，拒绝审核通过），为了防范被拒，在[数据模块](data.md)提供了三个数据获取api：PCSDK.data.IsCross、PCSDK.data.IsDrawer、PCSDK.data.IsGuessLike，控制3种推广位广告的显示隐藏，开发者在游戏中对三种广告控制显示隐藏状态。[详请请阅读数据api](data.md#ad_cross)。**
  42 +
41 43 - 噗嗤游戏为了方便开发者接入调试交叉推广位，后台已经配置测试使用的3种类型推广位，提供以下10个推广位appid，开发者复制下面的navigateToMiniProgramAppIdList json数据，配置到game.json的navigateToMiniProgramAppIdList参数：
42 44  
43 45 水果爆破 ："wx26822126b4d99eda",
... ...
stat_level.md
  Diff comments   View file @97a07a9
... ... @@ -29,7 +29,7 @@
29 29 1. #### **logLevelRelive**
30 30  
31 31 ```javascript
32   - PCSDK.stat.logLevelRelive(levelId: string | number , params?: { attr?: number, ext?: string } ): void
  32 + PCSDK.stat.logLevelRelive(levelId: string | number , params?: { attr?: number, ext?: any } ): void
33 33 ```
34 34  
35 35 定义：关卡复活成功数据上报
... ... @@ -42,7 +42,7 @@
42 42 params: object 选传，关卡需要的其他参数，目前只支持传递2个属性: attr、ext
43 43 {
44 44 attr: number 选传 战斗属性（例如:关卡战斗中所使用的枪支等级）
45   - ext: string 选传 扩展参数：key1=val1&key2=val2的格式
  45 + ext: object 选传 扩展参数：{ key1:val1, key2:val2 }的格式
46 46 }
47 47 ```
48 48  
... ... @@ -51,7 +51,7 @@
51 51 2. #### **logLevelHide**
52 52  
53 53 ```javascript
54   - PCSDK.stat.logLevelHide(levelId: string | number , params?: { attr?: number, ext?: string } ): void
  54 + PCSDK.stat.logLevelHide(levelId: string | number , params?: { attr?: number, ext?: any } ): void
55 55 ```
56 56 定义：监听游戏战斗界面onHide时上报关卡的数据。什么是界面onHide？[请详读微信小游戏wx.onHide](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onHide.html)
57 57 注意事项：
... ... @@ -73,8 +73,8 @@
73 73  
74 74 params: object 选传，关卡需要的其他参数，目前只支持传递2个属性: attr、ext
75 75 {
76   - attr: number 战斗属性（例如:关卡战斗中所使用的枪支等级）
77   - ext: string 选传 扩展参数：key1=val1&key2=val2的格式
  76 + attr: number 选传 战斗属性（例如:关卡战斗中所使用的枪支等级）
  77 + ext: object 选传 扩展参数：{ key1:val1, key2:val2 }的格式
78 78 }
79 79 ```
80 80 [点此查看完整示例](stat_level.md#sample)如何添加关卡onHide打点代码
... ... @@ -82,7 +82,7 @@
82 82 3. #### **logLevelFail**
83 83  
84 84 ```javascript
85   - PCSDK.stat.logLevelFail(levelId: string | number , params: { ctime: number, first: number, attr?: number, ext?: string } ): void
  85 + PCSDK.stat.logLevelFail(levelId: string | number , params: { ctime: number, first: number, attr?: number, ext?: any } ): void
86 86 ```
87 87  
88 88 定义：关卡失败数据上报
... ... @@ -97,7 +97,7 @@
97 97 ctime: number 必传 关卡耗时 = 当前时间-关卡进入时间，单位秒
98 98 first: number 必传 是否第一次体验关卡，1是，0否
99 99 attr: number 选传 战斗属性（例如:关卡战斗中所使用的枪支等级）
100   - ext: string 选传 扩展参数：key1=val1&key2=val2的格式
  100 + ext: object 选传 扩展参数：{ key1:val1, key2:val2 }的格式
101 101 }
102 102 ```
103 103 [点此查看完整示例](stat_level.md#sample)如何添加关卡失败打点代码
... ... @@ -105,7 +105,7 @@
105 105 4. #### **logLevelWin**
106 106  
107 107 ```javascript
108   - PCSDK.stat.logLevelWin(levelId: string | number , params: { ctime: number, first: number, attr?: number, ext?: number } ): void
  108 + PCSDK.stat.logLevelWin(levelId: string | number , params: { ctime: number, first: number, attr?: number, ext?: any } ): void
109 109 ```
110 110  
111 111 定义：关卡成功通关数据上报
... ... @@ -120,7 +120,7 @@
120 120 ctime: number 必传 关卡耗时 = 当前时间-关卡进入时间，单位秒
121 121 first: number 必传 是否第一次体验关卡，1是，0否
122 122 attr: number 选传 战斗属性（例如:关卡战斗中所使用的枪支等级）
123   - ext: string 选传 扩展参数：key1=val1&key2=val2的格式
  123 + ext: object 选传 扩展参数：{ key1:val1, key2:val2 }的格式
124 124 }
125 125 ```
126 126 <div id="sample"></div> 完整示例，以上四个接口使用场景：
... ... @@ -223,7 +223,10 @@
223 223 PCSDK.stat.logLevelWin(this.missionId, {
224 224 ctime: costTime,
225 225 first: failNum ? 0 : 1,
226   - attr: this.currSelectGun
  226 + attr: this.currSelectGun,
  227 + ext: {
  228 + currHp: 100000
  229 + }
227 230 });
228 231 break;
229 232  
... ...