下载文档

最后更新时间: 2021-02-04 03:12:47 PM

Advertising module

Note: Do not repeatedly integrate the same event ID!


Trigger an ad event

Interface Description: Trigger an ad event

Interface invoke:

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:@{@"event_id" : @"广告事件ID"}];

Overseas advertising

Open the game event tracking

Description: Invoke in the AppDelegate - (BOOL)application:(UIApplication )application didFinishLaunchingWithOptions:(NSDictionary )launchOptions, and must be invoked after invoking SuperSDK initialization interface

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_open",                           // 广告事件ID,必传
                                 @"userData" : @{                                    // userData为扩展信息,可不传,即删除该键值对
                                                  @"extendKey" : @"extendValue"
                                                }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

Login event tracking

Description: Invoked after successful login. If you cannot get the role information with a successful login, you should invoke before entering the game after obatining the role information.

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_login",                          // 广告事件ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897",           // 玩家uid,必传
                                 @"serverId" : @"15001",                             // 服务端编号,必传
                                 @"level" : @"125",                                  // 角色等级,必传
                                 @"roleId" : @"99999",                               // 角色编号,必传
                                 @"roleType" : @(-1),                                // 角色类型,必传,默认填-1
                                 @"roleCareer" : @(-1),                              // 角色职业,必传,默认填-1
                                 @"roleName" : @"",                                  // 角色名称,必传,默认填""
                                 @"userData" : @{                                    // userData为扩展信息,可不传,即删除该键值对
                                                    @"extendKey" : @"extendValue"
                                                }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

创角事件埋点

说明:在创角成功后调用

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_createrole",                     // 广告事件ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897",           // 玩家uid,必传
                                 @"serverId" : @"15001",                             // 服务端编号,必传
                                 @"level" : @"125",                                  // 角色等级,必传
                                 @"roleId" : @"99999",                               // 角色编号,必传
                                 @"roleType" : @(-1),                                // 角色类型,必传,默认填-1
                                 @"roleCareer" : @(-1),                              // 角色职业,必传,默认填-1
                                 @"roleName" : @"",                                  // 角色名称,必传,默认填""
                                 @"userData" : @{                                    // userData为扩展信息,可不传,即删除该键值对
                                                    @"extendKey" : @"extendValue"
                                                }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

升级事件埋点

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

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_levelup",                        // 广告事件ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897",           // 玩家uid,必传
                                 @"serverId" : @"15001",                             // 服务端编号,必传
                                 @"level" : @"125",                                  // 角色等级,必传
                                 @"roleId" : @"99999",                               // 角色编号,必传
                                 @"roleType" : @(-1),                                // 角色类型,必传,默认填-1
                                 @"roleCareer" : @(-1),                              // 角色职业,必传,默认填-1
                                 @"roleName" : @"",                                  // 角色名称,必传,默认填""
                                 @"userData" : @{                                    // userData为扩展信息,可不传,即删除该键值对
                                                    @"extendKey" : @"extendValue"
                                                }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

退出游戏事件埋点

说明:在玩家退出游戏时调用,即关闭APP

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_exit",                           // 广告事件ID,必传
                                 @"osdk_user_id" : @"0060015_guest110897",           // 玩家uid,必传
                                 @"serverId" : @"15001",                             // 服务端编号,必传
                                 @"level" : @"125",                                  // 角色等级,必传
                                 @"roleId" : @"99999",                               // 角色编号,必传
                                 @"roleType" : @(-1),                                // 角色类型,必传,默认填-1
                                 @"roleCareer" : @(-1),                              // 角色职业,必传,默认填-1
                                 @"roleName" : @"",                                  // 角色名称,必传,默认填""
                                 @"userData" : @{                                    // userData为扩展信息,可不传,即删除该键值对
                                                    @"extendKey" : @"extendValue"
                                                }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

支付事件埋点

说明:在账号发生充值或者消费时调用。

