小游戏 UnitySDK接入文档

1 接入指南

1.1 获取配置文件

接入前，需要由掌趣项目负责人完成渠道申报并在掌趣后台进行配置，从而获取到该游戏的渠道参数、掌趣配置文件。

1.2 添加掌趣SDK

将掌趣SDK添加到Assets目录下，如下图：

掌趣SDK主要由以下几部分构成
[1] Assets/OurpalmSDK 掌趣封装DLL库
[2] Assets/Resources 掌趣后台获取的掌趣配置文件

2 初始化

2.1 更新接口

功能说明
执行sdk的相关业务功能

接口示例

    void Update()
    {
        OPGameSDK.Update(this, System.DateTime.Now);
    }

2.2 初始化接口

功能说明
初始化第三方SDK，同时获取SDK所需要的初始化数据

接口定义

void Ourpalm_Init(string jsonParams);

参数说明

接口示例

//初始化回调函数
    private static void Ourpalm_GameEntryCallback(string methodName, string param)
    {
        if (methodName.Equals("Callback_Ourpalm_Init"))
        {
            //初始化回调
        }
    }

        OPGameSDK.SetGameEngineMessageListener(Ourpalm_GameEntryCallback);
        Ourpalm_WebGL.Ourpalm_SetLogs(1);
        Hashtable initParams = new Hashtable();
        initParams["gameVer"] = "1.0"; // 必传
        initParams["gameResVer"] = "1.0"; // 必传
        OPGameSDK.Ourpalm_Init(MiniJSON.jsonEncode(initParams), channel);

2.3 获取渠道信息接口

功能说明
获取当前SDK渠道信息。
(1)获取产品ID
功能说明
获取当前游戏包中的产品ID，对应dev后台的产品ID,例如：20000078 。

OPGameSDK.Ourpalm_GetProductId()

(2)获取联运方ID
功能说明
获取当前游戏包中的联运方ID，对应dev后台渠道ID,例如：微信小游戏渠道：31144100000。

OPGameSDK.Ourpalm_GetJointOperationId()

(3)获取主渠道ID
功能说明
获取当前游戏包中的主渠道ID，对应dev后台主渠道ID,例如：微信小游戏主渠道：31144100 。

OPGameSDK.Ourpalm_GetMainChannelId()

(4)获取子渠道ID
功能说明
获取当前游戏包中的子渠道ID，对应dev后台子渠道ID,例如：微信小游戏子渠道：31144100。

OPGameSDK.Ourpalm_GetSubChannelId()

(5)获取平台ID
功能说明
获取当前游戏包中的平台id，0:android 1:ios 2:pc 6:h5 8:鸿蒙。

OPGameSDK.Ourpalm_GetPlatformId()

(6)获取业务ID
功能说明
获取当前游戏包中的ServiceId

OPGameSDK.Ourpalm_GetServiceId();

(7)获取渠道ID
功能说明
获取当前游戏包内打入的推广渠道ID

OPGameSDK.Ourpalm_GetChannelId();

(8)获取渠道名称
功能说明
获取当前游戏包中的推广渠道名称

OPGameSDK.Ourpalm_GetChannelName();

(9)获取机型组ID
功能说明
获取当前游戏包内打入的机型组ID

OPGameSDK.Ourpalm_GetDeviceGroupId();

(10)获取语言ID
功能说明
获取当前游戏包内打入的语言ID

OPGameSDK.Ourpalm_GetLocaleId();

3 登录功能

3.1 登录流程

1.手机游戏客户端会调用掌趣sdk进行sdk初始化操作
2.掌趣sdk向掌趣用户中心服务器发起登录/注册的请求
3.掌趣用户中心服务器向掌趣sdk返回token、用户信息等等
4.掌趣sdk向返回游戏客户端登录结果和用户信息
5.游戏客户端上传用户信息到游戏服务器
6.服务器根据token向掌趣用户中心服务器获取用户信息
7.掌趣用户中心服务器向游戏服务器返回用户信息
8.游戏服务器向游戏客户端返回登录结果

3.2 登录接口

功能说明
登录掌趣用户中心。游戏客户端调用登录接口（RegisterLogin）前，需要通过设置登录回调接口（RegisterLoginCallBack）将回调函数指针传给SDK，登录成功后，掌趣SDK会通过回调函数通知游戏客户端。

接口定义

void Ourpalm_Login();

接口示例

