インフィード広告クラスの説明 - glossom-dev/AdfurikunSDK-iOS GitHub Wiki
ADFmyNativeAd
クラスメソッド
+ (BOOL)isSupportedOSVersion;
サポート対象のiOSバージョンの場合trueを返します。
+ (void)initializeWithAppID:(NSString *)appID;
+ (void)initializeWithAppID:(NSString *)appID option:(NSDictionary*)option;
| パラメータ | 説明 |
|---|---|
appID |
対象の広告枠ID |
アドフリくんインフィード広告の初期化を行います。 (既に読込開始している広告枠を指定した場合は、既存の読込が継続されます。)
+ (instancetype)createInstance:(NSString *)appID;
| パラメータ | 説明 |
|---|---|
appID |
対象の広告枠ID |
アドフリくんインフィード広告のインスタンスを受け取ります。
+ (void)removeAllWebViewData;
WKWebViewのデータを全て削除します。 WKWebViewのキャッシュを削除することでアプリの容量を減らすことが出来ます。
インスタンスメソッド
- (void)setLoadingTimeout:(float)timeout;
広告読み込みのTimeoutを設定します。Timeoutが設定されると、広告読み込みの結果Callbackは必ずTimeout以内に発生します。Timeout設定について詳細内容はベストプラクティスを確認してください。
- (void)loadAndNotifyTo:(id<ADFmyNativeAdDelegate> _Nullable)delegate;
- (void)loadAndNotifyTo:(id<ADFmyNativeAdDelegate> _Nullable)delegate customParam:(NSDictionary * _Nullable)param;
| パラメータ | 説明 |
|---|---|
delegate |
対象の広告枠ID |
param |
イベントにparam情報が送信されます |
各アドネットワークの広告ロードを開始します。
-(void)dispose;
アドフリくんSDKに保持されたインフィード広告インスタンスを破棄します。インフィード広告を表示している画面から遷移するなどインフィード広告インスタンスを使わなくなった場合、dispose関数を呼び出して下さい。
ADFmyNativeAdDelegate
- (void)onNativeAdLoadFinish:(ADFNativeAdInfo *)info appID:(NSString *)appID;
| パラメータ | 説明 |
|---|---|
info |
広告の情報を格納したオブジェクト |
appID |
対象の広告枠ID |
ADFNativeAdInfo
| プロパティ | 型 | Null可能 | 説明 |
|---|---|---|---|
title |
NSString |
Null可能 | 広告のタイトル |
desc |
NSString |
Null可能 | 広告の説明文 |
mediaView |
ADFMediaView |
Null不可 | 広告View |
adnetworkKey |
NSString |
Null不可 | 取得したアドネットワークのキー |
mediaType |
ADFNativeAdType |
Null不可 | 取得したMediaの種類（Movie, Image） |
- (void)onNativeAdLoadError:(ADFMovieError *)error appID:(NSString *)appID;
- (void)onNativeAdLoadError:(ADFMovieError *)error appID:(NSString *)appID adnetworkError:(NSArray<AdnetworkError *> *)adnetworkError;
| パラメータ | 説明 |
|---|---|
error |
再生を開始したアドネットワークのアドネットワークキー |
appID |
広告枠ID |
adnetworkError |
アドネットワークから発生したエラー内容です。詳細はアドネットワーク別エラーコード情報 |
エラーコードの詳細
| タイプ | コード | 内容 | 対応方法 |
|---|---|---|---|
ADFMovieError_NoStock |
0 | 広告の在庫がない場合 | 広告取得に失敗するケース を確認する アドフリくん担当者に在庫状況を確認してもらう時間をおいて読み込みをリトライするように実装する |
ADFMovieError_NetworkDisconnect |
1 | オフラインまたはフライトモードの場合 | 端末のネットワーク状況を確認する |
ADFMovieError_InvalidAppId |
2 | 広告IDが登録されている内容と異なる場合 | 広告IDを確認する |
ADFMovieError_ApiRequestFailure |
3 | リクエストが失敗した場合 | 端末のネットワーク状況を確認するアドフリくん担当者に問い合わせする |
ADFMovieError_UnsupportedOSVersion |
4 | サポートしないOSバージョンの場合 | 端末のOSバージョンがiOS11以上かをチェックする |
ADFMovieError_PlayerItemLoadFailure |
5 | 広告の読み込みが失敗した場合 | 広告の再生が失敗した場合 |
ADFMovieError_PlayerItemPlayFailure |
6 | 広告の再生が失敗した場合 | 継続して発生する場合アドフリくん担当者に問い合わせする |
ADFMovieError_Other |
7 | その他の予期せぬエラーが発生した場合 | アドフリくん担当者に問い合わせする |
ADFMediaViewDelegate
- (void)onADFMediaViewPlayStart;
広告の再生開始時に呼ばれます
- (void)onADFMediaViewPlayFinish;
広告の再生が終了時に呼ばれます
- (void)onADFMediaViewPlayFail;
広告の表示時にアドネットワーク側でエラーを検知した際に呼ばれます。アプリの実装に応じて必要であれば再度広告読み込みを行ってください。