NSDictionary *parameters = @{
                                @"event_id" : @"ad_pay",                             // 广告事件ID,必传
                                @"osdk_user_id" : @"0060015_guest110897",            // 玩家uid,必传
                                @"serverId" : @"15001",                              // 服务端编号,必传
                                @"level" : @"125",                                   // 角色等级,必传
                                @"roleId" : @"99999",                                // 角色编号,必传
                                @"roleType" : @(-1),                                 // 角色类型,必传,默认填-1
                                @"roleCareer" : @(-1),                               // 角色职业,必传,默认填-1
                                @"roleName" : @"",                                   // 角色名称,必传,默认填""
                                @"orderId" : @"10000000000000001",                   // 订单名称,必传
                                @"money" : @(0.99),                                  // 充值金额,必传
                                @"way" : @(1),                                       // 支付渠道,
                                @"currency" : @"xxx",                                // 充值单位
                                @"type" : @(-1),                                     // 充值类型
                                @"discount" : @(-1),                                 // 充值折扣
                                @"itemId" : @"itemId",                               // 道具标识
                                @"userData" : @{                                     // userData为扩展信息,可不传,即删除该键值对
                                                    @"extendKey" : @"extendValue"
                                               }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

自定义事件埋点

说明:按广告部门要求,自定义一些埋点事件,调用方式和上面已确定埋点调用一样,只不过,埋点的事件ID会变更;具体埋点事件ID和调用时机,以广告部门说明为准。

NSDictionary *parameters = @{
                                     @"event_id" : @"广告部门指定的自定义事件埋点",           // 广告事件ID,必传
                                     @"osdk_user_id" : @"0060015_guest110897",           // 玩家uid,必传
                                     @"serverId" : @"15001",                             // 服务端编号,必传
                                     @"level" : @"125",                                  // 角色等级,必传
                                     @"roleId" : @"99999",                               // 角色编号,必传
                                     @"roleType" : @(-1),                                // 角色类型,必传,默认填-1
                                     @"roleCareer" : @(-1),                              // 角色职业,必传,默认填-1
                                     @"roleName" : @"",                                  // 角色名称,必传,默认填""
                                     @"userData" : @{                                    // userData为扩展信息,可不传,即删除该键值对
                                                        @"extendKey" : @"extendValue"
                                                    }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

海外广告埋点

打开游戏埋点

说明:在AppDelegate的- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions中调用,且必须在调用SuperSDK初始化接口后调用

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:@{
                                                                                @"event_id" : @"ad_open"    // 广告事件ID
                                                                            }];

登录事件埋点

说明:在登录成功后调用,如果登录成功不能拿到角色信息,应在拿到角色信息后,进入游戏前调用

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:@{ 
                                                                                @"event_id" : @"ad_login"   // 广告事件ID
                                                                            }];

FB激活事件埋点

说明:在AppDelegate的- (void)applicationDidBecomeActive:(UIApplication *)application 中调用;如果接入了SuperSdk的激活生命周期事件并且接入YouZuGTA渠道,则不需要再调用,因为SuperSDK激活事件中已经调用了。

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:@{ 
                                                                                @"event_id" : @"ad_fb_open" // 广告事件ID                                                                                  
                                                                            }];

创角事件埋点

说明:在创角成功后调用

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_createrole",         // 广告事件ID
                                 @"event_value" : @"玩家账号"             // 玩家账号uid
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

升级事件埋点

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

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_levelup",           // 广告事件ID
                                 @"event_value" : @"1"                  // 角色等级
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

有效等级事件埋点

说明:有效等级事件上报,有效等级以广告部门为准,假如有效等级为6,即你要在1,2,3,4,5,6等级的时候,调用

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_effectivelevel",    // 广告事件ID
                                 @"event_value" : @"1"                  // 角色等级
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

七日留存事件埋点

说明:是希望安装当日为第1日,在之后的2,3,4,5,6都有登录,第七天再登录成功时触发,所以一般领取7日登陆奖励或签到第7天调用

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:@{ 
                                                                                @"event_id" : @"ad_7retention" // 广告事件ID    
                                                                            }];

首次支付事件埋点

说明:在首次充值成功后调用,也可放在领取首充礼包时触发

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:@{ 
                                                                                @"event_id" : @"ad_firstpay"   // 广告事件ID    
                                                                            }];

支付事件埋点

说明:每次支付成功后,调用