void Ourpalm_GameEntryCallback(string methodName,string param)
{
    if (strcmp(methodName, "Callback_Ourpalm_Login") == 0) {
        //登录回调
    }
}
//登录接口
Ourpalm_Login();

返回的JSON数据格式说明
登录成功时

{
    "userId":"掌趣平台分配的用户唯一id，区分大小写",
    "tokenId":"掌趣分配的tokenId",
}

登录失败时

{
    "desc":"失败描述",
    "reset":"状态码","status":"1"
}

注意：
1.返回失败时，SDK会弹出提示框！对于请求超时（状态码为101），不会弹出提示框，游戏可自动重新连接或自己添加提示框。
2.用户ID区分大小写，相同字母和数字、大小写不同的用户ID代表的是两个不同的用户账号。因此，游戏在使用和存储掌趣用户ID时，务必要严格区分大小写，以免造成游戏内账号和角色的混乱等问题。
3.如果游戏有自己的用户ID，必须和掌趣用户中心的用户ID一一对应，不得出现一对多或者多对一的情况。也不得根据其他条件，组合生成新的用户ID，否则将会出现账号丢失的情况。

3.3 设置角色信息

功能说明
当游戏角色注册（登录）成功时设置游戏角色注册（登录）信息。

注：
1、游戏角色注册成功后，调用该接口设置角色注册信息。
2、游戏角色登录成功后，调用该接口设置角色登录信息，否则无法计费。

接口定义

void Ourpalm_SetGameInfo(int type,string jsonParams);

接口定义

接口示例

    Json::Value gameInfo;
    gameInfo["roleID"] = "123";                                 //角色id
    gameInfo["roleName"] = gameRoleName;         //角色名
    gameInfo["serverID"] = "9999";                  //游戏服id
    gameInfo["gameServerName"] = "s1";                //游戏服名称
    gameInfo["rolelv"] = "1";                                  //角色等级
    gameInfo["roleviplv"] = "1";                            //角色vip等级
    Json::FastWriter fast_writer;
    string jsonParams = fast_writer.write(gameInfo);
    //角色注册
    OPGameSDK.Ourpalm_SetGameInfo(1, jsonParams);
    //角色登录
    OPGameSDK.Ourpalm_SetGameInfo(2, jsonParams);

4 支付功能

4.1 支付流程

1.掌趣sdk向掌趣计费服务器发起支付请求
2.掌趣计费服务器生成订单号，并向sdk返回支付结果
3.掌趣计费服务器通知游戏服务器发货
4.游戏服务器发送虚拟物品至玩家手机游戏客户端
5.游戏服务器向计费服务器返回发货结果

4.2 支付接口

功能说明
游戏客户端通过调用计费接口，实现游戏中的道具购买。

接口定义

void Ourpalm_Pay(string propId, string chargeCash, string currencyType, string propName,string propCount, string propDes, string Gameurl, string jsonExtendParams);

参数说明

接口示例

void Ourpalm_GameEntryCallback(string methodName,string param)
{
    if (strcmp(methodName, "Callback_Ourpalm_Pay") == 0) {
        //支付回调
    }
}
void OPSDK::pay()
{
    //消耗性
    string propId = "com.fingerfun.coc.ios.diamond_1";
    string chargeCash = "99";
    string currencyType = "2";
    string propName = "Handful of Diamonds";
    string propCount = "1";
    string propDes = "Handful of Diamonds";
    string Gameurl = "http://pay.gamebean.net/OurPalm_Pay_Accept/ResponseDeliver?ssid=2013030715493703719999";
    Hashtable extendParams = new Hashtable();
    extendParams["Params"] = "Params";//游戏自定义参数，选填，透传参数
    extendParams["serverID"] = "9999";//游戏服ID，必填
    extendParams["roleID"] = "1000000";//角色ID，必填
    extendParams["rolelv"] = "rolelv";//角色等级
    extendParams["roleviplv"] = "roleviplv";//角色VIP等级
    extendParams["roleName"] = "roleName";//角色名称
    extendParams["gameServerName"] = "gameServerName";//游戏服名称
    Hashtable purchaseInfo = new Hashtable();
    purchaseInfo["package_id"] = "礼包ID";
    purchaseInfo["order_funnel_id "] = "研发生成的付费会话唯一id";
    purchaseInfo["dev_order_id "] = "研发订单号id";
    extendParams["purchaseInfo"] = purchaseInfo;//选填
    string jsonExtendParams= ToolsUtils.MiniJSON.jsonEncode(extendParams);
    Ourpalm_Pay(propId, chargeCash, currencyType, propName, propCount, propDes, Gameurl, jsonExtendParams);
}

