AdfurikunInter

コンストラクタ

AdfurikunInter(appId: String?, activity: Activity?, isStartAutoLoad: Boolean)

パラメータ	説明
appId	広告枠ID
activity	広告を表示するActivity
isStartAutoLoad	自動モード開始フラグ

次の条件を両方満たした場合、インタースティシャル広告のロードモードは「自動モード」になります。 それ以外の場合は「手動モード」になります。

• アドフリくんの管理画面にて、対象の広告枠のロードモードが「自動」に設定されている。
• isStartAutoLoadがtrueである。

手動モードでは、load関数が呼ばれた際に初めてアドネットワークから広告の取得を試みます。 自動モードでは、load関数を呼び出さなくても、アプリ起動中に自動的に広告が取得されます。

[!WARNING] ロードモードが「自動モード」に設定されている場合、端末への負荷や通信量が著しく増加する可能性があります。 そのため、現在アドフリくんでは「手動モード」のみを推奨しております。

プロパティ

val isPrepared: Boolean

広告が準備完了したかを返します。

---

val isPlaying: Boolean

広告が再生中かを返します。

---

val isTestMode: Boolean

テストモードかを返します。

---

インスタンスメソッド

fun setAdfurikunInterListener(listener: AdfurikunInterListener?)

パラメータ	説明
listener	リスナーオブジェクト

---

fun load()
fun loadWithTimeout(timeout: Float)

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

loadWithTimeout関数でロードした場合、広告の取得結果に関するコールバック (AdfurikunInterListener.onPrepareSuccessまたはonPrepareFailure)は、 必ずtimeout引数で設定された時間内に呼び出されます。詳細はベストプラクティスをご確認ください。

パラメータ	説明
timeout	ロードの成否が確定するまでの時間（単位：秒）設定可能な範囲は 0.1f ~ 60.0f

---

fun play()
fun play(customParams: Map<String, String>?)

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

パラメータ	説明
customParams	任意の値をセットすることで、その値をアドフリくんのサーバーにログとして送信できます。※本機能は必要に応じて使用してください。機能の必要性については、サポートにお問い合わせください。

---

fun onDestroy()

状態管理の破棄を行います。 ActivityのonDestroy()メソッド内で実行するか、あるいは明示的に破棄したい時に実行してください。

---

AdfurikunInterListener

fun onPrepareSuccess(isManualMode: Boolean)

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

パラメータ	説明
isManualMode	ロードモード（True：自動モード、False：手動モード）

---

fun onStartPlaying(data: InterData)

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

パラメータ	説明
data	データ

InterData

プロパティ	説明
adnetworkKey	アドネットワークキー
adnetworkName	アドネットワーク名

---

fun onFinishedPlaying(data: InterData)

広告を最後まで視聴した時に呼ばれます。(アドネットワークによって呼ばれるタイミングが異なる場合がございます)

パラメータ	説明
data	データ

---

fun onAdClose(data: InterData)

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

パラメータ	説明
data	データ

---

fun onPrepareFailure(error: AdfurikunMovieError?)

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

パラメータ	説明
error	エラー情報詳細はエラーコードリファレンスをご参照ください

---

fun onFailedPlaying(data: InterData, error: AdfurikunMovieError?)

動画の再生が失敗した場合に呼ばれます。

パラメータ	説明
data	データ
error	エラー情報詳細はエラーコードリファレンスをご参照ください

再生失敗が発生する理由は以下が考えられます。

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

この関数が呼ばれた際は、onFinishedPlaying,onAdCloseは呼ばれません。 必要に応じて、再度広告読み込みを行ってください。