# 支付宝小游戏模块

# 1. 接入说明

# 1.1 谁来接入此文档

接入SDK的开发人员。

# 1.2 注意事项

# 1.3 接入步骤

# 1.3.1 导入Unity SDK 资源文件

导入SDK资源文件

# 1.3.2 添加宏定义

Unity工程的Player Settings中,配置 Scripting Define Symbols 添加 DH_MINIGAME_SDK;ALIPAY_MINIGAME_SDK

![添加DH_MINIGAME_SDK;ALIPAY_MINIGAME_SDK](/v2/assets/alipayminigame/alipay_img_2 .png)

# 1.3.3 导出支付宝小游戏工程

根据指引导出支付宝小游戏工程

导出支付宝小游戏工程

导出的微信小程序示例

![导出的支付宝小程序示例](/v2/assets/alipayminigame/alipay_img_4 .png)

# 1.3.4 添加电魂JS SDK

然后在支付宝小游戏工程中添加提供的电魂JS SDK脚本文件,可以放在game.js同级目录下

添加电魂JS SDK

# 1.3.5 在game.js中导入电魂JS SDK文件

示例如下,具体JS SDK 名称后缀版本号根据实际提供的JS SDK文件来决定

import DHMiniSDK from "./dh-mini-sdk-for-alipay-2.0.4";

添加结果如下

导入JS SDK结果

# 1.3.6 在game.js中的方法中添加代码

示例如下

window.DHMiniSDK = DHMiniSDK;

添加初始化代码

# 2. 功能调用

# 2.1 设置游戏参数

需要在游戏初始化,调用其他SDK接口前调用

string param = DHSDKHelper.DHJsonParam.Builder()
             .put("login", "https://dm-sdk-login-cn.dmtemp.com")       // 必传,登录服务接口地址
             .put("pay", "https://dm-hsdk-order-cn.dmtemp.com")     //必传,支付服务接口地址
             .put("log", "https://dm-ups-sdk-log-cn.dmtemp.com")      // 必传,数据上报服务接口地址
             .put("errorLog", "https://dm-ups-sdk-error-cn.dmtemp.com")        // 必传,日志上报服务接口地址
             .put("gameAppId", "12345678")     //必传,游戏在支付宝侧的 AppID;可登录《支付宝开放平台》后台,在"我的应用"列表中查看
             .put("appId", "12345678")     // 必传,小游戏的 AppID(于SDK平台注册小游戏时生成的ID)
             .put("packageName", "com.test.official")     // 必传,小游戏的应用包名
             .put("appVersion", "1.0.0")     // 必传,小游戏的版本号
             .put("channel", "1398")     // 必传,渠道ID
             .put("mainChannel", "100761")     // 必传,推广主渠道ID
             .put("secondChannel", "100762")                 //必传,推广次渠道ID
             .put("heartbeatEnable", "true")                 //选传,true,false是否开启心跳数据上报,若开启,则SDK将每隔一分钟向服务器发送一条心跳数据
             .put("gravityEngineAccessToken", "")     //选传,小游戏的引力引擎 Access Token(于引力引擎控制台创建产品时生成的Access Token)
             .put("gravityEngineDebug", "true")     //选传,显式开启或关闭引力引擎数据上报的调试模式,默认根据小游戏当前的体验环境自动设置,正式版下为 false,开发版或体验版下为 true;开启调试模式后,可以在引力控制台>设置>元数据>事件流中查看实
             .put("gravityEnginePayEventEnable", "false")     //选传,引力引擎付费事件是否采用客户端上报,默认采用(注意,若引力引擎付费事件上报采用服务端上报,请务必将此参数设为 false,并于SDK中台系统配置服务端上报相关参数,否则可能导致双端付费事件上报丢失或重复!!!)

             .toJson();
        
 DHSDKHelper.setHostPlatformParam(param);

# 2.2 初始化

SDK初始化接口,在游戏初始化,设置游戏参数接口调用后调用,必须初始化完毕,才能调用后续登录,支付等接口

初始化接口调用:

DHSDKHelper.init(mUnionSdkCallback);

在回调方法里面处理初始化结果:

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_INIT)
                {
                    // 初始化成功 返回调用  
                    Debug.Log("初始化成功");
                    
                }
            }
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_INIT)
                {

                    // 初始化失败调用  返回信息数据可能游戏接入方看不懂  打印log 反馈给sdk处理者即可  

                }
            }
        }

# 2.3 登录

用于执行SDK登录流程

注意:流程上要求需先执行SDK登录,再显示游戏服列表及"开始游戏"按钮,当玩家点击"开始游戏"后再触发后续游戏服登录及创角;如游戏本身并无游戏服列表选择界面或"开始游戏"按钮,此注意事项可忽略!

调用登录接口:

