全部产品
云市场
云游戏

API 接口说明

更新时间:2020-05-15 14:52:51

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

投放接口类

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

  1. @interface CDPPromotionInterface : NSObject
  2. @end

启动组件接口

接口定义

  1. + (void)start;

接口描述

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

使用示例

  1. [CDPPromotionInterface start];

查看 CDP 组件版本

接口定义

  1. + (NSString *)sdkVersion;

接口描述

  • 通过调用该接口,查看智能投放组件的版本号。
  • 适用版本:该接口在 3.0.0 版本以上开放。

使用示例

  1. NSString cdpVersion = [CDPPromotionInterface sdkVersion];

上报分享广告事件

接口定义

  1. + (NSString *)reportShareAdAction;

接口描述

  • 通过调用该接口,上报广告的分享事件,以便分享数据在控制台大盘中查看。
  • 适用版本:该接口在 3.0.0 版本以上开放。

使用示例

  1. [CDPPromotionInterface reportShareAdAction];

投放属性

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

属性定义

  1. @interface CDPPromotionInterface : NSObject
  2. // 用户配置项
  3. @property (nonatomic, strong) NSString* loginNotificationName; // 登录的通知名称, 默认为空
  4. @property (nonatomic, strong) NSString* logoutNotificationName; // 登出的通知名称, 默认为空
  5. @property (nonatomic, assign) BOOL useLbsInfo; // 是否使用定位信息,默认为 NO
  6. @end

属性说明

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

使用示例

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

启动页相关 API

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

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

判断是否展示启动页

接口定义

  1. BOOL splashScreenExist(BOOL shouldShowSplashScreen);

接口描述

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

参数说明

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

使用示例

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

打开启动页

接口定义

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

接口描述

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

参数说明

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

返回值说明

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

使用示例

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

通知关闭启动页

接口定义

  1. void APWillKillSplashScreen(void);

接口描述

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

使用示例

  1. APWillKillSplashScreen();