海外PC端游戏接入文档 -- 微端
一、版本
当前微端版本 : 1.0.0
二、微端功能
- 下载游戏zip包;
- 解压游戏zip包;
- 创建游戏启动快捷方式;
- 首次下载游戏zip包会自动启动游戏;
- 游戏强制更新时启动微端执行;
- 传递广告唯一标识;
- 广告数据上报;
- 微端提供:游戏英文名+Setup.exe(例:IdleAnglesSetup.exe)的执行文件,游戏开发需放置在游戏zip包解压后的目录中;
三、游戏端与微端交互配置
1. 微端创建游戏部分配置
- 微端生成游戏所需的配置文件:downstore.ini;
- 配置文件所处目录:游戏解压后的根目录(例:../hxbb/downstore.ini);
- 配置文件downstore.ini中包含的配置内容如下:
提示
[main]
uuid=1E006E81-553A-11CB-8751-DA54AE0AB44F
gclid=werwerwerwe_234234gxfgdgdfdfgdfgfdg
- 配置文件字段说明:
提示
uuid:使用主板UUID作为windows用户唯一标识;
gclid:谷歌广告gclid用户ID;
2. 游戏端处理
- 游戏需要从downstore.ini中获取uuid及gclid,以便在后续的业务处理中使用到;
- 游戏启动后如检测到需要更新版本,游戏需要启动微端(游戏英文名+Setup.exe),并传递参数 "gamestart"(例:../游戏英文名+Setup.exe gamestart);
- 游戏启动微端之前需先行检测一下微端(游戏英文名+Setup.exe)是否存在 如果不存在 把游戏当前目录中的微端(游戏英文名+Setup.exe) 复制到上一层目录】
- 数数科技的数据由游戏自行上报;
- Google Ads数据由游戏通过本文档中的接口文档中部分按要求进行上报;
四、关于游戏端充值链接的配置【游戏端调用】
警告
此部份内容仅为海外PC端游戏中拉起充值场景使用
1. 官网网址
不同的游戏主体选择不同的充值跳转地址
NEOJOY,NEORIGIN 官网:https://www.neorigin.com/
MUJOY 官网:https://www.mujoy.sg/
2. 充值链接示例
测试环境:
NEOJOY,NEORIGIN => http://pre-gw.m-co.cn/recharge/?role_id=1111&game_id=3&game_name=幻想宝贝&isclient=1
MUJOY => http://pre-mujoy.m-co.cn/recharge/?role_id=1111&game_id=3&game_name=幻想宝贝&isclient=1正式环境:
NEOJOY,NEORIGIN => https://www.neorigin.com/recharge/?role_id=1111&game_id=3&game_name=幻想宝贝&isclient=1
MUJOY => https://www.mujoy.sg/recharge/?role_id=1111&game_id=3&game_name=幻想宝贝&isclient=1
3. 充值链接 - 参数说明
网页充值game_id配置
环境 游戏 game_id 测试环境 幻想宝贝国际服-PC 3 测试环境 幻想宝贝韩国服-PC 3 正式环境 幻想宝贝国际服-PC 6 正式环境 幻想宝贝韩国服-PC 1
参数名 类型 是否必填 备注 role_id string 必填 角色 id(游戏内的角色id) game_id number 必填 游戏 id【网页充值game_id配置】(发行后台-游戏管理配置的编号id)
预发布地址:http://pre-faxing.miaoju.cn/overseasgw/overseasgwgame
正式地址:https://admin-faxing.miaoju.cn/overseasgw/overseasgwgamegame_name string 必填 游戏名称(这个用于 GA 上服数据统计分析 ) isclient number 必填 此值固定填 1,(不填或填写其它,页面将不自动刷新商品)
五、数据上报场景使用的接口文档【游戏端调用】
提示
测试环境:
http://pre-api-sypc.metajoygames.com/v1.0
正式环境:
Metajoy: https://api-sypc.metajoygames.com/v1.0
Neojoy: https://api-sypc.neojoygames.co.kr/v1.0
Mujoy: https://api-sypc.mujoy.sg/v1.0
Neorigin: https://api-sypc.neorigin.com/v1.0
数据上报game_id配置
环境 游戏 game_id 测试环境 幻想宝贝国际服-PC 124 测试环境 幻想宝贝韩国服-PC 125 正式环境 幻想宝贝国际服-PC 133 正式环境 幻想宝贝韩国服-PC 134
1. GA数据接收 [POST /gads]
Parameters (Request)
- game_id (number) - 游戏ID,必填。以运营人员提供的为准或参考【数据上报game_id配置】
- gclid (string) - 广告用户唯一ID,必填;
- type (string) - Google Ads数据上报类型,必填。以运营人员提供的为准;
- currency (string) - 币种,选填,默认为:USD;
- value (string) - 金额, 选项,默认为0;
- time (number) - 当前时间戳:单位秒,例:1678935520,必填;
- os (string) - 当前运行所在系统标识;例:windows10,选填;
- device_id (string) - 运行所在设备的唯一标识或游戏用户唯一标识,选填;
- ip (string) - IP,选填;
Response 200 (application/json)
Body
{
"error": 0, //请求状态码:0成功
"msg": "success",//状态码说明
"data":{}
}