数据示例：

{
    "channelOrderId": "2000000399537533",//第三方订单号
    "code": "200",    //购买成功
    "desc": "",
    "pdid": "buy1",    //商品id
    "ssId": "",
    "success": "1"
}

5 统计和打点日志

5.1 游戏打点日志接口

此接口用于发送游戏自定义日志,以及广告统计打点日志

函数原型

void Ourpalm_SendGameInfoLog(string logID, string logKey, string json);

函数原型

注意事项

- 这些参数值和结构，由平台定义，研发需按平台要求的结构传。
- 注意1，确保启动游戏的时候正常调用了PCSDK初始化方法后，再调用发日志接口；启动游戏时调用的PCSDK初始化方法有别于安装时调用的方法，无须设置 disable_sdk_act_log 这个参数。
- 注意2，actId 为事件ID，只支持字母，数字，下划线命名，不支持中文。
- 注意3，actName 为事件名称，支持中文。
- 注意4，detail 为需要随本次发生事件一并记录的额外信息，可以是普通字符串，也可以是json字符串，不要包含竖线 | ，总长度不要超过 1000 个字符。

代码示例

    //发送游戏日志-->登陆场景加载成功
    Hashtable event_paras = new Hashtable();
    event_paras["roleLevel"] = "0";
    event_paras["roleVipLevel"] = "0";
    event_paras["actId"] = "LoginSceneLoaded";
    event_paras["actName"] = "登陆场景加载成功";
    event_paras["detail"] = "begin";
    string json= ToolsUtils.MiniJSON.jsonEncode(event_paras);
    OPGameSDK.Ourpalm_SendGameInfoLog("1003", "role-act", json);

logId和LogKey对应表

6 渠道接口

6.1 dana渠道接入

6.1.1 集成jssdk

(1)将WebGLAgent.jslib添加到Asstes/Plugins文件夹下
(2)html中添加渠道sdk

    <script src="https://sdk.mgant.com/dist/load/loader.js"></script>
    <script src="../libOPDanaSDK.js" type="text/javascript" charset="utf-8"></script>

(3)html中添加代码

    var gameUnityInstance=undefined;
    function getGameUnityInstance()
    {
        return gameUnityInstance;
    }

示例：

      var gameUnityInstance=undefined;
      function getGameUnityInstance()
      {
        return gameUnityInstance;
      }
      var script = document.createElement("script");
      script.src = loaderUrl;
      script.onload = () => {
        createUnityInstance(canvas, config, (progress) => {
          progressBarFull.style.width = 100 * progress + "%";
        }).then((unityInstance) => {
          gameUnityInstance = unityInstance;   //注意这里
          loadingBar.style.display = "none";
          fullscreenButton.onclick = () => {
            unityInstance.SetFullscreen(1);
          };
        }).catch((message) => {
          alert(message);
        });
      };

6.1.2 视频广告

    private static void Ourpalm_GameEntryCallback(string methodName, string param)
    {
        if (methodName.Equals("Callback_Mgant_showRewardAd"))
        {
            //视频广告回调
        }
    }
    public void ShowRewardAd()
    {
        Hashtable configTb = new Hashtable();
        configTb["scene"] = "revive";//场景标识：'unlock' / 'revive' / 'double_reward'
        string configJson = ToolsUtils.MiniJSON.jsonEncode(configTb);
        OPGameSDK.Ourpalm_Channel_Spreads("Mgant_showRewardAd", configJson);
    }

回调数据说明：

6.1.3 插屏广告

    private static void Ourpalm_GameEntryCallback(string methodName, string param)
    {
        if (methodName.Equals("Callback_Mgant_showInterstitialAd"))
        {
            //插屏广告回调
        }
    }
    public void ShowInterstitialAd()
    {
        Hashtable configTb = new Hashtable();
        configTb["scene"] = "level_start";
        string configJson = ToolsUtils.MiniJSON.jsonEncode(configTb);
        OPGameSDK.Ourpalm_Channel_Spreads("Mgant_showInterstitialAdd");
    }

回调数据说明：

7 其他功能接口

8 附录

8.1 客户端错误码

8.2 用户中心错误码

跳转查询

8.3 计费中心错误码

跳转查询

8.4 货币类型及对应ID

货币ID是没有限定位数的纯自增值，详情：货币类型详情列表