DHSDKHelper.login(mUnionSdkCallback);

登录回调:

        public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_LOGIN)
                {

                    /**  
                      登录成功后  返回调用  
                      json 数据格式
                      loginType: 用户授权登录类型
                      token:c73a482021af4888ba1ea66176ae56c7   
                      accountId:1381307270  账号id 
                      accountName:guest@1381307270  账号名
                      openId:   用户微信唯一标识(openId)
                      
                    */

                    Debug.Log("login:" + resultData);

                    //  sdk登录成功后 需要游戏服务端做校验 详细校验过程 请查看服务端文档登录校验说明
                    // 当前返回的是sdk测试环境的账号数据  如果游戏服务端去sdk服务端验证账号和token数据请到测试环境验证

                    var loginJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("loginJson:" + loginJson.ToString());

                    string logintype = loginJson["loginType"].ToString();
                    string Token = loginJson["token"].ToString();
                    uid = loginJson["accountId"].ToString();
                    uname = loginJson["accountName"].ToString();
var userExtraInfo = loginJson["userExtraInfo"];
                    string openId = userExtraInfo["openId"].ToString();

                }
            }
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_LOGIN)
                {
                    //登录失败
                }
            }
        }

# 2.4 获取用户信息

用于获取支付宝用户的个人信息,如昵称、头像等。

注意,一一般通过此服务获取支付宝用户的昵称、头像,用来作为玩家在游戏内的昵称、头像.

# 获取用户信息

如果用户已经授权过个人信息给小游戏,开发者可以把用户的个人信息记录在业务后台;但用户有可能修改昵称头像,为了保证个人信息不出现过期失效的情况,需要再次获取用户信息,可以调用本接口直接获取。

调用接口:

string param = DHSDKHelper.DHJsonParam.Builder()
  .toJson();
DHSDKHelper.getUserInfo(param, mUnionSdkCallback);

接口回调:

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_GET_USERINFO)
                {

                    /**  
                      获取用户信息成功后  返回调用  
具体用户信息可参考官方文档
https://opendocs.alipay.com/mini-game/08vab1
                    */

                    Debug.Log("user info:" + resultData);

                    var userInfoJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("userInfoJson:" + userInfoJson.ToString());

                }
            }
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_GET_USERINFO)
                {
                    //获取用户信息返回失败
                }
            }
        }

# 2.5 支付

支付宝小游戏提供虚拟充值的能力,用户可以在游戏内下单,进行游戏内道具的购买。本文主要对游戏内的支付能力进行简单概述说明。

虚拟支付 利用 my.requestGamePayment() 接口发起支付宝虚拟支付,并直接购买游戏内服务或道具,适用于 Android 及鸿蒙设备

虚拟币支付 利用 my.requestGamePayCoinPayment() 接口发起支付宝虚拟币支付,购买游戏内服务或道具,适用于 iOS 设备

游戏客户端在接入SDK支付接口时,无需关心用户所处的设备环境,SDK将在内部自行识别并选择相应的支付方式以发起支付。

调用接口:

DHSDKHelper.DHSDKPayInfo payInfo = new DHSDKHelper.DHSDKPayInfo();
payInfo.AreaId = "100"; //选传,游戏大区ID,若游戏无大区概念,可不填,默认值为 1,表示初始大区编号
payInfo.AreaName = "1"; //选传,游戏大区名称,若游戏无大区概念,可不填,默认值为 1
payInfo.RoleId = "1"; //选传,角色ID,若游戏无角色概念,可不填,默认值同 accountId 账号ID
payInfo.RoleName = "1"; //选传,角色昵称
payInfo.RoleLevel = "1"; //选传,角色等级,若游戏无角色及等级概念,可填关卡等级或不填,默认值为 1
payInfo.Rate = "10";  //必传,游戏币兑换汇率,用于计算游戏币购买数量;例如:后台配置为 1:10,则 rate 为 10,表示1人民币=10游戏币;可登录《抖音开放平台控制台》后台,进入“商业化 > 虚拟支付 > 支付设置 > 基础信息 > 货币汇率”栏目中查看
payInfo.ItemId = "123"; //必传,商品ID
payInfo.ItemName = "goods"; //必传,商品名称
payInfo.ItemNum = "1"; //选传,商品数量,默认值为 1
payInfo.ItemPrice = "600"; //必传,商品单价,单位为分,请注意换算!!!
payInfo.Currency = "CNY"; //选传,货币类型,默认为 CNY
payInfo.Memo = ""; //选传,透传参数
payInfo.Remark = ""; //选传,备用透传参数

DHSDKHelper.pay(payInfo, mUnionSdkCallback);

回调处理:

