リワード広告クラスの説明

AdfurikunMovieReward

コンストラクタ

AdfurikunMovieReward(appId: String?, activity: Activity?, isStartAutoLoad: Boolean = true)

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

isStartAutoLoadは広告枠設定が、自動モードの際に利用されます。
引数にTrueに設定すると自動的にロードが開始され、Falseに設定するとload関数が呼ばれた際にロードが開始されます。

プロパティ

val isPrepared: Boolean

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

---

val isPlaying: Boolean

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

---

val isTestMode: Boolean

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

---

インスタンスメソッド

fun setAdfurikunMovieObjectListener(listener: AdfurikunMovieObjectListener<MovieData>?)

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

---

fun load()
fun loadWithTimeout(timeout: Float)

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

Timeoutが設定されていると広告読み込みの結果Callbackは必ずTimeout以内に発生します。Timeout設定について詳細内容はリワード広告実装のベストプラクティスを確認してください。

---

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

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

パラメータ	説明
customParams	イベントにcustomParams情報が送信されます

---

fun onDestroy()

状態管理の破棄を行います。 ActivityのonDestroy()、もしく 明示的に破棄したい時に実行してください。実行後に再開することはできません。必ず動画リワードインスタンスを破棄してください。

---

fun rewardCompleted(result: Boolean)

広告再生後、成果報酬としてReward処理がアプリケーションで完了した場合、この関数を呼び出すことでアドフリくんのイベントとして送信することができます。当機能は必要に応じて呼び出すことで、必要性についてはお問い合わせください。

イベント送信に成功した場合trueを返します。

パラメータ	説明
result	Reward処理に成功したかどうか

---

fun notReadyAlert()

アプリケーションが広告を再生しようとする際、広告の準備が間に合わなかった時にアドフリくんのイベントとして送信することができます。当機能は必要に応じて呼び出すことで、必要性についてはお問い合わせください。

イベント送信に成功した場合trueを返します。

---

AdfurikunMovieRewardListener

fun onPrepareSuccess(isManualMode: Boolean)

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

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

---

fun onStartPlaying(data: MovieRewardData)

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

パラメータ	説明
data	データ

MovieRewardData

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

---

fun onFinishedPlaying(data: MovieRewardData)

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

パラメータ	説明
data	データ

---

fun onAdClose(data: MovieRewardData)

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

パラメータ	説明
data	データ

---

fun onPrepareFailure(error: AdfurikunMovieError?)

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

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

タイプ	コード	内容
NO_AD	0	広告の在庫がない場合
NO_NETWORK	1	オフラインまたはフライトモードの場合
LOADING	2	広告読み込み中の場合
API_REQUEST_FAILURE	4	配信設定の取得に失敗した場合

---

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

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

パラメータ	説明
data	データ
error	エラー情報
error.adNetworkErrorList	アドネットワークから発生したエラー内容です。詳細はアドネットワーク別エラーコード情報

タイプ	コード	内容
PLAYER_ITEM_PLAY_FAILURE	7	再生失敗した場合

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

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

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