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

配信 API

配信 API クラス

配信 API クラスは、配信機能の統合されたエントリポイントです。このクラスの操作を呼び出して、関連する MCDP 機能を実装できます。

@interface CDPPromotionInterface : NSObject
@end

コンポーネントの起動

API 定義

+ (void)start;

API の説明

この操作を呼び出すと、すべての配信データの初期化とリソース画像の事前追加など、MCDP コンポーネントを起動できます。

例

[CDPPromotionInterface start];

MCDP コンポーネントのバージョンを表示する

API 定義

+ (NSString *)sdkVersion;

API の説明

この操作を呼び出すと、MCDP コンポーネントのバージョン番号を表示できます。

適用バージョン：この API はバージョン 3.0.0 以上で使用できます。

例

NSString cdpVersion = [CDPPromotionInterface sdkVersion];

広告共有イベントをレポートする

API 定義

+ (NSString *)reportShareAdAction;

API の説明

この操作を呼び出すと、広告共有イベントをレポートできるため、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

プロパティの説明

例

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

スタートアップページ API

MCDP は、スタートアップページに関連するロジックを実行するための一連の C プログラミング言語のメソッドを提供します。これには以下が含まれます。

1. スタートアップページを表示するかどうかを判断する。

2. スタートアップページを開く。

3. スタートアップページが閉じられることを通知する。

スタートアップページを表示するかどうかを判断する

API 定義

BOOL splashScreenExist(BOOL shouldShowSplashScreen);

API の説明

ユーザー定義ルールと MCDP 内部ルールに基づいて、スタートアップページを表示する必要があるかどうかを判断します。

パラメーター

例

BOOL shouldShowSplash = YES;
// スタートアップページに広告を表示するかどうか。
shouldShowSplash = splashScreenExist(shouldShowSplash);

スタートアップページを開く

API 定義

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

API の説明

スタートアップページを開き、スタートアップページの広告を表示します。

パラメーター

戻り値

例

UIWindow *splashWindow = APSplashScreenStart(^{
    // スタートアップページを閉じるコールバック。
    // 何かを実行します。
});

スタートアップページの終了通知を送信する

API 定義

void APWillKillSplashScreen(void);

API の説明

フレームワークの起動がロードされた後、フレームワークにスタートアップページがまもなく閉じられることを通知します。通知後、スタートアップページはすぐに閉じられない場合があります。

例

APWillKillSplashScreen();