注意: 支付回调仅表示当前接口调用成功,不代表用户实际完成了支付流程,支付且发货成功应以游戏服务端下发通知为准

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_PAY)
                {

                    /**  
                      支付成功  
                    */

                    Debug.Log("pay info:" + resultData);

                   

                }
            }
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_PAY)
                {
                    //支付失败
                }
            }
        }

# 2.6 广告

当前SDK支持在游戏内创建并嵌入商业化广告,接入之前请相关商务或运营人员开通小游戏流量主,入驻支付宝商家平台;入驻成功后按照支付宝官方文档所述创建并设置相关广告位,并将生成的广告位ID提供给游戏客户端研发,否则无法进行联调测试。有关小游戏开通流量主、广告位创建及设置流程请阅读《小游戏激励广告接入流程》 (https://opendocs.alipay.com/admedia/0f27cu) 文档说明,本文不做赘述;商家平台的广告资质申请和技术API接入可同时进行

可在游戏初始化后调用创建广告接口,提前拉取广告,每个广告单元只需创建一次即可,后续可多次拉取和播放广告,创建时会自动拉取一次广告视频。

# 创建激励视频广告实例

//创建广告实例,可以创建多个广告实例,使用adUnitId 来判断区分
        Dictionary<string, string> adInfo = DHSDKHelper.DHParam.Builder()
            .put("adUnitId", "asdcv123123")  //必传,广告位ID
            .put("event_type", "createAd")  // 必传,createAd 创建广告实例,loadAd 加载广告,couldPlayAd 是否可以播放  playAd 播放广告
            .put("adPlatform", "douyin")  //选传,广告平台
            .put("adPosition", "")  //选传,广告展示位置,预留参数,有就填写
            .toDictionary();

        DHSDKHelper.playAd(adInfo, mUnionSdkCallback);

# 加载广告视频

用于加载激励视频广告;一般情况下,创建广告后,广告数据会默认加载一次,如果拉取失败,可在适当位置重新加载。

//加载广告,根据广告id找到对应广告实例
        Dictionary<string, string> adInfo2 = DHSDKHelper.DHParam.Builder()
            .put("adUnitId", "asdcv123123")  //必传,广告位ID
            .put("event_type", "loadAd")  // 必传,createAd 创建广告实例,loadAd 加载广告,couldPlayAd 是否可以播放  playAd 播放广告
            .toDictionary();

        DHSDKHelper.playAd(adInfo2, mUnionSdkCallback);

# 判断是否能播放广告

//判断是否能播放广告,根据广告id找到对应广告实例
        Dictionary<string, string> adInfo3 = DHSDKHelper.DHParam.Builder()
            .put("adUnitId", "asdcv123123")  //必传,广告位ID
            .put("event_type", "couldPlayAd")  // 必传,createAd 创建广告实例,loadAd 加载广告,couldPlayAd 是否可以播放  playAd 播放广告
            .toDictionary();

        DHSDKHelper.playAd(adInfo3, mUnionSdkCallback);

# 播放广告

//播放广告,根据广告id找到对应广告实例
        Dictionary<string, string> adInfo4 = DHSDKHelper.DHParam.Builder()
            .put("adUnitId", "asdcv123123")  //必传,广告位ID
            .put("event_type", "playAd")  // 必传,createAd 创建广告实例,loadAd 加载广告,couldPlayAd 是否可以播放  playAd 播放广告
            .put("adPosition", "")  //选传,广告展示位置,预留参数,有就填写
            .toDictionary();

        DHSDKHelper.playAd(adInfo4, mUnionSdkCallback);

# 广告回调接口

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_AD_READY)
                {

                    //广告准备完毕,可根据adunityId获取对应的广告实例

                    Debug.Log("ad info:" + resultData);
                    var adJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("adJson:" + adJson.ToString());

                    string adUnityId = adJson["adUnitId"].ToString();


                }
                else if (requestCode == DHSDKHelper.DHSDKConst.REQ_AD)
                {
                    //广告播放成功,可根据adunityId获取对应的广告实例

                    Debug.Log("ad info:" + resultData);
                    var adJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("adJson:" + adJson.ToString());

                    string adUnityId = adJson["adUnitId"].ToString();
                }
                else if(requestCode == DHSDKHelper.DHSDKConst.REQ_AD_LOAD)
                {
                    //广告加载成功,可根据adunityId获取对应的广告实例

                    Debug.Log("ad info:" + resultData);
                    var adJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("adJson:" + adJson.ToString());

                    string adUnityId = adJson["adUnitId"].ToString();
                }
