广告模块

一、接入前准备

1、iOS

a. 下载资源，SuperSDK 广告模块（iOS For Object-C版）。

b. 导入资源，将 BaseCoreAdvert.a 导入到游戏工程（与 SuperSDK.framework 同目录）。

c. 调用广告接口，可根据以下国内和海外分别接入。

2、Android

a. 下载资源，SuperSDK 广告模块（Android For Java版）。

b. 导入资源，将 module-advert.jar 导入到游戏工程的 libs 目录下（与 supersdk.jar 同目录）。

c. 调用广告接口，可根据以下国内和海外分别接入。

二、国内广告

注意一：iOS 国内广告目前支持 YAD，游戏研发只需要按照以下文档接入。

注意二：Android 国内广告目前支持 YAD、今日头条、广点通、UC、快手，游戏研发只需要按照以下文档接入。

注意三：国内广告因为需要满足隐私合规，游戏需要在初始化成功且用户以同意用户隐私的情况下才能开始调用广告事件。

1. 打开事件（必接）

说明：初始化成功且用户以同意用户隐私的情况下后调用。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "ad_open");                       // 广告事件ID，必传
configDic.Add("extendKey", "extendValue");                  // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");                // 扩展参数 key，value，根据投放需求填写
SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

2. 登录事件（必接）

说明：在登录成功后调用，如果角色信息、服务器信息没有值，可以传默认值。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "ad_login");                     // 广告事件ID，必传
configDic.Add("osdk_user_id", "0060015_guest110897");      // 玩家uid，必传
configDic.Add("serverId", "15001");                        // 服务端编号，必传
configDic.Add("level", "125");                             // 角色等级，必传
configDic.Add("roleId", "99999");                          // 角色编号，必传
configDic.Add("roleType", "-1");                           // 角色类型，必传，默认填-1，int型
configDic.Add("roleCareer", "-1");                         // 角色职业，必传，默认填-1，int型
configDic.Add("roleName", "");                             // 角色名称，必传，默认填""
configDic.Add("extendKey", "extendValue");                 // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");               // 扩展参数 key，value，根据投放需求填写
SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

3. 创建角色事件（必接）

说明：在创角成功后调用。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "ad_createrole");                // 广告事件ID，必传
configDic.Add("osdk_user_id", "0060015_guest110897");      // 玩家uid，必传
configDic.Add("serverId", "15001");                        // 服务端编号，必传
configDic.Add("level", "125");                             // 角色等级，必传
configDic.Add("roleId", "99999");                          // 角色编号，必传
configDic.Add("roleType", "-1");                           // 角色类型，必传，默认填-1，int型
configDic.Add("roleCareer", "-1");                         // 角色职业，必传，默认填-1，int型
configDic.Add("roleName", "");                             // 角色名称，必传，默认填""
configDic.Add("extendKey", "extendValue");                 // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");               // 扩展参数 key，value，根据投放需求填写
SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

4. 升级事件（必接）

说明：在每次玩家等级升级成功后调用。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "ad_levelup");                   // 广告事件ID，必传
configDic.Add("osdk_user_id", "0060015_guest110897");      // 玩家uid，必传
configDic.Add("serverId", "15001");                        // 服务端编号，必传
configDic.Add("level", "125");                             // 角色等级，必传
configDic.Add("roleId", "99999");                          // 角色编号，必传
configDic.Add("roleType", "-1");                           // 角色类型，必传，默认填-1，int型
configDic.Add("roleCareer", "-1");                         // 角色职业，必传，默认填-1，int型
configDic.Add("roleName", "");                             // 角色名称，必传，默认填""
configDic.Add("extendKey", "extendValue");                 // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");               // 扩展参数 key，value，根据投放需求填写
SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

5. 退出事件（必接）

说明：在玩家退出游戏时调用，即关闭游戏。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "ad_exit");                      // 广告事件ID，必传
configDic.Add("osdk_user_id", "0060015_guest110897");      // 玩家uid，必传
configDic.Add("serverId", "15001");                        // 服务端编号，必传
configDic.Add("level", "125");                             // 角色等级，必传
configDic.Add("roleId", "99999");                          // 角色编号，必传
configDic.Add("roleType", "-1");                           // 角色类型，必传，默认填-1，int型
configDic.Add("roleCareer", "-1");                         // 角色职业，必传，默认填-1，int型
configDic.Add("roleName", "");                             // 角色名称，必传，默认填""
configDic.Add("extendKey", "extendValue");                 // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");               // 扩展参数 key，value，根据投放需求填写
SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

6. 注册事件（必接）

