移动开发平台 mPaaS API 说明

本文档对智能投放组件的接口以及启动页接口进行说明。

投放相关 API

投放接口类

为投放功能的统一入口，调用类中的接口，实现智能投放的相关功能。

  

   
@interface CDPPromotionInterface : NSObject
   
@end
  

启动组件

接口定义

  

   
+ (void)start;
  

接口描述

通过调用该接口，启动智能投放组件，包括初始化所有投放数据、预加资源图片等操作。

使用示例

  

   
[CDPPromotionInterface start];
  

查看 CDP 组件版本

接口定义

  

   
+ (NSString *)sdkVersion;
  

接口描述

通过调用该接口，查看智能投放组件的版本号。

适用版本：该接口在 3.0.0 及以上版本开放。

使用示例

  

   
NSString cdpVersion = [CDPPromotionInterface sdkVersion];
  

上报分享广告事件

接口定义

  

   
+ (NSString *)reportShareAdAction;
  

接口描述

通过调用该接口，上报广告分享事件，以便在 CDP 控制台的活动效果页面上展示广告分享数据，包括广告分享次数和广告分享设备量。分享次数指某段时间内活动落地页上广告被点击分享的次数；分享设备量指某段时间内活动落地页上点击了分享按钮的设备去重总量。有关广告分享数据的展示，请 查看活动效果。

适用版本：该接口在 3.0.0 及以上版本开放。

使用示例

  

   
[CDPPromotionInterface reportShareAdAction];
  

投放属性

配置投放属性，包括登录通知名称、登出通知名称和是否使用定位信息。

属性定义

  

   
@interface CDPPromotionInterface : NSObject
   

   
// 用户配置项
   
@property (nonatomic, strong) NSString* loginNotificationName; // 登录的通知名称, 默认为空
   
@property (nonatomic, strong) NSString* logoutNotificationName; // 登出的通知名称, 默认为空
   
@property (nonatomic, assign) BOOL useLbsInfo; // 是否使用定位信息，默认为 NO
   

   
@end
  

属性说明

参数名	类型	是否必需	说明
loginNotificationName	NSString	否	登录的通知名称，默认为空，CDP 内部会根据登录的通知刷新对应用户的投放内容。
logoutNotificationName	NSString	否	登出的通知名称，默认为空，CDP 内部会根据登出的通知清理缓存的投放数据。
useLbsInfo	BOOL	否	CDP 内部是否使用定位信息，默认为 NO，表示不使用。

使用示例

  

   
[CDPPromotionInterface sharedInstance].loginNotificationName = @"xxxx";
  

启动页相关 API

CDP 提供一系列 C 方法来执行启动页相关的逻辑。包括：

1. 判断是否展示启动页
2. 打开启动页
3. 通知关闭启动页

判断是否展示启动页

接口定义

  

   
BOOL splashScreenExist(BOOL shouldShowSplashScreen);
  

接口描述

根据用户自定义的规则以及 CDP 内部的规则，判断是否需要展示启动页。

参数说明

参数名	类型	是否必需	说明
shouldShowSplashScreen	BOOL	是	用户根据自定义规则，判断是否需要展示启动页。

使用示例

  

   
BOOL shouldShowSplash = YES;
   
// 是否需要启动页广告逻辑....
   
shouldShowSplash = splashScreenExist(shouldShowSplash);
  

打开启动页

接口定义

  

   
UIWindow * APSplashScreenStart(void (^dismiss)(void));
  

接口描述

打开启动页并展示启动页广告。

参数说明

参数名	类型	是否必需	说明
dismiss	block	是	启动页关闭的回调 block。

返回值说明

参数名	说明
UIWindow	创建好的启动页 window。

使用示例

  

   
UIWindow *splashWindow = APSplashScreenStart(^{
   
 // 启动页关闭的回调
   
 // do something ...
   
});
  

通知关闭启动页

接口定义

  

   
void APWillKillSplashScreen(void);
  

接口描述

在框架启动加载完成后，通知框架启动页即将关闭。通知后，不一定立刻关闭启动页。

使用示例

  

   
APWillKillSplashScreen();