else if (requestCode == DHSDKHelper.DHSDKConst.REQ_AD_CLOSE)
                {
                    var adJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("loginJson:" + adJson.ToString());

                    string adUnityId = adJson["adUnitId"].ToString();

                }

            }
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_AD_READY)
                {

                    //广告尚未准备好,可根据adunityId获取对应的广告实例

                    Debug.Log("ad info:" + resultData);
                    var adJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("adJson:" + adJson.ToString());

                    string adUnityId = adJson["adUnitId"].ToString();



                }
                else if (requestCode == DHSDKHelper.DHSDKConst.REQ_AD)
                {
                    //广告播放失败,可根据adunityId获取对应的广告实例

                    Debug.Log("ad info:" + resultData);
                    var adJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("adJson:" + adJson.ToString());

                    string adUnityId = adJson["adUnitId"].ToString();
                }
                else if (requestCode == DHSDKHelper.DHSDKConst.REQ_AD_LOAD)
                {
                    //广告加载失败,可根据adunityId获取对应的广告实例

                    Debug.Log("ad info:" + resultData);
                    var adJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("adJson:" + adJson.ToString());

                    string adUnityId = adJson["adUnitId"].ToString();
                }
            }
        }

# 2.7 数据统计相关接口

为了针对小游戏上线或买量投放后,能够更精准的分析和评估游戏的业务数据及广告投放效果(如登录、注册、创角及充值等数据表现),小游戏SDK及客户端研发均需进行相关数据的上报埋点。

# 流程统计上报

用于上报并记录用户在游戏内的行为日志&事件(如:启动、登录、充值等行为),方便观察数据的变化、快速定位问题的根源,以及追踪程序执行的过程等。

调用接口:

Dictionary<string, string> logParamsDic = new Dictionary<string, string>();
        logParamsDic.Add("logLevel", "d"); // 必传,// 日志类型;d 用于标记普通日志,e 用于标记异常日志
        logParamsDic.Add("logContent", ""); //必传,日志内容,可以是描述文本或JSON字符串等任意字符串,如程序执行错误信息或网络请求响应信息等
        logParamsDic.Add("key", "value"); //宣传,自定义事件,可由运营提供

        string eventId = "100100::SDK_CLIENT_LAUNCH"; //必传,事件ID
        DHSDKHelper.track(eventId,logParamsDic);

# 自定义事件上报

上报其它自定义事件(除启动、登录、充值等行为以外的自定义事件,如角色升级等);自定义事件的名称、参数无固定格式,非必接,请结合游戏业务需要或运营需求自行上报

调用接口:

//自定义事件上报
 Dictionary<string, string> roleInfoParamsDic = new Dictionary<string, string>();
roleInfoParamsDic.Add("type", "LOGIN_GAME"); // 必传,上报类型 LOGIN_GAME - 登录游戏服 CREATE_ROLE - 创角 LEVEL_UP - 升级
roleInfoParamsDic.Add("areaId", "100"); //选传,游戏大区ID,若游戏无大区概念,可不填,默认值为 1,表示初始大区编号
roleInfoParamsDic.Add("areaName", ""); //选传,游戏大区名称
roleInfoParamsDic.Add("roleId", "123123"); //必传,角色ID,若游戏无角色概念,可不填,默认值同 accountId 账号ID
roleInfoParamsDic.Add("roleName", "abc"); //必传,角色名称
roleInfoParamsDic.Add("roleLevel", "1"); //必传,角色等级,若游戏无角色及等级概念,可填关卡等级或不填,默认值为 1
roleInfoParamsDic.Add("roleVipLevel", "1"); //选传,角色VIP等级
roleInfoParamsDic.Add("itemId", ""); //商品ID,仅在 type 为 PAY_SUCCESS 时必填!
roleInfoParamsDic.Add("itemName", ""); //商品名称,仅在 type 为 PAY_SUCCESS 时必填!
roleInfoParamsDic.Add("orderId", ""); //订单唯一编号,仅在 type 为 PAY_SUCCESS 时必填!
roleInfoParamsDic.Add("orderPrice", ""); //商品总价,即实际支付价格,单位为分!仅在 type 为 PAY_SUCCESS 时必填!
roleInfoParamsDic.Add("currency", "CNY"); //货币类型,仅在 type 为 PAY_SUCCESS 时选填! CNY - 人民币 USD - 美元
roleInfoParamsDic.Add("payType", ""); //支付方式,仅在 type 为 PAY_SUCCESS 时选填! weixinpay - 微信支付 alipay - 支付宝 yeepay - 易宝支付 unionpay - 银联
DHSDKHelper.gameRoleInfoUpload(roleInfoParamsDic);

# 角色信息上报(SDK内部统计使用)

当有用户登录游戏服成功、创角成功、角色升级(如游戏无角色等级概念,则为关卡等级)、充值成功时,均需调用此接口进行数据上报。

注意:如果需要使用腾讯广告并且记录付费事件,PAY_SUCCESS事件必须接入,需要依赖服务端通知支付成功再调用,客户端回调不准确

调用接口:

