小川 / SdkGitbook

Download as
Browse Code »

Commit 5f3728df19d8b82fa0e6bae17db160bb2913ef4b

Authored by 小川 费
1 parent 05664564
Exists in master

1

Showing 6 changed files with 136 additions and 90 deletions   Show diff stats
SUMMARY.md
  Diff comments   View file @5f3728d
... ... @@ -10,12 +10,12 @@
10 10 * [统计模块](stat.md)
11 11 * [启动注册打点️](stat_active.md)
12 12 * [关卡分析打点️️](stat_level.md)
  13 + * [支付结果打点](stat_pay.md)
13 14 * [自定义事件打点](stat_event.md)
14 15 * [交叉推广位](stat_ads.md)
15 16 * [分享视频模块](share.md)
16 17 * [配置参数模块️](online.md)
17 18 * [多平台接口模块](platform.md)
18   - * [支付打点](platform.md#logpay)
19 19 * [打开客服消息](platform.md#service)
20 20 * [检测自动更新](platform.md#checkUpdate)
21 21 * [复制文本内容](platform.md#copy)
... ...
book.json
  Diff comments   View file @5f3728d
... ... @@ -12,27 +12,21 @@
12 12 "-sharing",
13 13 "-highlight",
14 14 "-livereload",
  15 + "emphasize",
15 16 "simple-page-toc@^0.1.1",
16 17 "prism",
17 18 "prism-themes",
18 19 "include-codeblock@^3.0.2",
19   - "katex@^1.1.3",
20 20 "splitter@^0.0.8",
21   - "mermaid-gb3@2.1.0",
22 21 "tbfed-pagefooter@^0.0.1",
23 22 "expandable-chapters-small@^0.1.7",
24 23 "sectionx@^3.1.0",
25 24 "local-video@^1.0.1",
26   - "favicon@^0.0.2",
  25 + "anchor-navigation-ex",
27 26 "todo@^0.1.3",
28   - "terminal@^0.3.2",
29   - "alerts@^0.2.0",
30   - "include-csv@^0.1.0",
31   - "puml@^1.0.1",
32   - "musicxml@^1.0.2",
33   - "graph@^0.1.0",
34   - "chart@^0.2.0",
35   - "popup"
  27 + "popup",
  28 + "lightbox",
  29 + "copy-code-button"
36 30 ],
37 31 "structure": {
38 32 "readme": "README.md"
... ... @@ -45,6 +39,18 @@
45 39 "css": [
46 40 "prism-themes/themes/prism-base16-ateliersulphurpool.light.css"
47 41 ]
  42 + },
  43 + "anchor-navigation-ex": {
  44 + "associatedWithSummary": false,
  45 + "showLevel": true,
  46 + "multipleH1": true,
  47 + "mode": "float",
  48 + "pageTop": {
  49 + "showLevelIcon": false,
  50 + "level1Icon": "fa fa-hand-o-right",
  51 + "level2Icon": "fa fa-hand-o-right",
  52 + "level3Icon": "fa fa-hand-o-right"
  53 + }
48 54 }
49 55 }
50 56 }
51 57 \ No newline at end of file
... ...
images/prev.png 0 → 100644
View file @5f3728d

409 Bytes
install.md
  Diff comments   View file @5f3728d
... ... @@ -183,9 +183,9 @@
183 183  
184 184 12. **Secret：必填，游戏 Secret Key，请联系运营人员提供**
185 185  
186   -13. **MidasPay( object )：**米大水虚拟支付配置，没有接入微信的米大师支付，请注意下面规则
  186 +13. **MidasPay( object )：**米大师虚拟支付配置，请注意下面规则
187 187  
188   - OfferId：在米大师申请的应用id，没有接入米大师，默认为"0"
  188 + OfferId：在米大师申请的应用id，没有接入米大师（比如第三方支付），默认为"0"
189 189  
190 190 ZoneId：分区ID，默认："1"
191 191  
... ...
platform.md
  Diff comments   View file @5f3728d
... ... @@ -8,7 +8,6 @@
8 8  
9 9 #### **此模块是参照微信小游戏提供的api进行封装的公用方法，提供了以下游戏中常用到的功能：**
10 10  
11   -1. **支付打点：logPay** (此模块保留logPay调用只是为了兼容已经接入的游戏，该api已经归类到【统计模块】下面的[支付打点](stat_pay.md)栏)。
12 11 2. **打开客服消息：openCustomerServiceConversation** 整理来自[wx.openCustomerServiceConversation](https://developers.weixin.qq.com/minigame/dev/api/open-api/customer-message/wx.openCustomerServiceConversation.html)
13 12  
14 13 3. **检测版本更新：checkUpdate** 整理来自：[wx.getUpdateManager](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html)
... ... @@ -26,7 +25,6 @@
26 25  
27 26 | **名称** | **功能说明** |
28 27 | ------------------------ | ------------------------------------------------------------ |
29   -| PCSDK.platform.logPay | 支付统计打点，支付完成（取消、成功、失败）的打点 |
30 28 | PCSDK.platform.openCustomerServiceConversation | 进入客服会话，可打开一个普通的客服会话，也可打开客服会话发送体力、钻石和进入跳转充值等，[具体用法请看](platform.md#service)|
31 29 | PCSDK.platform.checkUpdate | 检测版本是否有更新，如果版本更新会弹出确认框 |
32 30 | PCSDK.platform.copy | 设置系统剪贴板的内容。微信小游戏调用成功后，会弹出 toast 提示"内容已复制"，持续 1.5s |
... ... @@ -43,78 +41,8 @@
43 41  
44 42  
45 43  
46   -<div id="logpay"></div>
47   -1. **logPay**
48   -
49   - ```javascript
50   - PCSDK.platform.logPay( params: object ): void
51   - ```
52   -
53   - 定义：开发者游戏充值完成后，上报支付结果打点，支付结果类型：0（支付失败），1（支付成功），-1（取消支付）。该api需在[config.js中配置MidasPay](install.md#configJs)信息。
54   -
55   - 参数：
56   -
57   - ```
58   - params object 必传 打点参数
59   - {
60   - type: number 必传 支付类型：0（支付失败），1（支付成功），-1（取消支付）;
61   - source: string 必传 游戏服务商生成的订单号，没有则为空字符串
62   - amount: number 必传 实际支付金额，单位分
63   - buy_id: string | number; 必传 商品ID
64   - buy_name: string; 必传 商品名称
65   - item_info: string 必传 获得的道具内容：道具id及数量，逗号分隔，多项使用分号分隔 => 1,1;2,10;3,100
66   - }
67   - ```
68   - 返回值：
69   -
70   - ```
71   - void
72   - 无
73   - ```
74   -
75   - 示例：客户端游戏支付完成后上报支付打点，下例只是演示logPay用法
76   -
77   - ```javascript
78   - private reqPay() {
79   - Api.I.pay().then( ret => {
80   - switch(ret.code){
81   - case 1: // 支付成功回调处理
82   - PCSDK.platform.logPay({
83   - type: 1, // 成功支付
84   - source: "10000400", // 订单号，没有则为空字符串
85   - amount: 10 * 100, // 10元
86   - buy_id: 58, // 支付的商品id
87   - buy_name: "钻石*152，金币*188888888",
88   - item_info: "40,152;90,188888888" // 例如 钻石id：40 金币id：90
89   - });
90   - break;
91   -
92   - case 0: // 支付失败回调处理
93   - PCSDK.platform.logPay({
94   - type: 0, // 失败支付
95   - source: "10000400", // 订单号，没有则为空字符串
96   - amount: 10 * 100, // 10元
97   - buy_id: 58, // 支付的商品id
98   - buy_name: "钻石*152，金币*188888888",
99   - item_info: "40,152;90,188888888" // 例如 钻石id：40 金币id：90
100   - });
101   - break;
102   -
103   - case -1: // 支付取消回调处理
104   - PCSDK.platform.logPay({
105   - type: -1, // 取消支付
106   - source: "10000400", // 订单号，没有则为空字符串
107   - amount: 10 * 100, // 10元
108   - buy_id: 58, // 支付的商品id
109   - buy_name: "钻石*152，金币*188888888",
110   - item_info: "40,152;90,188888888" // 例如 钻石id：40 金币id：90
111   - });
112   - break;
113   - }
114   - });
115   - }
116   - ```
117 44 <div id="service"></div>
  45 +
118 46 2. **openCustomerServiceConversation**
119 47  
120 48 ```javascript
... ... @@ -366,12 +294,12 @@
366 294 ```
367 295 定义：使手机发生较短时间的振动（15 ms）。仅在 iPhone 7 / 7 Plus 以上及 Android 机型生效
368 296 参数：
369   -
  297 +
370 298 ```javascript
371 299 无
372   -```
  300 + ```
373 301 示例：
374   -
  302 +
375 303 ```javascript
376 304 PCSDK.platform.vibrateShort();
377 305  
... ...
stat_pay.md 0 → 100644
  Diff comments   View file @5f3728d
... ... @@ -0,0 +1,112 @@
  1 +# 支付结果打点
  2 +
  3 +------
  4 +
  5 +#### **简介**
  6 +
  7 +支付上报，是开发者使用米大师或者第三方其他支付（比如H5支付），支付回调后把支付结果（失败支付、成功支付、取消支付）上报到后台。
  8 +
  9 +#### **注意事项**
  10 +
  11 +{% em %} 使用api，需在[config.js中配置MidasPay](install.md#configJs)信息。 {% endem %}
  12 +
  13 +**MidasPay( object )配置：**米大师虚拟支付配置，请注意下面规则
  14 +
  15 + OfferId：在米大师申请的应用id，没有接入米大师，默认为"0"
  16 +
  17 + ZoneId：分区ID，默认："1"
  18 +
  19 + Mode：支付的类型，不同的支付类型有各自额外要传的附加参数，默认："game"
  20 +
  21 + CurrencyType：币种，默认："CNY"
  22 +
  23 + Platform：申请接入时的平台，platform与OfferId（米大师申请的应用id）有关。
  24 +
  25 + 1）接入了米大师，填写"android"（ios暂时没有开放）
  26 +
  27 + 2）未接入米大师，使用其他支付，如果只支持android，则填写"android"；
  28 +
  29 + 3）未接入米大师，使用其他支付，如果只支持ios，则填写"ios"；
  30 +
  31 + 4）未接入米大师，使用其他支付，如果支持ios和android，则填写为""，sdk会根据手机识别android还是ios
  32 +
  33 +
  34 +
  35 +#### **接入API：**
  36 +
  37 +| **名称** | **功能说明** |
  38 +| ------------------------ | ------------------------------------------------------------ |
  39 +| PCSDK.stat.logPay | 开发者游戏充值完成后，上报支付结果打点，支付结果类型：0（支付失败），1（支付成功），-1（取消支付） |
  40 +
  41 +
  42 +1. **logPay**
  43 +
  44 + ```javascript
  45 + PCSDK.stat.logPay( params: object ): void
  46 + ```
  47 +
  48 + 定义：开发者游戏充值完成后，上报支付结果打点，支付结果类型：0（支付失败），1（支付成功），-1（取消支付）。该api需在[config.js中配置MidasPay](install.md#configJs)信息。
  49 +
  50 + 参数：
  51 +
  52 + ```
  53 + params object 必传 打点参数
  54 + {
  55 + type: number 必传 支付类型：0（支付失败），1（支付成功），-1（取消支付）;
  56 + source: string 必传 游戏服务商生成的订单号，没有则为空字符串
  57 + amount: number 必传 实际支付金额，单位分
  58 + buy_id: string | number; 必传 商品ID
  59 + buy_name: string; 必传 商品名称
  60 + item_info: string 必传 获得的道具内容：道具id及数量，逗号分隔，多项使用分号分隔 => 1,1;2,10;3,100
  61 + }
  62 + ```
  63 + 返回值：
  64 +
  65 + ```
  66 + void
  67 + 无
  68 + ```
  69 +
  70 + 示例：客户端游戏支付完成后上报支付打点，下例只是演示logPay用法
  71 +
  72 + ```javascript
  73 + private reqPay() {
  74 + // 模拟的支付，开发者需更加实际接入支付
  75 + Api.I.pay().then( ret => {
  76 + switch(ret.code){
  77 + case 1: // 支付成功回调处理
  78 + PCSDK.stat.logPay({
  79 + type: 1, // 成功支付
  80 + source: "10000400", // 订单号，没有则为空字符串
  81 + amount: 10 * 100, // 10元
  82 + buy_id: 58, // 支付的商品id
  83 + buy_name: "钻石*152，金币*188888888",
  84 + item_info: "40,152;90,188888888" // 例如 钻石id：40 金币id：90
  85 + });
  86 + break;
  87 +
  88 + case 0: // 支付失败回调处理
  89 + PCSDK.stat.logPay({
  90 + type: 0, // 失败支付
  91 + source: "10000400", // 订单号，没有则为空字符串
  92 + amount: 10 * 100, // 10元
  93 + buy_id: 58, // 支付的商品id
  94 + buy_name: "钻石*152，金币*188888888",
  95 + item_info: "40,152;90,188888888" // 例如 钻石id：40 金币id：90
  96 + });
  97 + break;
  98 +
  99 + case -1: // 支付取消回调处理
  100 + PCSDK.stat.logPay({
  101 + type: -1, // 取消支付
  102 + source: "10000400", // 订单号，没有则为空字符串
  103 + amount: 10 * 100, // 10元
  104 + buy_id: 58, // 支付的商品id
  105 + buy_name: "钻石*152，金币*188888888",
  106 + item_info: "40,152;90,188888888" // 例如 钻石id：40 金币id：90
  107 + });
  108 + break;
  109 + }
  110 + });
  111 + }
  112 + ```
0 113 \ No newline at end of file
... ...