From 5f3728df19d8b82fa0e6bae17db160bb2913ef4b Mon Sep 17 00:00:00 2001 From: 小川 费 <449111130@qq.com> Date: Mon, 23 Sep 2019 12:15:33 +0800 Subject: [PATCH] 1 --- SUMMARY.md | 2 +- book.json | 28 +++++++++++++++++----------- images/prev.png | Bin 0 -> 409 bytes install.md | 4 ++-- platform.md | 80 ++++---------------------------------------------------------------------------- stat_pay.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 136 insertions(+), 90 deletions(-) create mode 100644 images/prev.png create mode 100644 stat_pay.md diff --git a/SUMMARY.md b/SUMMARY.md index 6f483c4..5f8447c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -10,12 +10,12 @@ * [统计模块](stat.md) * [启动注册打点️](stat_active.md) * [关卡分析打点️️](stat_level.md) + * [支付结果打点](stat_pay.md) * [自定义事件打点](stat_event.md) * [交叉推广位](stat_ads.md) * [分享视频模块](share.md) * [配置参数模块️](online.md) * [多平台接口模块](platform.md) - * [支付打点](platform.md#logpay) * [打开客服消息](platform.md#service) * [检测自动更新](platform.md#checkUpdate) * [复制文本内容](platform.md#copy) diff --git a/book.json b/book.json index 5054dde..e4d88e2 100644 --- a/book.json +++ b/book.json @@ -12,27 +12,21 @@ "-sharing", "-highlight", "-livereload", + "emphasize", "simple-page-toc@^0.1.1", "prism", "prism-themes", "include-codeblock@^3.0.2", - "katex@^1.1.3", "splitter@^0.0.8", - "mermaid-gb3@2.1.0", "tbfed-pagefooter@^0.0.1", "expandable-chapters-small@^0.1.7", "sectionx@^3.1.0", "local-video@^1.0.1", - "favicon@^0.0.2", + "anchor-navigation-ex", "todo@^0.1.3", - "terminal@^0.3.2", - "alerts@^0.2.0", - "include-csv@^0.1.0", - "puml@^1.0.1", - "musicxml@^1.0.2", - "graph@^0.1.0", - "chart@^0.2.0", - "popup" + "popup", + "lightbox", + "copy-code-button" ], "structure": { "readme": "README.md" @@ -45,6 +39,18 @@ "css": [ "prism-themes/themes/prism-base16-ateliersulphurpool.light.css" ] + }, + "anchor-navigation-ex": { + "associatedWithSummary": false, + "showLevel": true, + "multipleH1": true, + "mode": "float", + "pageTop": { + "showLevelIcon": false, + "level1Icon": "fa fa-hand-o-right", + "level2Icon": "fa fa-hand-o-right", + "level3Icon": "fa fa-hand-o-right" + } } } } \ No newline at end of file diff --git a/images/prev.png b/images/prev.png new file mode 100644 index 0000000..74da324 Binary files /dev/null and b/images/prev.png differ diff --git a/install.md b/install.md index 389ae8d..915d4e6 100644 --- a/install.md +++ b/install.md @@ -183,9 +183,9 @@ 12. **Secret:必填,游戏 Secret Key,请联系运营人员提供** -13. **MidasPay( object ):**米大水虚拟支付配置,没有接入微信的米大师支付,请注意下面规则 +13. **MidasPay( object ):**米大师虚拟支付配置,请注意下面规则 - OfferId:在米大师申请的应用id,没有接入米大师,默认为"0" + OfferId:在米大师申请的应用id,没有接入米大师(比如第三方支付),默认为"0" ZoneId:分区ID,默认:"1" diff --git a/platform.md b/platform.md index bd6ba6e..65ab0ba 100644 --- a/platform.md +++ b/platform.md @@ -8,7 +8,6 @@ #### **此模块是参照微信小游戏提供的api进行封装的公用方法,提供了以下游戏中常用到的功能:** -1. **支付打点:logPay** (此模块保留logPay调用只是为了兼容已经接入的游戏,该api已经归类到【统计模块】下面的[支付打点](stat_pay.md)栏)。 2. **打开客服消息:openCustomerServiceConversation** 整理来自[wx.openCustomerServiceConversation](https://developers.weixin.qq.com/minigame/dev/api/open-api/customer-message/wx.openCustomerServiceConversation.html) 3. **检测版本更新:checkUpdate** 整理来自:[wx.getUpdateManager](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html) @@ -26,7 +25,6 @@ | **名称** | **功能说明** | | ------------------------ | ------------------------------------------------------------ | -| PCSDK.platform.logPay | 支付统计打点,支付完成(取消、成功、失败)的打点 | | PCSDK.platform.openCustomerServiceConversation | 进入客服会话,可打开一个普通的客服会话,也可打开客服会话发送体力、钻石和进入跳转充值等,[具体用法请看](platform.md#service)| | PCSDK.platform.checkUpdate | 检测版本是否有更新,如果版本更新会弹出确认框 | | PCSDK.platform.copy | 设置系统剪贴板的内容。微信小游戏调用成功后,会弹出 toast 提示"内容已复制",持续 1.5s | @@ -43,78 +41,8 @@ -
-1. **logPay** - - ```javascript - PCSDK.platform.logPay( params: object ): void - ``` - - 定义:开发者游戏充值完成后,上报支付结果打点,支付结果类型:0(支付失败),1(支付成功),-1(取消支付)。该api需在[config.js中配置MidasPay](install.md#configJs)信息。 - - 参数: - - ``` - params object 必传 打点参数 - { - type: number 必传 支付类型:0(支付失败),1(支付成功),-1(取消支付); - source: string 必传 游戏服务商生成的订单号,没有则为空字符串 - amount: number 必传 实际支付金额,单位分 - buy_id: string | number; 必传 商品ID - buy_name: string; 必传 商品名称 - item_info: string 必传 获得的道具内容:道具id及数量,逗号分隔,多项使用分号分隔 => 1,1;2,10;3,100 - } - ``` - 返回值: - - ``` - void - 无 - ``` - - 示例:客户端游戏支付完成后上报支付打点,下例只是演示logPay用法 - - ```javascript - private reqPay() { - Api.I.pay().then( ret => { - switch(ret.code){ - case 1: // 支付成功回调处理 - PCSDK.platform.logPay({ - type: 1, // 成功支付 - source: "10000400", // 订单号,没有则为空字符串 - amount: 10 * 100, // 10元 - buy_id: 58, // 支付的商品id - buy_name: "钻石*152,金币*188888888", - item_info: "40,152;90,188888888" // 例如 钻石id:40 金币id:90 - }); - break; - - case 0: // 支付失败回调处理 - PCSDK.platform.logPay({ - type: 0, // 失败支付 - source: "10000400", // 订单号,没有则为空字符串 - amount: 10 * 100, // 10元 - buy_id: 58, // 支付的商品id - buy_name: "钻石*152,金币*188888888", - item_info: "40,152;90,188888888" // 例如 钻石id:40 金币id:90 - }); - break; - - case -1: // 支付取消回调处理 - PCSDK.platform.logPay({ - type: -1, // 取消支付 - source: "10000400", // 订单号,没有则为空字符串 - amount: 10 * 100, // 10元 - buy_id: 58, // 支付的商品id - buy_name: "钻石*152,金币*188888888", - item_info: "40,152;90,188888888" // 例如 钻石id:40 金币id:90 - }); - break; - } - }); - } - ```
+ 2. **openCustomerServiceConversation** ```javascript @@ -366,12 +294,12 @@ ``` 定义:使手机发生较短时间的振动(15 ms)。仅在 iPhone 7 / 7 Plus 以上及 Android 机型生效 参数: - + ```javascript 无 -``` + ``` 示例: - + ```javascript PCSDK.platform.vibrateShort(); diff --git a/stat_pay.md b/stat_pay.md new file mode 100644 index 0000000..f7c8ff0 --- /dev/null +++ b/stat_pay.md @@ -0,0 +1,112 @@ +# 支付结果打点 + +------ + +#### **简介** + +支付上报,是开发者使用米大师或者第三方其他支付(比如H5支付),支付回调后把支付结果(失败支付、成功支付、取消支付)上报到后台。 + +#### **注意事项** + +{% em %} 使用api,需在[config.js中配置MidasPay](install.md#configJs)信息。 {% endem %} + +**MidasPay( object )配置:**米大师虚拟支付配置,请注意下面规则 + + OfferId:在米大师申请的应用id,没有接入米大师,默认为"0" + + ZoneId:分区ID,默认:"1" + + Mode:支付的类型,不同的支付类型有各自额外要传的附加参数,默认:"game" + + CurrencyType:币种,默认:"CNY" + + Platform:申请接入时的平台,platform与OfferId(米大师申请的应用id)有关。 + + 1)接入了米大师,填写"android"(ios暂时没有开放) + + 2)未接入米大师,使用其他支付,如果只支持android,则填写"android"; + + 3)未接入米大师,使用其他支付,如果只支持ios,则填写"ios"; + + 4)未接入米大师,使用其他支付,如果支持ios和android,则填写为"",sdk会根据手机识别android还是ios + + + +#### **接入API:** + +| **名称** | **功能说明** | +| ------------------------ | ------------------------------------------------------------ | +| PCSDK.stat.logPay | 开发者游戏充值完成后,上报支付结果打点,支付结果类型:0(支付失败),1(支付成功),-1(取消支付) | + + +1. **logPay** + + ```javascript + PCSDK.stat.logPay( params: object ): void + ``` + + 定义:开发者游戏充值完成后,上报支付结果打点,支付结果类型:0(支付失败),1(支付成功),-1(取消支付)。该api需在[config.js中配置MidasPay](install.md#configJs)信息。 + + 参数: + + ``` + params object 必传 打点参数 + { + type: number 必传 支付类型:0(支付失败),1(支付成功),-1(取消支付); + source: string 必传 游戏服务商生成的订单号,没有则为空字符串 + amount: number 必传 实际支付金额,单位分 + buy_id: string | number; 必传 商品ID + buy_name: string; 必传 商品名称 + item_info: string 必传 获得的道具内容:道具id及数量,逗号分隔,多项使用分号分隔 => 1,1;2,10;3,100 + } + ``` + 返回值: + + ``` + void + 无 + ``` + + 示例:客户端游戏支付完成后上报支付打点,下例只是演示logPay用法 + + ```javascript + private reqPay() { + // 模拟的支付,开发者需更加实际接入支付 + Api.I.pay().then( ret => { + switch(ret.code){ + case 1: // 支付成功回调处理 + PCSDK.stat.logPay({ + type: 1, // 成功支付 + source: "10000400", // 订单号,没有则为空字符串 + amount: 10 * 100, // 10元 + buy_id: 58, // 支付的商品id + buy_name: "钻石*152,金币*188888888", + item_info: "40,152;90,188888888" // 例如 钻石id:40 金币id:90 + }); + break; + + case 0: // 支付失败回调处理 + PCSDK.stat.logPay({ + type: 0, // 失败支付 + source: "10000400", // 订单号,没有则为空字符串 + amount: 10 * 100, // 10元 + buy_id: 58, // 支付的商品id + buy_name: "钻石*152,金币*188888888", + item_info: "40,152;90,188888888" // 例如 钻石id:40 金币id:90 + }); + break; + + case -1: // 支付取消回调处理 + PCSDK.stat.logPay({ + type: -1, // 取消支付 + source: "10000400", // 订单号,没有则为空字符串 + amount: 10 * 100, // 10元 + buy_id: 58, // 支付的商品id + buy_name: "钻石*152,金币*188888888", + item_info: "40,152;90,188888888" // 例如 钻石id:40 金币id:90 + }); + break; + } + }); + } + ``` \ No newline at end of file -- libgit2 0.21.0