//上报角色信息
        Dictionary<string, string> roleInfoParamsDic = new Dictionary<string, string>();
        roleInfoParamsDic.Add("type", "LOGIN_GAME"); // 必传,上报类型 LOGIN_GAME - 登录游戏服 CREATE_ROLE - 创角 LEVEL_UP - 升级   PAY_SUCCESS – 充值成功

        roleInfoParamsDic.Add("areaId", "100"); //选传,游戏大区ID,若游戏无大区概念,可不填,默认值为 1,表示初始大区编号
        roleInfoParamsDic.Add("areaName", ""); //选传,游戏大区名称
        roleInfoParamsDic.Add("roleId", "123123"); //必传,角色ID,若游戏无角色概念,可不填,默认值同 accountId 账号ID
        roleInfoParamsDic.Add("roleName", "abc"); //必传,角色名称
        roleInfoParamsDic.Add("roleLevel", "1"); //必传,角色等级,若游戏无角色及等级概念,可填关卡等级或不填,默认值为 1
        roleInfoParamsDic.Add("roleVipLevel", "1"); //选传,角色VIP等级
        roleInfoParamsDic.Add("itemId", ""); //商品ID,仅在 type 为 PAY_SUCCESS 时必填!
        roleInfoParamsDic.Add("itemName", ""); //商品名称,仅在 type 为 PAY_SUCCESS 时必填!
        roleInfoParamsDic.Add("orderId", ""); //订单唯一编号,仅在 type 为 PAY_SUCCESS 时必填!
        roleInfoParamsDic.Add("orderPrice", ""); //商品总价,即实际支付价格,单位为分!仅在 type 为 PAY_SUCCESS 时必填!
        roleInfoParamsDic.Add("currency", "CNY"); //货币类型,仅在 type 为 PAY_SUCCESS 时选填! CNY - 人民币 USD - 美元
        roleInfoParamsDic.Add("payType", ""); //支付方式,仅在 type 为 PAY_SUCCESS 时选填! weixinpay - 微信支付 alipay - 支付宝 yeepay - 易宝支付 unionpay - 银联
        DHSDKHelper.gameRoleInfoUpload(roleInfoParamsDic);

# 2.8 查询接口

用户获取登录后用户信息,系统信息等参数,示例如下

string version = DHSDKHelper.query("version"); //SDK的版本号,如 1.0.0
Debug.Log("version:" + version);
string system = DHSDKHelper.query("system");   //系统信息,详情请参考 wx.getSystemInfoSync() 接口文档
string platform = DHSDKHelper.query("system.platform"); //客户端设备类型 android ios windows mac devtools 
Debug.Log("platform:" + platform);
string networkType = DHSDKHelper.query("networkType");  //网络类型,详情请参考 wx.getNetworkType() 接口文档
string deviceId = DHSDKHelper.query("deviceId");  //设备唯一标识(注意,因小游戏客户端SDK无法获取真实的设备唯一标识,故使用一个32位随机字符串作为设备唯一标识,并存储于客户端缓存中;后续进入小游戏,若有缓存则从缓存中获取,无缓存则重新生成并存入缓存;因此无法确保设备唯一标识的准确性)
string deviceOS = DHSDKHelper.query("deviceOS");  //设备类型,如minigame_android、minigame_ios、minigame_devtools等
string launchOptions = DHSDKHelper.query("launchOptions");  //小游戏的启动参数
string gameAppId = DHSDKHelper.query("gameAppId");   //小游戏的 AppID(于抖音公众平台注册小游戏时生成的ID)
string appId = DHSDKHelper.query("appId");   //小游戏的 AppID(于SDK平台注册小游戏时生成的ID)
string appName = DHSDKHelper.query("packageName");    //小游戏的应用包名,如 com.dianhun.abc
string appVersion = DHSDKHelper.query("appVersion");   //小游戏的版本号,如 2.0.4.10
string channel = DHSDKHelper.query("channel");    //渠道ID,如 1389
string mainChannel = DHSDKHelper.query("mainChannel");   //推广主渠道ID,如 100708
string secondChannel = DHSDKHelper.query("secondChannel");  //推广次渠道ID,如 100709
string userInfo = DHSDKHelper.query("userInfo");  //用户信息,仅在授权登录成功后可读
string loginType = DHSDKHelper.query("userInfo.loginType");  //用户授权登录类型
string token = DHSDKHelper.query("userInfo.token");   //用户授权登录Token
string sign = DHSDKHelper.query("userInfo.sign");   //签名(本地验签使用)
string region = DHSDKHelper.query("userInfo.region");   //所属地区,1 表示中国大陆,0 表示港澳台及海外
string loginTimestamp = DHSDKHelper.query("userInfo.loginTimestamp");   //登录时间,秒级时间戳
string expireTimestamp = DHSDKHelper.query("userInfo.expireTimestamp");   //登录态过期时间,秒级时间戳
string accountView = DHSDKHelper.query("userInfo.accountView");   //账号缩略
Debug.Log("token:" + token);
string account = DHSDKHelper.query("userInfo.accountName");   //用户账号
string accountId = DHSDKHelper.query("userInfo.accountId");  //用户账号ID
string openId = DHSDKHelper.query("userInfo.userExtraInfo.openId");   //用户支付宝唯一标识(openId)
string userName = DHSDKHelper.query("userInfo.userExtraInfo.userName");   //用户在支付宝侧的账号名称
string avatar = DHSDKHelper.query("userInfo.userExtraInfo.avatar");   //用户在支付宝侧的头像
string nickName = DHSDKHelper.query("userInfo.userExtraInfo.nickName");   //用户在支付宝侧的昵称

