Mobile Platform as a Service:API リファレンス

プロモーションAPI

プロモーションインターフェースクラス

このクラスは、プロモーション機能の統合エントリーポイントです。このクラスの API を呼び出して、プロモーション関連の機能を実装します。

@interface CDPPromotionInterface : NSObject
@end

コンポーネントの起動

API定義

+ (void)start;

説明

MCDP コンポーネントを起動します。これにより、すべてのプロモーションデータを初期化し、リソース画像をプリロードします。

例

[CDPPromotionInterface start];

MCDPコンポーネントのバージョン確認

API定義

+ (NSString *)sdkVersion;

説明

MCDP コンポーネントのバージョン番号を返します。

対応バージョン：この API はバージョン 3.0.0 以降で利用できます。

例

NSString cdpVersion = [CDPPromotionInterface sdkVersion];

広告共有イベントのレポート

API定義

+ (NSString *)reportShareAdAction;

説明

広告共有イベントをレポートし、MCDP コンソールのキャンペーンパフォーマンスページに広告共有データを表示できるようにします。レポートされるデータには、広告共有数と、広告を共有したユニークデバイス数が含まれます。広告共有数は、特定期間内にキャンペーンランディングページ上の広告が共有された合計回数です。ユニークデバイス数は、特定期間内にキャンペーンランディングページで共有ボタンをクリックしたデバイスの重複排除後の合計数です。広告共有データの表示方法の詳細については、「キャンペーンパフォーマンスの表示」をご参照ください。

対応バージョン：この API はバージョン 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	いいえ	MCDP が内部的に位置情報を使用するかどうかを指定します。デフォルト値は NO で、位置情報を使用しないことを意味します。

例

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

スプラッシュスクリーンAPI

MCDP は、スプラッシュスクリーンのロジック用の C 言語メソッドを提供します：

1. スプラッシュスクリーンを表示するかどうかの判定

2. スプラッシュスクリーンを開く

3. スプラッシュスクリーンを閉じる通知を送信

スプラッシュスクリーンを表示するかどうかの判定

API定義

BOOL splashScreenExist(BOOL shouldShowSplashScreen);

説明

ユーザー定義のルールと MCDP の内部ルールに基づき、スプラッシュスクリーンを表示するかどうかを判定します。

パラメーターの説明

パラメーター	型	必須	説明
shouldShowSplashScreen	BOOL	はい	ユーザー定義のルールに基づき、スプラッシュスクリーンを表示するかどうかを指定します。

例

BOOL shouldShowSplash = YES;
// スプラッシュスクリーン広告が必要かどうかを判定するロジック....
shouldShowSplash = splashScreenExist(shouldShowSplash);

スプラッシュスクリーンを開く

API定義

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

説明

スプラッシュスクリーンを開き、スプラッシュスクリーン広告を表示します。

パラメーターの説明

パラメーター	型	必須	説明
dismiss	block	はい	スプラッシュスクリーンが閉じたときのコールバックブロックです。

戻り値の説明

パラメーター	説明
UIWindow	作成されるスプラッシュスクリーンのウィンドウです。

例

UIWindow *splashWindow = APSplashScreenStart(^{
    // スプラッシュスクリーンが閉じたときのコールバック
    // 何らかの処理を実行します...
});

スプラッシュスクリーンを閉じる通知

API定義

void APWillKillSplashScreen(void);

説明

フレームワークの起動と読み込みが完了した後、このAPIを呼び出して、スプラッシュスクリーンがまもなく閉じることをフレームワークに通知します。通知の送信後、スプラッシュスクリーンは直ちに閉じない場合があります。

例

APWillKillSplashScreen();