游戏方需要对接的参数-1.0.0
<p>[TOC]</p>
<h1>待确认信息</h1>
<h2>产品</h2>
<p>1、数据埋点:建议直接使用友盟数据。
2、确认SourceAppID字段:来源应用ID,全都上报游戏本身的应用。
3、确认SourceAppVersion字段:来源应用版本。
4、本次投放的H5游戏客服投放的是全平台:单包(Android)、合集包(ios和Android)、平台包(ios和Android)。
但是目前和游戏方确认沟通的结果是:对外没有投放单包,所以只涉及到合集包和平台包,这里需要再确认下。
5、经和游戏方确认得到不用考虑的情况:</p>
<img src="http://doc.uc108.org:8002/server/../Public/Uploads/2019-08-28/5d663dbc8bf68.png" width="500px">
<h2>引擎</h2>
<p>1、确认接口涉及到的以下截图【一定为空】的信息是否可以获取得到:<a href="http://yapi.tcy365.org:3000/project/534/interface/api/5444">http://yapi.tcy365.org:3000/project/534/interface/api/5444</a> 这个接口对应的数据:</p>
<img src="http://doc.uc108.org:8002/server/../Public/Uploads/2019-08-28/5d6638c95d3df.png" width="500px">
<p>yApi访客账户:账号 test@ct108.com ,密码 test
yApi:<a href="http://yapi.tcy365.org:3000/project/534/interface/api">http://yapi.tcy365.org:3000/project/534/interface/api</a>
yApi:系统研发 FD_M_CtServiceMessageBoardApi
2、确认SourceChannelID字段:来源渠道ID,对应到产品文档就是渠道号,全都上报游戏本身的渠道id,不要平台/合集的渠道id。来源引擎config文件。
3、确认是否支持图片上传的功能的调用方式。
4、确认SourceChannelType字段:来源渠道类型,目前需要区分 1:平台包游戏 2:单包游戏 3:合集包游戏;已经区分的不同包的value值提供到H5这边。</p>
<h1>对接信息</h1>
<h2>1 需要提供的参数</h2>
<h3>1.1 URL上需要携带参数</h3>
<p><em>这里需要由引擎在URL上拼接对应的参数</em></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">UserID</td>
<td style="text-align: left;">用户id</td>
</tr>
<tr>
<td style="text-align: left;">AccessToken</td>
<td style="text-align: left;">accesstoken</td>
</tr>
<tr>
<td style="text-align: left;">Os</td>
<td style="text-align: left;">操作系统:1 安卓,2 苹果</td>
</tr>
<tr>
<td style="text-align: left;">SourceChannelType</td>
<td style="text-align: left;">(游戏方-彭士勇)来源渠道类型(全都上报游戏本身的渠道类型,不要平台/合集的渠道类型):<br/>1:同城游APP/合集反馈;<br/>2:单包游戏中反馈时;<br/>3:平台包游戏/合集包游戏中的游戏反馈时<br/><br/>等同于<br/> 1:平台包游戏;<br/> 2:单包游戏;<br/> 3:合集包游戏;</td>
</tr>
<tr>
<td style="text-align: left;">SourceChannelID</td>
<td style="text-align: left;">(引擎config文件-阿福) 来源渠道ID (对应到产品文档就是渠道号,全都上报游戏本身的渠道id,不要平台/合集的渠道id)</td>
</tr>
<tr>
<td style="text-align: left;">SourceAppID</td>
<td style="text-align: left;">(产品确认-青青) 来源应用ID(全都上报游戏本身的应用)</td>
</tr>
<tr>
<td style="text-align: left;">SourceAppVersion</td>
<td style="text-align: left;">(产品确认-青青)来源应用版本</td>
</tr>
<tr>
<td style="text-align: left;">ext</td>
<td style="text-align: left;">&ext=(以ext这个参数为结尾符</td>
<td></td>
</tr>
</tbody>
</table>
<p>特别说明:
(1)如果用户未登录,则userID=0和accessToken为空。
(2)<code>疑惑点</code> 图片上传的功能是否可以根据 SourceAppVersion(来源应用版本)来确定上传图片的功能是否可用? -- 待确认(引擎+游戏方)
(3)<code>疑惑点</code> 引擎0724版本升级后才能获取到以下对应的参数,之前的老的版本的直接为空处理?关于引擎0724对应的Android 和 iOS 的版本具体值是多少?</p>
<img src="http://doc.uc108.org:8002/server/../Public/Uploads/2019-08-28/5d6612982bad1.png" width="500px">
<p>AppID(应用ID)=== SourceAppID(来源应用ID)
getTcyVersion(同城游版本) === SourceAppVersion(来源应用版本)
getAppName(应用名称)=== AppName(应用名称)
AppCode(应用缩写)=== AppCode(应用缩写)</p>
<p><br/></p>
<h3>1.2 设备信息参数</h3>
<p><em>js需要通过方法与引擎对接获取</em></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">WifiID</td>
</tr>
<tr>
<td style="text-align: left;">SystemID</td>
</tr>
<tr>
<td style="text-align: left;">ImeiID</td>
</tr>
<tr>
<td style="text-align: left;">ImsiID</td>
</tr>
<tr>
<td style="text-align: left;">SimSerialNO</td>
<td style="text-align: left;"></td>
</tr>
</tbody>
</table>
<p>特别说明:
(1)<code>疑惑点</code>:这些数据的话,是不区分引擎的版本,新旧版本都能提供的数据吧?--已解决(可能为空,必须有一个不为空)</p>
<p><br/></p>
<h3>2.2 入口应用信息参数</h3>
<p><em>js需要通过方法与引擎对接获取</em>
-待确认,阿福确认 value值
根据url上的sourceChannelType(来源渠道类型)不同,对应的res值不同:</p>
<ul>
<li>sourceChannelType=0:同城游APP/合集反馈,入口应用为空;</li>
<li>sourceChannelType=1:单包游戏中反馈时,<br/>
<img src="http://doc.uc108.org:8002/server/../Public/Uploads/2019-08-26/5d63a4fcb7025.png" width="500px"></li>
<li>sourceChannelType=2:平台包游戏/合集包游戏中的游戏反馈时,<br/>
<img src="http://doc.uc108.org:8002/server/../Public/Uploads/2019-08-26/5d63a50a5c24c.png" width="500px"></li>
</ul>
<pre><code>// sourceChannelType=0:同城游APP/合集反馈, res对应的格式是:
var res = null;</code></pre>
<pre><code>//sourceChannelType=1:单包游戏中反馈时, res对应的格式是:
var res = {
SourceAppID: "1880221", // 游戏的应用id (必填)
AppCode: "mgda", // 应用缩写(必填)
AppName: "打大A", // 名称(必填)
SourceAppVersion: "2.0.20190101" // 版本号(必填)
};</code></pre>
<pre><code>// sourceChannelType=2:平台包游戏/合集包游戏中的游戏反馈时,res对应的格式是:
var res = {
SourceAppID: "3001", // 合集/同城游App的应用id(必填)
AppCode: "tcyapp", // 应用缩写(必填)
AppName: "同城游", // 名称(必填)
SourceAppVersion: "5.6.20180101" // 版本号(非必填,游戏方获取不到则该值为空)
};</code></pre>
<p><br/><br/></p>
<hr />
<p><br/><br/></p>
<h2>2 与游戏方对接的内容</h2>
<h3>2.1 JS可以调用的接口(所有参数需要encodeURI)</h3>
<p>接口:exit
描述:H5游戏退出
用法:lua://exit
<br/></p>
<p>接口:refresh
描述:H5游戏刷新
用法:lua://refresh
<br/></p>
<p>接口:uploadImg
描述:打开相册上传图片
用法:lua://uploadImg
<br/></p>
<h3>2.2 JS需要实现的接口</h3>
<p>接口:onPauseCallback()
描述:通知JS切到后台
<br/></p>
<p>接口:onResumeCallback()
描述:通知JS切到前台
<br/></p>
<p>接口:onLuaIsLogin()
描述:判断是否登录,得到一个布尔值,true表示已登录,false表示未登录。</p>
<pre><code>var isLogin = onLuaIsLogin(); </code></pre>
<p><br/><br/></p>
<p>接口:onLuaShowImg (r)
描述:上传图片后得到图片的路径,r为一个JSON字符串对象</p>
<pre><code>function onLuaShowImg (r){
var res = JSON.parse(r); // !!!需要解析为JSON对象
console.log(res);
}</code></pre>
<pre><code> res对应的参数的说明:Code=1上传成功、Code=2上传失败</code></pre>
<pre><code>// Code: 1上传成功;
var res = {
Code: 1,
Data: {
ImgUrl: '''' // ImgUrl为图片地址
},
Msg: ''''
};</code></pre>
<pre><code>// Code: 2上传失败;
var res = {
Code: 2,
Data: null,
Msg: ''''
};</code></pre>
<p><br/><br/></p>
<p>接口:onLuaDeviceInfo (r)
描述:得到设备的信息,r为一个JSON字符串对象</p>
<pre><code>function onLuaDeviceInfo (r){
var res = JSON.parse(r); // !!!需要解析为JSON对象
console.log(res);
}</code></pre>
<pre><code>// res对应的格式是:
var res = {
WifiID: "",
SystemID: "",
ImeiID: "",
ImsiID: "",
SimSerialNO: ""
};</code></pre>
<p><br/><br/></p>
<p>接口:onLuaEntryInfo (r)
描述:得到入口应用信息,r为一个JSON字符串对象,根据url上的sourceChannelType(来源类型)不同,对应的r的值不同:</p>
<ul>
<li>sourceChannelType=0:同城游APP/合集反馈,入口应用为空;</li>
<li>sourceChannelType=1:单包游戏中反馈时,<br/>
<img src="http://doc.uc108.org:8002/server/../Public/Uploads/2019-08-26/5d63a4fcb7025.png" width="500px"></li>
<li>sourceChannelType=2:平台包游戏/合集包游戏中的游戏反馈时,<br/>
<img src="http://doc.uc108.org:8002/server/../Public/Uploads/2019-08-26/5d63a50a5c24c.png" width="500px"></li>
</ul>
<pre><code>function onLuaEntryApp (r){
var res = JSON.parse(r); // !!!需要解析为JSON对象
console.log(res);
}</code></pre>
<pre><code>// sourceChannelType=0:同城游APP/合集反馈, res对应的格式是:
var res = null;</code></pre>
<pre><code>//sourceChannelType=1:单包游戏中反馈时, res对应的格式是:
var res = {
SourceAppID: "1880221", // 游戏的应用id (必填)
AppCode: "mgda", // 应用缩写(必填)
AppName: "打大A", // 名称(必填)
SourceAppVersion: "2.0.20190101" // 版本号(必填)
};</code></pre>
<pre><code>// sourceChannelType=2:平台包游戏/合集包游戏中的游戏反馈时,res对应的格式是:
var res = {
SourceAppID: "3001", // 合集/同城游App的应用id(必填)
AppCode: "tcyapp", // 应用缩写(必填)
AppName: "同城游", // 名称(必填)
SourceAppVersion: "5.6.20180101" // 版本号(非必填,游戏方获取不到则该值为空)
};</code></pre>