# 2.9 绑定第三方平台

用于绑定第三方平台,如数数BI

# 调用接口

调用接口:

string jsonStr = DHSDKHelper.DHJsonParam.Builder()
    .put("type", "GRAVITY_ENGINE")  //必传,上报类型 GRAVITY_ENGINE - 引力引擎
    .put("accountId", "AID123456")  //必传,当前用户的数数账户 ID
    .put("distinctId", "DID123456")  //必传 当前用户的数数访客 ID
    .toJson();
string jsonParamStr = DHSDKHelper.DHJsonParam.Builder()
.put("pluginName", "tools")
.put("pluginType", "platform")
.put("methodName", "bindThirdPlatform")
.put("methodParam", jsonStr)
.toJson();
DHSDKHelper.exec(jsonParamStr, mUnionSdkCallback);

# 2.10 分享

# 启用转发或分享按钮(被动分享)

用于启用游戏右上角•••菜单中的分享按钮,并同步设置其点击时的分享参数;建议在SDK初始化完成后立即调用此接口进行设置。

调用接口:

DHSDKHelper.DHSDKShareContent miniContent = new DHSDKHelper.DHSDKShareContent();
miniContent.Type = DHSDKHelper.DHSDKShareType.shareType_minigame_set;
miniContent.Platform = DHSDKHelper.DHSDKSharePlatform.Platform_MiniGame;
miniContent.Title = "分享标题"; //选填,分享时显示的标题,不填时默认使用当前游戏的名称
miniContent.Desc = "";  //选填,分享时显示的描述文案,不填时默认使用当前游戏的简介
DHSDKHelper.share(miniContent, mUnionSdkCallback);

# 主动分享

用于主动唤起支付宝分享面板进行分享;分享时显示的标题和描述文案默认使用 setShare 中设置的值,若未设置,则使用当前游戏的名称和简介。

调用接口:

DHSDKHelper.DHSDKShareContent miniContent = new DHSDKHelper.DHSDKShareContent();
 miniContent.Type = DHSDKHelper.DHSDKShareType.shareType_minigame_share;
 miniContent.Platform = DHSDKHelper.DHSDKSharePlatform.Platform_MiniGame;

 DHSDKHelper.share(miniContent, mUnionSdkCallback);

# 分享回调

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_SHARE)
                {

                    /**  
                      分享成功  
                    */

                    Debug.Log("share info:" + resultData);

                   

                }
            }
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_SHARE)
                {
                    //分享失败
                }
            }
        }

# 2.11 游戏圈

通过游戏圈组件,可以在游戏内为用户提供游戏交流、用户互动、反馈收集等社区能力。

# 创建游戏圈入口

用于在游戏内创建一个用于打开游戏圈的按钮,并在点击时跳转至游戏圈主页。

调用接口:

string param = DHSDKHelper.DHJsonParam.Builder()
    .put("type", "text ")       // 必传,按钮类型 text - 文本按钮 image - 图片按钮
    .put("icon", "")       // 选传,图片按钮的图标,仅当 type 为 image 时有效 green - 绿色图标 white - 白色图标 dark - 有黑色圆角背景的白色图标 light - 有白色圆角背景的绿色图标
    .put("image", "")    // 选传,图片按钮的背景图片,仅当 type 为 image 时有效
    .put("text", "")    // 选传,文本按钮的文本,仅当 type 为 text 时有效
    .put("top", "0")        // 必传,按钮左上角纵坐标
    .put("left", "0")      // 必传,按钮左上角横坐标
    .put("width", "100")      // 必传,按钮宽度
    .put("height", "32")      //必传,按钮高度
    .put("backgroundColor", "#07c160")      // 必传,角色所属公会 , 无公会系统,传无
    .put("borderWidth", "0")        // 必传,按钮边框宽度
    .put("borderColor", "#07c160")     // 必传,按钮边框颜色,格式为 6 位 16 进制数
    .put("borderRadius", "0")     //必传,按钮边框圆角
    .put("color", "#ffffff")      //必传,按钮文本颜色,格式为 6 位 16 进制数
    .put("fontSize", "12")        //必传,按钮文本字号
    .put("textAlign", "center")   //必传,按钮文本水平居中方式 left - 居左 center - 居中 right - 居右
    .put("lineHeight", "32")       //必传,按钮文本行高
    .put("openlink", "")       //选传,设置后可以跳转到对应的活动页面,可登录《微信公众平台》后台,进入“功能 > 游戏运营工具箱 > 游戏圈 > 管理”,由帖子或话题的"游戏内跳转ID"生成;不设置时默认跳转至游戏圈主页(注意,该参数必须设置为真实有效的值,没有的情况下请直接去除该参数,不允许留空,否则将导致点击按钮时报错)
    .toJson();
