インフィード広告クラスの説明 - glossom-dev/AdfurikunSDK-Android GitHub Wiki
AdfurikunNativeAd
コンストラクタ
AdfurikunNativeAd(activity: Activity?, private val mAppId: String?, width: Int = 320, height: Int = 180)
| パラメータ | 説明 |
|---|---|
activity |
広告を表示するActivity |
mAppId |
広告枠ID |
width |
広告の横幅 |
height |
広告の縦幅 |
プロパティ
val isPrepared: Boolean
広告が準備完了したかを返します。
val nativeAdView: View?
ネイティブ広告のビューを返します。
インスタンスメソッド
fun setAdfurikunNativeAdLoadListener(listener: AdfurikunNativeAdLoadListener?)
広告のロードの成功や失敗時に通知を受け取るリスナーを登録します。
| パラメータ | 説明 |
|---|---|
listener |
ロードコールバックを受け取るリスナーオブジェクト |
fun setAdfurikunNativeAdVideoListener(listener: AdfurikunNativeAdVideoListener?)
広告の再生やクリックに関する通知を受け取るリスナーを登録します。
| パラメータ | 説明 |
|---|---|
listener |
広告イベントコールバックを受け取るリスナーオブジェクト |
fun load()
fun loadWithTimeout(timeout: Float)
各アドネットワークの広告ロードを開始します。
loadWithTimeout関数でロードした場合、広告の取得結果に関するコールバック
(AdfurikunNativeAdLoadListener.onPrepareSuccessまたはonPrepareFailure)は、
必ずtimeout引数で設定された時間内に呼び出されます。詳細はベストプラクティスをご確認ください。
| パラメータ | 説明 |
|---|---|
timeout |
ロードの成否が確定するまでの時間（単位：秒）設定可能な範囲は 0.1f ~ 60.0f |
fun play()
fun play(customParams: Map<String, String>?)
広告を表示します。再生準備が完了したアドネットワークの中から、1つ動画が選択されます。
| パラメータ | 説明 |
|---|---|
customParams |
任意の値をセットすることで、アドフリくんのサーバーにログとして送信できます。※本機能は必要に応じて使用してください。機能の必要性については、サポートにお問い合わせください。 |
fun remove()
状態管理の破棄を行います。
ActivityのonDestroy()メソッド内で実行するか、あるいは明示的に破棄したい時に実行してください。
fun releaseNativeAdView()
広告ビューを解放します。
fun setIsAutoCenterAlign(autoCenterAlign: Boolean)
trueを設定すると広告が中央に表示されます。
fun changeAdSize(width: Int, height: Int)
広告のサイズを変更します。
fun pauseByOperation()
広告の再生を一時停止します
AdfurikunNativeAdLoadListener
fun onNativeAdLoadFinish(adInfo: AdfurikunNativeAdInfo?, appId: String?)
広告のロード成功時に呼ばれます。
| パラメータ | 説明 |
|---|---|
adInfo |
広告情報 |
| adInfoプロパティ | 説明 |
|---|---|
adNetworkKey |
アドネットワークキー |
title |
広告のタイトル (アドネットワークによっては非対応) |
description |
広告の説明文 (アドネットワークによっては非対応) |
fun onNativeAdLoadError(error: AdfurikunMovieError?, appId: String?)
ロード失敗時に呼ばれます。
| パラメータ | 説明 |
|---|---|
error |
エラー情報詳細はエラーコードリファレンスをご参照ください |
appId |
広告枠ID |
AdfurikunNativeAdVideoListener
fun onNativeAdViewPlayStart(appId: String?)
広告の再生開始時に呼ばれます。
| パラメータ | 説明 |
|---|---|
appId |
広告枠ID |
fun onNativeAdViewPlayFinish(appId: String?, isVideoAd: Boolean)
広告を最後まで視聴した時に呼ばれます。
| パラメータ | 説明 |
|---|---|
appId |
広告枠ID |
isVideoAd |
動画かどうか |
fun onNativeAdViewPlayFail(appId: String?, error: AdfurikunMovieError?)
広告の表示時にアドネットワーク側でエラーを検知した際に呼ばれます。 この関数が呼ばれた際は、必要に応じて再度広告読み込みを行ってください。
| パラメータ | 説明 |
|---|---|
appId |
広告ID |
error |
エラー情報詳細はエラーコードリファレンスをご参照ください |
fun onNativeAdViewClicked(appId: String?)
動画がクリックされた時に呼ばれます。
| パラメータ | 説明 |
|---|---|
appId |
広告枠ID |