supersdk

文档中心

文档中心

下载文档

广告模块


一、接入前准备

1. 下载资源,SuperSDK 广告模块(iOS For Object-C版)

2. 导入资源,将 BaseCoreAdvert.a 导入到游戏工程(与 SuperSDK.framework 同目录)。

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

二、国内广告

说明:国内广告目前支持 YAD,游戏研发只需要按照以下文档接入。

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

1. 打开事件(必接)

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

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_open", // 广告事件 ID,必传
                                 @"extendKey": @"extendValue", // 自定义参数 key,value,可不填
                                 @"event_value": @"event_value", // 扩展参数 key,value,根据投放需求填写		
                            };
                            
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

2. 登录事件(必接)

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

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_login", // 广告事件 ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897", // 玩家 uid,String 型
                                 @"serverId" : @"15001", // 服务器 id,String 型
                                 @"level" : @"125", // 角色等级,int 型的 String 字符串
                                 @"roleId" : @"99999", // 角色 id,String 型
                                 @"roleType" : @"-1", // 角色类型 id,默认填-1,int 型的 String 字符串
                                 @"roleCareer" : @"-1", // 角色职业 id,默认填-1,int 型的 String 字符串
                                 @"roleName" : @"", // 角色名称,String 型
                                 @"extendKey": @"extendValue", // 自定义参数 key,value,可不填
                                 @"event_value": @"event_value", // 扩展参数 key,value,根据投放需求填写			
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

3. 创建角色事件(必接)

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

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_createrole", // 广告事件 ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897", // 玩家 uid,String 型
                                 @"serverId" : @"15001", // 服务器 id,String 型
                                 @"level" : @"125", // 角色等级,int 型的 String 字符串
                                 @"roleId" : @"99999", // 角色 id,String 型
                                 @"roleType" : @"-1", // 角色类型 id,默认填-1,int 型的 String 字符串
                                 @"roleCareer" : @"-1", // 角色职业 id,默认填-1,int 型的 String 字符串
                                 @"roleName" : @"", // 角色名称,String 型
                                 @"extendKey": @"extendValue", // 自定义参数 key,value,可不填
                                 @"event_value": @"event_value", // 扩展参数 key,value,根据投放需求填写		
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

4. 升级事件(必接)

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

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_levelup", // 广告事件 ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897", // 玩家 uid,String 型
                                 @"serverId" : @"15001", // 服务器 id,String 型
                                 @"level" : @"125", // 角色等级,int 型的 String 字符串
                                 @"roleId" : @"99999", // 角色 id,String 型
                                 @"roleType" : @"-1", // 角色类型 id,默认填-1,int 型的 String 字符串
                                 @"roleCareer" : @"-1", // 角色职业 id,默认填-1,int 型的 String 字符串
                                 @"roleName" : @"", // 角色名称,String 型
                                 @"extendKey": @"extendValue", // 自定义参数 key,value,可不填	
                                 @"event_value": @"event_value", // 扩展参数 key,value,根据投放需求填写	
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

5. 扩展事件(选接)

说明:需要调用其他广告事件时调用(投放有特殊要求时才接入,无特殊要求时无需接入)。

NSDictionary *parameters = @{
                                 @"event_id" : @"广告部门指定的自定义事件埋点", // 广告事件 ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897", // 玩家 uid,String 型
                                 @"serverId" : @"15001", // 服务器 id,String 型
                                 @"level" : @"125", // 角色等级,int 型的 String 字符串
                                 @"roleId" : @"99999", // 角色 id,String 型
                                 @"roleType" : @"-1", // 角色类型 id,默认填-1,int 型的 String 字符串
                                 @"roleCareer" : @"-1", // 角色职业 id,默认填-1,int 型的 String 字符串
                                 @"roleName" : @"", // 角色名称
                                 @"extendKey": @"extendValue", // 自定义参数 key,value,可不填
                                 @"event_value": @"event_value", // 扩展参数 key,value,根据投放需求填写
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

6. YZDeeplink(选接)

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

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

三、海外广告

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

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

附录

常量字符串 实际字符串 描述
BCORE_MODULE_ADVERT advert 广告模块名称
BCORE_FUNC_TRACK track 触发广告事件方法名

1. 弹出CMP窗口

说明:游戏广告接入了Firebase渠道,应Google政策要求,EEA地区用户,广告上报自定义事件前,需要征询获取用户授权同意

调用时机:SuperSDK初始化回调成功后,游戏处理自己的公告栏、音视频播放完毕后,调用下方接口,弹出Cmp弹窗

弹窗逻辑:EEA地区:即欧盟经济特区,会弹出该弹窗;非EEA地区:不会弹出该弹窗

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:@"startCmp" parameters:nil];