ADFmyAppOpenAd

クラスメソッド

+ (BOOL)isSupportedOSVersion;

サポート対象のiOSバージョンの場合trueを返します。

---

+ (void)initializeWithAppID:(NSString *)appID;
+ (void)initializeWithAppID:(NSString *)appID appLogoImage:(UIImage * __nullable)image;

パラメータ	説明
appID	対象の広告枠ID
appLogoImage	広告に画像のロゴを表示します。(Pangle,Mintegralのみ対応)

アプリ起動時広告の初期化を行います。

---

+ (ADFmyAppOpenAd *)getInstance:(NSString *)appID delegate:(id<ADFmyAppOpenAdDelegate>)delegate;

パラメータ	説明
appID	対象の広告枠ID
delegate	デリゲート(後述)を実装したクラスのインスタンス

アプリ起動時広告のインスタンスを受け取ります。

インスタンスメソッド

-(void)loadWithTimeout:(float)timeout;

各アドネットワークの広告ロードを開始します。

timeoutでは0.1~60.0秒までの値を設定出来ます。広告読み込みの結果Callbackは必ずtimeout以内に発生します。Timeout設定について詳細内容はベストプラクティスを確認してください。

---

-(BOOL)isPrepared;

広告が表示できる状態の場合trueを返します。

---

- (void)playWithPresentingViewController:(UIViewController *)viewController window:(UIWindow * __nullable)window;

パラメータ	説明
viewController	アプリ最前面viewのUIViewController
window	アプリのkey window

広告を表示します。再生準備が完了したアドネットワークの中から、1つ動画が選択されます。

---

-(void)dispose;

アドフリくんSDKに保持されたADFmyAppOpenAdインスタンスを破棄します。ADFmyAppOpenAdインスタンスを使わなくなった場合、dispose関数を呼び出して下さい。

---

ADFmyAppOpenAdDelegate

- (void)AdsFetchCompleted:(NSString *)appID;

パラメータ	説明
appId	広告枠ID

広告のロード成功時に呼ばれます。

---

- (void)AdsDidShow:(NSString *)appID adNetworkKey:(NSString *)adNetworkKey;

パラメータ	説明
appID	広告枠ID
adnetworkKey	再生を開始したアドネットワークのアドネットワークキー

広告の再生開始時に呼ばれます。

---

- (void)AdsDidHide:(NSString *)appID;

パラメータ	説明
appID	広告枠ID

広告を閉じた時に呼ばれます。

---

- (void)AdsFetchFailed:(NSString *)appID error:(NSError *)error;
- (void)AdsFetchFailed:(NSString *)appID error:(NSError *)error adnetworkError:(NSArray<AdnetworkError *> *)adnetworkError;

パラメータ	説明
appID	広告枠ID
error	エラー情報
adnetworkError	アドネットワークから発生したエラー内容です。詳細はアドネットワーク別エラーコード情報

error.code	説明	対応方法
203	ADNWから在庫が返却されなかった場合	広告取得に失敗するケース を確認する アドフリくん担当者に在庫状況を確認してもらう時間をおいて読み込みをリトライするように実装する
400	配信設定において利用可能なADNWが一つもなかった場合	広告取得に失敗するケース を確認する
500	配信設定の取得に失敗した場合	端末のネットワーク状況を確認する
999	前回のLoadingがまだ完了してない場合	読み込み成功・失敗Callbackが発生した後再度読み込みをするように実装変更
1000	広告枠で設定されているFrequency条件を満たしてない場合	Frequency設定通りに動作しているかを確認する。問題があれば問い合わせする

広告ロード失敗時に呼ばれます。

---

- (void)AdsPlayFailed:(NSString *)appID;
- (void)AdsPlayFailed:(NSString *)appID adnetworkError:(AdnetworkError *)adnetworkError;

パラメータ	説明
appID	広告枠ID
adnetworkError	アドネットワークから発生したエラー内容です。詳細はアドネットワーク別エラーコード情報

動画の再生が失敗した場合に呼ばれます。発生理由は以下が考えられます。

発生理由
既に広告を再生している
オフライン状態でPlay関数を実行した
アドネットワークの広告再生関数の呼び出し時に異常が発生した
アドネットワーク側で広告再生時のエラーを検知した

この関数が呼ばれた際は、AdsDidHide は呼ばれません。アプリの実装に応じて必要であれば再度広告読み込みを行ってください。