リワード広告クラスの説明 - glossom-dev/AdfurikunSDK-Android GitHub Wiki
AdfurikunMovieReward(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 setAdfurikunMovieObjectListener(listener: AdfurikunMovieObjectListener<MovieData>?)
パラメータ | 説明 |
---|---|
listener |
リスナーオブジェクト |
fun load()
fun loadWithTimeout(timeout: Float)
各アドネットワークの広告ロードを開始します。
loadWithTimeout
関数でロードした場合、広告の取得結果に関するコールバック
(AdfurikunMovieRewardListener.onPrepareSuccess
またはonPrepareFailure
)は、
必ずtimeout
引数で設定された時間内に呼び出されます。詳細はベストプラクティスをご確認ください。
パラメータ | 説明 |
---|---|
timeout |
ロードの成否が確定するまでの時間(単位:秒) 設定可能な範囲は 0.1f ~ 60.0f |
fun play()
fun play(customParams: Map<String, String>?)
広告を表示します。再生準備が完了したアドネットワークの中から、1つ広告が選択されます。
パラメータ | 説明 |
---|---|
customParams |
任意の値をセットすることで、その値をアドフリくんのサーバーにログとして送信できます。 ※本機能は必要に応じて使用してください。機能の必要性については、サポートにお問い合わせください。 |
fun onDestroy()
状態管理の破棄を行います。
ActivityのonDestroy()
メソッド内で実行するか、あるいは明示的に破棄したい時に実行してください。
fun rewardCompleted(result: Boolean)
広告再生完了後に、ユーザーに対する成果報酬(リワード)処理がアプリケーションで正常に完了した場合、
この関数を呼び出すことで、アドフリくんのサーバーにログを送信できます。
ログ送信に成功した場合、trueを返します。
※本機能は必要に応じて使用してください。
機能の必要性については、サポートにお問い合わせください。
パラメータ | 説明 |
---|---|
result |
成果報酬(リワード)処理がアプリケーションで正常に完了したか |
fun notReadyAlert()
広告を再生しようとした際に、広告の準備が間に合わず再生失敗してしまった場合、
この関数を呼び出すことで、アドフリくんのサーバーにログを送信できます。
ログ送信に成功した場合、trueを返します。
※本機能は必要に応じて使用してください。
機能の必要性については、サポートにお問い合わせください。
fun onPrepareSuccess(isManualMode: Boolean)
広告のロード成功時に呼ばれます。
パラメータ | 説明 |
---|---|
isManualMode |
ロードモード(true:自動モード、false:手動モード) |
fun onStartPlaying(data: MovieRewardData)
広告の再生開始時に呼ばれます。
パラメータ | 説明 |
---|---|
data |
データ |
プロパティ | 説明 |
---|---|
adnetworkKey |
アドネットワークキー |
adnetworkName |
アドネットワーク名 |
fun onFinishedPlaying(data: MovieRewardData)
広告を最後まで視聴した時に呼ばれます。(アドネットワークによって呼ばれるタイミングが異なる場合がございます)
パラメータ | 説明 |
---|---|
data |
データ |
fun onAdClose(data: MovieRewardData)
広告を閉じた時に呼ばれます。
パラメータ | 説明 |
---|---|
data |
データ |
fun onPrepareFailure(error: AdfurikunMovieError?)
広告ロード失敗時に呼ばれます。
パラメータ | 説明 |
---|---|
error |
エラー情報 詳細はエラーコードリファレンスをご参照ください |
fun onFailedPlaying(data: MovieRewardData, error: AdfurikunMovieError?)
動画の再生が失敗した場合に呼ばれます。
パラメータ | 説明 |
---|---|
data |
データ |
error |
エラー情報 詳細はエラーコードリファレンスをご参照ください |
再生失敗が発生する理由は以下が考えられます。
発生理由 |
---|
既に広告を再生している |
オフライン状態でPlay関数を実行した |
アドネットワークの広告再生関数の呼び出し時に異常が発生した |
アドネットワーク側で広告再生時のエラーを検知した |
この関数が呼ばれた際は、onFinishedPlaying
,onAdClose
は呼ばれません。
必要に応じて、再度広告読み込みを行ってください。