全部產品
Search
文件中心

Mobile Platform as a Service:API 說明

更新時間:Jul 13, 2024

本文檔對智能投放(MCDP)組件的介面以及啟動頁介面進行說明。

投放相關 API

投放介面類

為投放功能的統一入口,調用類中的介面,實現智能投放的相關功能。

@interface CDPPromotionInterface : NSObject
@end

啟動組件

介面定義

+ (void)start;

介面描述

通過調用該介面,啟動智能投放組件,包括初始化所有投放資料、預加資源圖片等操作。

使用樣本

[CDPPromotionInterface start];

查看 MCDP 組件版本

介面定義

+ (NSString *)sdkVersion;

介面描述

通過調用該介面,查看智能投放組件的版本號碼。

適用版本:該介面在 3.0.0 及以上版本開放。

使用樣本

NSString cdpVersion = [CDPPromotionInterface sdkVersion];

上報分享廣告事件

介面定義

+ (NSString *)reportShareAdAction;

介面描述

通過調用該介面,上報廣告分享事件,以便在 MCDP 控制台的活動效果頁面上展示廣告分享資料,包括廣告分享次數和廣告分享裝置量。分享次數指某段時間內活動落地頁上廣告被點擊分享的次數;分享裝置量指某段時間內活動落地頁上點擊了分享按鈕的裝置去重總量。有關廣告分享資料的展示,請 查看活動效果

適用版本:該介面在 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

登入的通知名稱,預設為空白,MCDP 內部會根據登入的通知重新整理對應使用者的投放內容。

logoutNotificationName

NSString

登出的通知名稱,預設為空白,MCDP 內部會根據登出的通知清理緩衝的投放資料。

useLbsInfo

BOOL

CDP 內部是否使用定位資訊,預設為 NO,表示不使用。

使用樣本

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

啟動頁相關 API

MCDP 提供一系列 C 語言方法來執行啟動頁相關的邏輯。包括:

  1. 判斷是否展示啟動頁

  2. 開啟啟動頁

  3. 通知關閉啟動頁

判斷是否展示啟動頁

介面定義

BOOL splashScreenExist(BOOL shouldShowSplashScreen);

介面描述

根據使用者自訂的規則以及 MCDP 內部的規則,判斷是否需要展示啟動頁。

參數說明

參數

類型

是否必需

說明

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();