DHSDKHelper.createGameClubButton(param, mUnionSdkCallback);

按钮点击调用回调:

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_CREATE_GAME_CLUB_BUTTON)
                {
                    Debug.Log("游戏圈按钮点击打开游戏圈");
                    var gameClubJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("gameclubJson:" + gameClubJson.ToString());
                } 
}          
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_CREATE_GAME_CLUB_BUTTON)
                {
                    Debug.Log("创建游戏圈按钮失败,或者游戏圈按钮点击打开游戏圈失败");
                    var gameClubJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("gameclubJson:" + gameClubJson.ToString());                
}
            }
        }

# 游戏圈按钮操作

用于操作游戏圈入口按钮,包括显示,隐藏和移除

//操作游戏圈按钮
        string gameClubAction = "hide";//游戏圈操作类型,show:显示,hide:隐藏,destroy:移除
        DHSDKHelper.gameClubButtonAction(gameClubAction);

# 获取玩家游戏圈数据

用于在小游戏内获取玩家游戏圈数据,该接口需要在用户授权登录成功后调用。

//获取游戏圈数据
string param = DHSDKHelper.DHJsonParam.Builder()
    .put("dataTypeList", "[{\"type\":\"1\"},{\"type\":\"3\"}]")       // 必传,需要获取的数据指标对象数组
    .toJson();
DHSDKHelper.gameClubGetData(param, mUnionSdkCallback);
/*
 数据指标 type 说明
1	加入游戏圈时间,秒级Unix时间戳
3	用户禁言状态;0:正常,1:禁言
4	当天(自然日)点赞贴子数
5	当天(自然日)评论贴子数
6	当天(自然日)发表贴子数
7	当天(自然日)发表视频贴子数
8	当天(自然日)点赞官方贴子数
9	当天(自然日)评论官方贴子数
10	当天(自然日)用户在本圈子访问的时长
11	当天(自然日)用户在本圈子浏览贴子的数量

 * */

回调方法:

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_GAME_CLUB_GET_DATA)
                {
                    Debug.Log("获取游戏圈数据成功");
                    var gameClubJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("gameclubJson:" + gameClubJson.ToString());
                    var data = gameClubJson["data"];
                    var dataList = data["dataList"];//经过解密处理的 GameClubData 数据

                    //响应数据 encryptedData 解密后得到的 GameClubData 的结构示例
                    //{"dataList":[{"dataType":{"type":"1"},"value":"1"},{"dataType":{"type":"2"},"value":"2"}]}                
} 
}          
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_GAME_CLUB_GET_DATA)
                {
                   Debug.Log("获取游戏圈数据失败失败");
                    var gameClubJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("gameclubJson:" + gameClubJson.ToString());             
}
            }
        }

# 2.12 添加到支付宝首页

用于将游戏中心添加到支付宝首页

# 调用接口

string jsonParamStr = DHSDKHelper.DHJsonParam.Builder()
    .put("pluginName", "tools")
    .put("pluginType", "platform")
    .put("methodName", "addToHomepage")
    .toJson();
DHSDKHelper.exec(jsonParamStr, mUnionSdkCallback);

# 回调方法

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_EXEC)
                {

                    var execJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("execJson:" + execJson.ToString());

                    string event_type = execJson["methodName"].ToString();
                    
                    if (event_type == " addToHomepage")
                     {
                        //添加到支付宝首页成功
                     }                
				}            
			}
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_EXEC)
                {

                    var execJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("execJson:" + execJson.ToString());

                    string event_type = execJson["methodName"].ToString();
                    
                    if (event_type == "addToHomepage")
                     {
                     //添加到支付宝首页失败
                     }
                }           
 }
        }

# 2.13 添加桌面

用于判断有无桌面快捷方式权限。注意:支付宝小游戏的 checkShortcut 接口用于判断有无桌面快捷方式权限,而抖音、快手等其他渠道小游戏内的该接口则是用于判断小游戏快捷方式是否已添加到手机桌面上,含义不同。 若调用该接口检测结果为没有权限,可调用showAuthGuide(入参 authType 传 "SHORTCUT")接口引导用户开启创建桌面快捷方式的权限。