NSDictionary *parameters = @{
                                 @"event_id" : @"ad_pay",               // 广告事件ID
                                 @"event_value"  : @"648"               // 本次消费金额
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

自定义事件埋点

说明:按广告部门要求,自定义一些埋点事件,调用方式和上面已确定埋点调用一样,只不过,埋点的事件ID会变更、也可能包含其他参数;具体埋点事件ID和调用时机,以广告部门说明为准。

NSDictionary *parameters = @{
                                 @"event_id" : @"广告部门指定的自定义事件埋点" // 广告事件ID
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

广点通埋点

打开游戏埋点

说明:在AppDelegate的- (void)applicationDidBecomeActive:(UIApplication *)application中调用,且必须在调用SuperSDK初始化接口后调用


NSDictionary *parameters = @{
                                 @"event_id":@"ad_gdt_open",                         // 广告事件ID,必传
                                 @"gdt_event_value":@{
                                                        @"event_name":@"ad_gdt_open",// 事件名称
                                                        @"length_of_stay":@(1),      // 次日留存,注意类型
                                                        @"outer_action_id":@"123456" // 去重字符串,不建议使用此字段!!!
                                                     }
                            };
                                 
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

注册游戏埋点

说明:在注册成功后调用


NSDictionary *parameters = @{
                                 @"event_id":@"ad_register",                         		// 广告事件ID,必传
                                 @"gdt_event_value":@{
                                                        @"event_name":@"ad_register",		// 事件名称
                                                        @"event_value":@"0060015_guest123"  // 玩家账号uid                                                     
                                                     }
                            };
                                 
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

支付游戏埋点

说明:在支付成功后调用


NSDictionary *parameters = @{
                                 @"event_id":@"ad_pay",                         		// 广告事件ID,必传
                                 @"gdt_event_value":@{
                                                        @"event_name":@"ad_pay",		// 事件名称
                                                        @"event_value":@(648) 			// 支付金额                                                     
                                                     }
                            };
                                 
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

自定义游戏埋点

说明:按广告部门要求,自定义一些埋点事件,调用方式和上面已确定埋点调用一样,只不过,埋点的事件ID会变更、也可能包含其他参数;具体埋点事件ID和调用时机,以广告部门说明为准。


NSDictionary *parameters = @{
                                 @"event_id":@"广告部门指定的自定义事件埋点",               // 广告事件ID,必传
                                 @"gdt_event_value":@{
                                                        @"event_name":@"事件名称",		// 事件名称
                                                        @"event_value":@"事件值" 		 // 事件对应的值                                                     
                                                     }
                            };
                                 
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

今日头条埋点

打开游戏埋点

说明:在AppDelegate的- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions中调用,且必须在调用SuperSDK初始化接口后调用


NSDictionary *parameters = @{
                                 @"event_id":@"ad_open",                            // 广告事件ID,必传
                                 @"jrtt_event_value":@{
                                         				 @"event_name":@"ad_open",  // 事件名称
                                         			  }
                            };

[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

注册游戏埋点

说明:在注册接口后调用


NSDictionary *parameters = @{
                                 @"event_id":@"ad_register",                        	// 广告事件ID,必传
                                 @"jrtt_event_value":@{
                                         				 @"event_name":@"ad_register",  // 事件名称
                                         				 @"methodName":@"youzu",        // 注册方式,必传
                                         				 @"isSuccess":@"0"              // 是否注册成功,0:失败,1:成功,必传
                                        			  }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

升级游戏埋点

说明:在升级时调用


NSDictionary *parameters = @{
                                 @"event_id":@"ad_levelup",                        	   // 广告事件ID,必传
                                 @"jrtt_event_value":@{
                                         				 @"event_name":@"ad_levelup",  // 事件名称
                                              			 @"event_value":@(0)           // 等级数值,必传
                                        			  }
                            };
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

支付游戏埋点

说明:在支付接口后调用


NSDictionary *parameters = @{
                                 @"event_id":@"ad_pay",                            	  // 广告事件ID,必传
                                 @"jrtt_event_value":@{
					                                     @"event_name":@"ad_pay",     // 事件名称
					                                     @"type":@"be_null",          // 内容类型如“配备”、“皮肤”
					                                     @"contentName":@"be_null",   // 商品或内容名称
					                                     @"contentID":@"be_null",     // 商品或内容标识符
					                                     @"number":@(1),              // 商品数量
					                                     @"channel":@"be_null",       // 支付渠道名,如支付宝、微信等
					                                     @"currency":@"CNY",          // 真实货币类型,ISO 4217代码,如:“USD”
					                                     @"amount":@(1),              // 本次支付的真实货币的金额,大于0的整数,必传
					                                     @"isSuccess":@"0"            // 支付是否成功,0:失败,1:成功
                                         			  }
                            };
                                 
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

自定义游戏埋点

说明:按广告部门要求,自定义一些埋点事件,调用方式和上面已确定埋点调用一样,只不过,埋点的事件ID会变更、也可能包含其他参数;具体埋点事件ID和调用时机,以广告部门说明为准。


NSDictionary *parameters = @{
                                 @"event_id":@"广告部门指定的自定义事件埋点",               // 广告事件ID,必传
                                 @"jrtt_event_value":@{
                                                         @"event_name":@"事件名称",		// 事件名称
                                                         @"event_value":@"事件值" 		 // 事件对应的值                                                     
                                                      }
                            };
                                 
[SuperSDK invoke:BCORE_MODULE_ADVERT funcName:BCORE_FUNC_TRACK parameters:parameters];

辅助常量一览

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