-
Notifications
You must be signed in to change notification settings - Fork 2
API Reference
+ sdkVersion
+ startWithMediaId:delegate:
+ setAdTestMode:
+ setDelegate:
+ canShow
+ canShowAtZoneId:
+ show DEPRECATED
+ showAtZoneId: DEPRECATED
Advanced
+ startWithNonDefaultMediaId:delegate:
+ showWithViewController:
+ showAtZoneId:vc:
- maioDidInitialize
- maioDidChangeCanShow:newValue:
- maioWillStartAd:
- maioDidFinishAd:playtime:skipped:rewardParam:
- maioDidClickAd:
- maioDidCloseAd:
- maioDidFail:reason:
Advanced
mediaId
adTestMode
delegate
- canShow
- canShowAtZoneId:
- show DEPRECATED
- showAtZoneId: DEPRECATED
- showWithViewController:
- showAtZoneId:vc:
maio SDK のバージョンを返します。
v1.0.7 以降
+ (NSString *)sdkVersionSDK の初期化を開始します。
+ (void)startWithMediaId:(NSString *)mediaId delegate:(id<MaioDelegate>)delegate-
mediaId
管理画面にて発行されるアプリ識別子
-
delegate
SDK からの通知を受け取るデリゲート。通知を受け取る必要がない場合は nil を渡します。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 広告の配信テスト設定を行います。
[Maio setAdTestMode:YES];
// SDK の初期化を開始します。
[Maio startWithMediaId:MAIO_MEDIA_ID delegate:nil];
return YES;
}広告の配信テストを行うかどうかを設定します。
+ (void)setAdTestMode:(BOOL)adTestMode-
adTestMode
広告のテスト配信を行う場合には YES、それ以外なら NO。
アプリ開発中は YES にし、ストアに提出する際には NO にして下さい（既定値は NO）。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 広告の配信テスト設定を行います。
[Maio setAdTestMode:YES];
// SDK の初期化を開始します。
[Maio startWithMediaId:MAIO_MEDIA_ID delegate:nil];
return YES;
}maio SDK からの通知を受け取るデリゲートをセットします。
+ (void)setDelegate:(id<MaioDelegate>)delegate-
delegate
maio SDK から通知を受け取るデリゲート
既定のゾーンの広告表示準備が整っていれば YES、そうでなければ NO を返します。
+ (BOOL)canShow- (IBAction)onOpenAd:(id)sender {
// 動画広告を表示
if ([Maio canShow]) {
[Maio showWithViewController:self];
}
}指定したゾーンの広告表示準備が整っていれば YES、そうでなければ NO を返します。
+ (BOOL)canShowAtZoneId:(NSString *)zoneId-
zoneId
広告の表示準備が整っているか確認したいゾーンの識別子
- (IBAction)onOpenAd:(id)sender {
// 動画広告を表示
if ([Maio canShowAtZoneId:ZONE_ID]) {
[Maio showAtZoneId:MAIO_ZONE_ID vc:self];
}
}既定のゾーンの広告を表示します。
※v1.5.0からは非推奨です。showWithViewController:を使用してください。
+ (void)show指定したゾーンの広告を表示します。
※v1.5.0からは非推奨です。showAtZoneId:vc:を使用してください。
+ (void)showAtZoneId:(NSString *)zoneId-
zoneId
広告を表示したいゾーンの識別子
上級者向けメソッド
既定でない maio MediaId を使用して SDK の初期化を開始します。
主にサードパーティライブラリによって組み込まれる際に使用されます。
v1.1.0 以降
+ (MaioInstance *)startWithNonDefaultMediaId:(NSString *)mediaEid delegate:(id<MaioDelegate>)delegate-
mediaId
管理画面にて発行されるアプリ識別子
-
delegate
SDK からの通知を受け取るデリゲート。通知を受け取る必要がない場合は nil を渡します。
上級者向けメソッド
遷移元となる UIViewController を明示的に指定して、既定のゾーンの広告を表示します。
v1.0.1 以降
+ (void)showWithViewController:(UIViewController *)vc;-
vc
広告表示時に遷移元となる UIViewController インスタンス
- (IBAction)onOpenAd:(id)sender {
// 動画広告を表示
if ([Maio canShow]) {
[Maio showWithViewController:self];
}
}上級者向けメソッド
遷移元となる UIViewController を明示的に指定して、指定したゾーンの広告を表示します。
v1.0.1 以降
+ (void)showAtZoneId:(NSString *)zoneEid vc:(UIViewController *)vc;-
zoneId
広告を表示したいゾーンの識別子
-
vc
広告表示時に遷移元となる UIViewController インスタンス
- (IBAction)onOpenAd:(id)sender {
// 動画広告を表示
if ([Maio canShowAtZoneId:ZONE_ID]) {
[Maio showAtZoneId:MAIO_ZONE_ID vc:self];
}
}全てのゾーンの広告表示準備が完了したら呼ばれます。
- (void)maioDidInitialize
広告の配信可能状態が変更されたら呼ばれます。
- (void)maioDidChangeCanShow:(NSString *)zoneId newValue:(BOOL)newValue-
zoneId
広告の配信可能状態が変更されたゾーンの識別子
-
newValue
変更後のゾーンの状態。YES なら配信可能
- (void)maioDidChangeCanShow:(NSString *)zoneId newValue:(BOOL)newValue {
// 広告が表示可能ならトリガーを有効化
if ([ZONE_ID isEqualToString:zoneId]) {
self.startButton.enabled = newValue;
}
else if ([ZONE_ID_2 isEqualToString:zoneId]) {
self.start2Button.enabled = newValue;
}
}広告が再生される直前に呼ばれます。
最初の再生開始の直前にのみ呼ばれ、リプレイ再生の直前には呼ばれません。
- (void)maioWillStartAd:(NSString *)zoneId-
zoneId
広告が表示されるゾーンの識別子
広告の再生が終了したら呼ばれます。
最初の再生終了時にのみ呼ばれ、リプレイ再生の終了時には呼ばれません。
- (void)maioDidFinishAd:(NSString *)zoneId playtime:(NSInteger)playtime skipped:(BOOL)skipped rewardParam:(NSString *)rewardParam-
zoneId
広告を表示したゾーンの識別子
-
playtime
動画の再生時間（秒）
-
skipped
動画がスキップされていたら YES、それ以外なら NO
-
rewardParam
ゾーンがリワード型に設定されている場合、予め管理画面にて設定してある任意の文字列パラメータが渡されます。それ以外の場合は nil
- (void)maioDidFinishAd:(NSString *)zoneId playtime:(NSInteger)playtime skipped:(BOOL)skipped rewardParam:(NSString *)rewardParam {
// TODO: ユーザへのリワード付与処理
}広告がクリックされ、ストアや外部リンクへ遷移した時に呼ばれます。
- (void)maioDidClickAd:(NSString *)zoneId-
zoneId
広告がクリックされたゾーンの識別子
広告が閉じられた際に呼ばれます。
- (void)maioDidCloseAd:(NSString *)zoneId-
zoneId
広告が閉じられたゾーンの識別子
SDK 内でエラーを検知した際に呼ばれます。
発生タイミングは不定ですので、ログ出力やエラー計測以外の具体的な処理（ビジネスロジック等）を行わないで下さい。
- (void)maioDidFail:(NSString *)zoneId reason:(MaioFailReason)reason-
zoneId
エラーに関連するゾーンの識別子。
ネットワークエラーなどゾーンに紐づかないエラーの場合には nil が入ります。 -
reason
エラーの理由を示す列挙値
maio SDK のエラー種別（アプリ側への通知内容）
-
MaioFailReasonAdStockOut
広告在庫切れ
-
MaioFailReasonNetworkConnection
ネットワーク接続エラー
-
MaioFailReasonNetworkClient
HTTP status 4xx クライアントエラー
-
MaioFailReasonNetworkServer
HTTP status 5xx サーバーエラー
-
MaioFailReasonSdk
SDK エラー
-
MaioFailReasonDownloadCancelled
クリエイティブダウンロードのキャンセル
-
MaioFailReasonVideoPlayback
動画再生エラー
-
MaioFailReasonUnknown
不明なエラー
上級者向けクラス
v1.1.0 以降
設定した maio MediaId を返します。
@property (nonatomic, readonly) NSString *mediaId広告の配信テストを行うかどうかを取得または設定します。
@property (nonatomic) BOOL adTestModemaio SDK からの通知を受け取るデリゲートを取得または設定します。
@property (nonatomic) id<MaioDelegate> delegate- (BOOL)canShow- (BOOL)canShowAtZoneId:(NSString *)zoneId※v1.5.0からは非推奨です。showWithViewController:を使用してください。
- (void)show※v1.5.0からは非推奨です。showAtZoneId:vc:を使用してください。
- (void)showAtZoneId:(NSString *)zoneId- (void)showWithViewController:(UIViewController *)vc;- (void)showAtZoneId:(NSString *)zoneEid vc:(UIViewController *)vc;