# 调用接口

//判断有无桌面快捷方式权限
string jsonParamStr = DHSDKHelper.DHJsonParam.Builder()
    .put("pluginName", "tools")
    .put("pluginType", "platform")
    .put("methodName", "checkShortcut")
    .toJson();
DHSDKHelper.exec(jsonParamStr, mUnionSdkCallback);
//添加到桌面
string jsonParamStr = DHSDKHelper.DHJsonParam.Builder()
    .put("pluginName", "tools")
    .put("pluginType", "platform")
    .put("methodName", "addShortcut")
    .toJson();
DHSDKHelper.exec(jsonParamStr, mUnionSdkCallback);

//判断是否从桌面快捷方式启动
string isLaunchFromShortcut = DHSDKHelper.query("isLaunchFromShortcut"); //true:从桌面快捷方式启动  false:不是从桌面快捷方式启动

//引导用户开启桌面快捷方式权限
string jsonParamStr = DHSDKHelper.DHJsonParam.Builder()
    .put("pluginName", "tools")
    .put("pluginType", "platform")
    .put("methodName", "showAuthGuide")
    .toJson();
DHSDKHelper.exec(jsonParamStr, mUnionSdkCallback);

# 回调

public void onDHSDKResult(int requestCode, int resultCode, String resultData)
        {
            if (resultCode == DHSDKHelper.DHSDKConst.RET_OK)
            {
                // 所有接口成功返回调用逻辑
                if (requestCode == DHSDKHelper.DHSDKConst.REQ_EXEC)
                {

                    var execJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("execJson:" + execJson.ToString());

                    string event_type = execJson["methodName"].ToString();
                    
                    if (event_type == "checkShortcut")
{
    string authStatus = execJson["data"]["authStatus"].ToString(); //是否有添加桌面快捷方式的权限,true 表示有权限,false 表示无权限
    if (authStatus == "true")
    {
        //有添加桌面快捷方式的权限
        Debug.Log($"#### 有添加桌面快捷方式的权限");
    }
    else
    {
        //没有添加桌面快捷方式的权限
        Debug.Log($"#### 没有添加桌面快捷方式的权限");

    }


}
else if (event_type == "addShortcut")
{
    Debug.Log($"#### 添加到桌面成功");


}
else if (event_type == "showAuthGuide")
{
    string shown = execJson["data"]["shown"].ToString(); //是否已显示引导授权弹框,true 表示已显示,false 表示未显示
    if (shown == "true")
    {
        //已显示引导授权弹框
        Debug.Log($"#### 有添加桌面快捷方式的权限");
    }
    else
    {
        //未显示引导授权弹框
        Debug.Log($"#### 没有添加桌面快捷方式的权限");

    }
}

}            
}
            else if (resultCode == DHSDKHelper.DHSDKConst.RET_FAIL)
            {

                // 所有接口失败返回调用逻辑  所有失败信息请游戏接入方测试时log打印记录并反馈给sdk方  方便排查问题

                if (requestCode == DHSDKHelper.DHSDKConst.REQ_EXEC)
                {

                    var execJson = LitJson.JSON.Parse(resultData);
                    Debug.Log("execJson:" + execJson.ToString());

                    string event_type = execJson["methodName"].ToString();
                    
                    if (event_type == "checkShortcut")
{
    //检查是否有添加桌面快捷方式失败

}
else if (event_type == "addShortcut")
{
    Debug.Log($"#### 添加到桌面失败");


}
else if (event_type == "showAuthGuide")
{
    //显示引导授权弹框失败

}                }           
 }
        }

# 2.14 清理缓存并重启小游戏

点击弹出确认框,同意后清理缓存并重启微信小游戏。

调用接口:

//清理缓存并重启小游戏
            string jsonStr = DHSDKHelper.DHJsonParam.Builder()              
            .put("title", "提示")  //必传,弹窗标题
            .put("content", "是否清理缓存,并重新启动?")  //必传,弹窗内容
            .put("confirmText", "确认")  //必传 确认按钮文字
            .put("cancelText", "取消")  //必传 取消按钮文字
            .toJson(); 
            string jsonParamStr = DHSDKHelper.DHJsonParam.Builder()
            .put("pluginName", "tools")
            .put("pluginType", "platform")
            .put("methodName", "ClearAndRestart")
            .put("methodParam", jsonStr)   
            .toJson();    
            DHSDKHelper.exec(jsonParamStr, mUnionSdkCallback);


其它功能、类型具体可以参考 UIMain.CS 文件

Last Updated: 2026/11/4 17:06:37