说明：在注册账号时调用，如果无法知道注册账号时间，则在创角成功后调用（需要在调用创建角色事件之前调用）。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "ad_register");                  // 广告事件ID，必传
configDic.Add("osdk_user_id", "0060015_guest110897");      // 玩家uid，必传
configDic.Add("serverId", "15001");                        // 服务端编号，必传
configDic.Add("level", "125");                             // 角色等级，必传
configDic.Add("roleId", "99999");                          // 角色编号，必传
configDic.Add("roleType", "-1");                           // 角色类型，必传，默认填-1，int型
configDic.Add("roleCareer", "-1");                         // 角色职业，必传，默认填-1，int型
configDic.Add("roleName", "");                             // 角色名称，必传，默认填""
configDic.Add("extendKey", "extendValue");                 // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");               // 扩展参数 key，value，根据投放需求填写
SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

7. 支付事件（必接）

说明：游戏服务端通知前端发货时调用（实际到账时调用）。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "ad_register");                  // 广告事件ID，必传
configDic.Add("osdk_user_id", "0060015_guest110897");      // 玩家uid，必传
configDic.Add("serverId", "15001");                        // 服务端编号，必传
configDic.Add("level", "125");                             // 角色等级，必传
configDic.Add("roleId", "99999");                          // 角色编号，必传
configDic.Add("roleType", "-1");                           // 角色类型，必传，默认填-1，int型
configDic.Add("roleCareer", "-1");                         // 角色职业，必传，默认填-1，int型
configDic.Add("roleName", "");                             // 角色名称，必传，默认填""
configDic.Add("extendKey", "extendValue");                 // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");               // 扩展参数 key，value，根据投放需求填写

// 支付额外参数
configDic.Add("orderId", "10000000000000001");             // 游戏订单号，String 型，必传
configDic.Add("amount", "0.99");                           // 充值金额，必传
configDic.Add("productId", "道具id");                       // 道具 id，String 型，必传
configDic.Add("productName", "道具名称");                    // 道具名称，String 型，必传
configDic.Add("way", "0");                                 // 支付渠道，默认填0，int型
configDic.Add("currency", "RMB");                          // 货币类型，String 型，选传
configDic.Add("type", "1");                                // 支付类型，int 型，选传
configDic.Add("discount", "0");                            // 支付折扣，float 型，选传
SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

8. 扩展事件（选接）

说明：需要调用其他广告事件时调用（投放有特殊要求时才接入，无特殊要求时无需接入）。

Dictionary<string, object> configDic = new Dictionary<string, object>();
configDic.Add("event_id", "事件id");                        // 广告事件ID，必传
configDic.Add("osdk_user_id", "0060015_guest110897");      // 玩家uid，必传
configDic.Add("serverId", "15001");                        // 服务端编号，必传
configDic.Add("level", "125");                             // 角色等级，必传
configDic.Add("roleId", "99999");                          // 角色编号，必传
configDic.Add("roleType", "-1");                           // 角色类型，必传，默认填-1，int型
configDic.Add("roleCareer", "-1");                         // 角色职业，必传，默认填-1，int型
configDic.Add("roleName", "");                             // 角色名称，必传，默认填""
configDic.Add("extendKey", "extendValue");                 // 自定义参数 key，value，可不填
configDic.Add("event_value", "event_value");               // 扩展参数 key，value，根据投放需求填写

//  头条 SDK 自定义事件参数（以下参数只有需要接入头条自定义事件的游戏才需要添加，根据头条自定义事件文档要求添加相应的 key，value）
configDic.Add("is_achieve", "0");                          // 是否完成，1 次回传即代表 1 次行为完成，int 型的 String 字符串
configDic.Add("num", "0");                                 // 规则判断，1 次行为所对应的 id/level 等拓展信息，int 型的 String 字符串

SuperSDK.getInstance().Invoke(SuperSDKAdVert.MODULE_NAME, SuperSDKAdVert.FUNC_TRACK, configDic));

9. YZDeeplink（选接）

说明：此事件只需监听 SuperSDK 回调，非主动调用接口，游戏研发需要根据协议约定处理回调中的 data 数据，回调事件的参考数据如下：

moduleName : advert
funcName : yzDeepLink
result : {
    "msg":"deeplink callback",
    "data":{
                "code":"l39rduyh"
           },
    "code":1
}

三、海外广告

说明：海外广告目前支持 Firebase、Facebook、Appsflyer 和 adjust。

注意：海外广告最终接入事件以投放文档为准。

附录

常量字符串	实际字符串	描述
SuperSDKAdVert.MODULE_NAME	advert	广告模块名称
SuperSDKAdVert.FUNC_TRACK	track	触发广告事件方法名

搜索结果