メインコンテンツへスキップ

Adrop

Adrop SDKのメインクラスです。SDK初期化とグローバル設定を担当します。

静的メソッド

メソッド説明
initialize(context: Application, production: Boolean)SDKを初期化します。
initialize(context: Application, production: Boolean, targetCountries: Array<String>)ターゲット国を指定してSDKを初期化します。
initialize(context: Application, production: Boolean, targetCountries: Array<String>, tokenKey: String?)ターゲット国とトークンキーを指定してSDKを初期化します。
setUID(uid: String)ユーザー識別子を設定します。(SHA-256でハッシュ化)
setTheme(theme: AdropTheme)広告テーマを設定します。
setTokenKey(tokenKey: String)アプリトークンキーを設定します。
handleDeepLink(intent: Intent): BooleanAdropディープリンクを処理します。
openQuest(context: Context, channel: String, path: String?)Adrop Questページを開きます。

静的プロパティ

プロパティ説明
isProductionBooleanプロダクションモードかどうか
sdkVersionStringSDKバージョン

使用例

// 初期化
Adrop.initialize(application, production = true)

// ユーザーID設定
Adrop.setUID("user123")

// テーマ設定
Adrop.setTheme(AdropTheme.DARK)

// ディープリンク処理
override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    intent?.let { Adrop.handleDeepLink(it) }
}

AdropTheme

広告のダークモード設定のための列挙型です。

説明
LIGHTライトモード
DARKダークモード
AUTOシステム設定に自動追従(デフォルト)

使用例

Adrop.setTheme(AdropTheme.DARK)

AdropErrorCode

広告の読み込みと表示時に発生する可能性のあるエラーコードです。

エラーコード説明
ERROR_CODE_NETWORKネットワークエラー
ERROR_CODE_INTERNAL内部エラー
ERROR_CODE_INITIALIZESDK初期化エラー
ERROR_CODE_INVALID_UNIT無効な広告ユニットID
ERROR_CODE_NOT_TARGET_COUNTRYターゲット国ではない
ERROR_CODE_AD_INACTIVE非アクティブな広告
ERROR_CODE_AD_NO_FILL表示可能な広告がない
ERROR_CODE_AD_LOAD_DUPLICATED重複した広告読み込みリクエスト
ERROR_CODE_AD_LOADING広告読み込み中
ERROR_CODE_AD_EMPTY広告が空
ERROR_CODE_AD_SHOWN広告がすでに表示済み
ERROR_CODE_AD_HIDE_FOR_TODAY「今日は表示しない」が設定済み
ERROR_CODE_ACCOUNT_USAGE_LIMIT_EXCEEDEDアカウント使用量制限超過
ERROR_CODE_LANDSCAPE_UNSUPPORTED横向きモード非対応

AdropBanner

バナー広告を表示するビュークラスです。

コンストラクタ

// XMLで使用
AdropBanner(context: Context, attrs: AttributeSet?)

// コードで使用
AdropBanner(context: Context, unitId: String, contextId: String? = null)

プロパティ

プロパティ説明
listenerAdropBannerListener?バナーイベントリスナー
shouldAdjustHtmlStyleBooleanHTMLスタイル自動調整するかどうか(デフォルト: false)
useCustomClickBooleanカスタムクリック処理を使用するかどうか(デフォルト: false)
adSizeCreativeSize?バックフィル広告用バナーサイズ(dp)
contextIdStringコンテキストID
creativeIdStringクリエイティブID
txIdStringトランザクションID
campaignIdStringキャンペーンID
destinationURLString遷移先URL
creativeSizeCreativeSizeクリエイティブサイズ
isBackfilledBooleanバックフィル広告かどうか

メソッド

メソッド説明
setUnitId(unitId: String)広告ユニットID設定
getUnitId(): String広告ユニットID取得
load()広告を読み込む
open(url: String?)広告ランディングページを開く
destroy()バナー広告を削除

使用例

val banner = AdropBanner(this, "YOUR_UNIT_ID")
banner.listener = object : AdropBannerListener {
    override fun onAdReceived(banner: AdropBanner) {
        // 広告受信成功
    }

    override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {
        // 広告受信失敗
    }

    override fun onAdClicked(banner: AdropBanner) {
        // 広告クリック
    }
}

// 広告を読み込む
banner.load()

AdropBannerListener

バナー広告イベントを処理するインターフェースです。

メソッド

メソッド説明
onAdReceived(banner: AdropBanner)広告受信成功
onAdClicked(banner: AdropBanner)広告クリック
onAdImpression(banner: AdropBanner)広告表示(任意実装)
onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode)広告受信失敗
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropNativeAd

ネイティブ広告を表示するクラスです。

コンストラクタ

AdropNativeAd(context: Context, unitId: String, contextId: String? = null)

プロパティ

プロパティ説明
listenerAdropNativeAdListener?ネイティブ広告イベントリスナー
useCustomClickBooleanカスタムクリック処理を使用するかどうか
contextContextコンテキスト
isLoadedBoolean広告読み込み完了かどうか
isDestroyedBoolean広告が削除されたかどうか
creativeIdStringクリエイティブID
txIdStringトランザクションID
campaignIdStringキャンペーンID
creativeSizeCreativeSizeクリエイティブサイズ
iconStringアイコン画像URL
coverStringカバー画像URL
headlineString見出し
bodyString本文
creativeStringクリエイティブURL
assetStringアセットURL
destinationURLString遷移先URL
advertiserURLString広告主URL
accountTagJSONObjectアカウントタグ
creativeTagJSONObjectクリエイティブタグ
advertiserString広告主名
callToActionStringコールトゥアクションテキスト
extraJSONObject追加データ
profileAdropNativeAdProfileプロフィール情報
isBackfilledBooleanバックフィル広告かどうか

メソッド

メソッド説明
load()広告を読み込む
destroy()広告を削除

使用例

val nativeAd = AdropNativeAd(this, "YOUR_UNIT_ID")
nativeAd.listener = object : AdropNativeAdListener {
    override fun onAdReceived(ad: AdropNativeAd) {
        // 広告データをバインド
        headlineTextView.text = ad.headline
        bodyTextView.text = ad.body
        advertiserTextView.text = ad.advertiser
        ctaButton.text = ad.callToAction

        // ビューに広告を設定
        nativeAdView.setNativeAd(ad)
    }

    override fun onAdFailedToReceive(ad: AdropNativeAd, errorCode: AdropErrorCode) {
        // 広告受信失敗
    }

    override fun onAdClick(ad: AdropNativeAd) {
        // 広告クリック
    }
}

nativeAd.load()

AdropNativeAdView

ネイティブ広告をレンダリングするコンテナビューです。

コンストラクタ

AdropNativeAdView(context: Context, attrs: AttributeSet?)

プロパティ

プロパティ説明
isEntireClickBoolean全体領域クリック可能かどうか

メソッド

メソッド説明
setIconView(view: View, listener: OnClickListener?)アイコンビュー設定(ImageViewのみ)
setHeadLineView(view: View, listener: OnClickListener?)見出しビュー設定(TextViewのみ)
setBodyView(view: View)本文ビュー設定(TextViewのみ)
setMediaView(view: AdropMediaView)メディアビュー設定
setAdvertiserView(view: View, listener: OnClickListener?)広告主ビュー設定(TextViewのみ)
setCallToActionView(view: View)コールトゥアクションボタンビュー設定
setProfileNameView(view: View, listener: OnClickListener?)プロフィール名ビュー設定
setProfileLogoView(view: View, listener: OnClickListener?)プロフィールロゴビュー設定(ImageViewのみ)
setNativeAd(ad: AdropNativeAd)ネイティブ広告を設定
destroy()ビューを削除

使用例

// レイアウトからビューを参照
val nativeAdView = findViewById<AdropNativeAdView>(R.id.native_ad_view)
val iconView = findViewById<ImageView>(R.id.ad_icon)
val headlineView = findViewById<TextView>(R.id.ad_headline)
val bodyView = findViewById<TextView>(R.id.ad_body)
val mediaView = findViewById<AdropMediaView>(R.id.ad_media)
val advertiserView = findViewById<TextView>(R.id.ad_advertiser)
val ctaView = findViewById<Button>(R.id.ad_cta)

// ビューを設定
nativeAdView.setIconView(iconView)
nativeAdView.setHeadLineView(headlineView)
nativeAdView.setBodyView(bodyView)
nativeAdView.setMediaView(mediaView)
nativeAdView.setAdvertiserView(advertiserView)
nativeAdView.setCallToActionView(ctaView)

// 広告読み込み後に設定
nativeAd.listener = object : AdropNativeAdListener {
    override fun onAdReceived(ad: AdropNativeAd) {
        nativeAdView.setNativeAd(ad)
    }
}

AdropNativeAdListener

ネイティブ広告イベントを処理するインターフェースです。

メソッド

メソッド説明
onAdReceived(ad: AdropNativeAd)広告受信成功
onAdClick(ad: AdropNativeAd)広告クリック
onAdImpression(ad: AdropNativeAd)広告表示(任意実装)
onAdFailedToReceive(ad: AdropNativeAd, errorCode: AdropErrorCode)広告受信失敗
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropNativeAdProfile

ネイティブ広告のプロフィール情報を含むデータクラスです。

プロパティ

プロパティ説明
displayLogoStringプロフィールロゴ画像URL
displayNameStringプロフィール名
linkStringプロフィールリンクURL

使用例

val profile = nativeAd.profile
profileNameTextView.text = profile.displayName
// プロフィールロゴをImageViewに読み込む

AdropMediaView

ネイティブ広告のメディアコンテンツを表示するビューです。

コンストラクタ

AdropMediaView(context: Context, attrs: AttributeSet?)

説明

メディアビューはネイティブ広告の画像や動画コンテンツを表示します。AdropNativeAdViewsetMediaView()メソッドを通じて設定する必要があります。

AdropInterstitialAd

インタースティシャル広告を表示するクラスです。

コンストラクタ

AdropInterstitialAd(context: Context, unitId: String)

プロパティ

プロパティ説明
interstitialAdListenerAdropInterstitialAdListener?インタースティシャル広告イベントリスナー
contextContext?コンテキスト
unitIdString広告ユニットID
isLoadedBoolean広告読み込み完了かどうか
creativeIdStringクリエイティブID
txIdStringトランザクションID
campaignIdStringキャンペーンID
isBackfilledBooleanバックフィル広告かどうか

メソッド

メソッド説明
load()広告を読み込む
show(fromActivity: Activity)広告を表示
destroy()広告を削除

使用例

val interstitialAd = AdropInterstitialAd(this, "YOUR_UNIT_ID")

interstitialAd.interstitialAdListener = object : AdropInterstitialAdListener {
    override fun onAdReceived(ad: AdropInterstitialAd) {
        // 広告読み込み完了、表示可能
        ad.show(this@MainActivity)
    }

    override fun onAdFailedToReceive(ad: AdropInterstitialAd, errorCode: AdropErrorCode) {
        // 広告受信失敗
    }

    override fun onAdDidDismissFullScreen(ad: AdropInterstitialAd) {
        // 広告が閉じられた
    }
}

// 広告を読み込む
interstitialAd.load()

AdropInterstitialAdListener

インタースティシャル広告イベントを処理するインターフェースです。

メソッド

メソッド説明
onAdReceived(ad: AdropInterstitialAd)広告受信成功
onAdFailedToReceive(ad: AdropInterstitialAd, errorCode: AdropErrorCode)広告受信失敗
onAdImpression(ad: AdropInterstitialAd)広告表示(任意実装)
onAdClicked(ad: AdropInterstitialAd)広告クリック(任意実装)
onAdWillPresentFullScreen(ad: AdropInterstitialAd)フルスクリーン広告表示開始(任意実装)
onAdDidPresentFullScreen(ad: AdropInterstitialAd)フルスクリーン広告表示完了(任意実装)
onAdWillDismissFullScreen(ad: AdropInterstitialAd)フルスクリーン広告閉じる開始(任意実装)
onAdDidDismissFullScreen(ad: AdropInterstitialAd)フルスクリーン広告閉じる完了(任意実装)
onAdFailedToShowFullScreen(ad: AdropInterstitialAd, errorCode: AdropErrorCode)広告表示失敗(任意実装)
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropRewardedAd

リワード広告を表示するクラスです。

コンストラクタ

AdropRewardedAd(context: Context, unitId: String)

プロパティ

プロパティ説明
rewardedAdListenerAdropRewardedAdListener?リワード広告イベントリスナー
contextContext?コンテキスト
unitIdString広告ユニットID
isLoadedBoolean広告読み込み完了かどうか
creativeIdStringクリエイティブID
txIdStringトランザクションID
campaignIdStringキャンペーンID
isBackfilledBooleanバックフィル広告かどうか

メソッド

メソッド説明
load()広告を読み込む
show(fromActivity: Activity, userDidEarnRewardHandler: AdropUserDidEarnRewardHandler)広告を表示してリワードハンドラーを設定
destroy()広告を削除

使用例

val rewardedAd = AdropRewardedAd(this, "YOUR_UNIT_ID")

rewardedAd.rewardedAdListener = object : AdropRewardedAdListener {
    override fun onAdReceived(ad: AdropRewardedAd) {
        // 広告読み込み完了
        ad.show(this@MainActivity) { type, amount ->
            // リワード付与
            Log.d("Reward", "Type: $type, Amount: $amount")
        }
    }

    override fun onAdFailedToReceive(ad: AdropRewardedAd, errorCode: AdropErrorCode) {
        // 広告受信失敗
    }
}

rewardedAd.load()

AdropRewardedAdListener

リワード広告イベントを処理するインターフェースです。

メソッド

メソッド説明
onAdReceived(ad: AdropRewardedAd)広告受信成功
onAdFailedToReceive(ad: AdropRewardedAd, errorCode: AdropErrorCode)広告受信失敗
onAdImpression(ad: AdropRewardedAd)広告表示(任意実装)
onAdClicked(ad: AdropRewardedAd)広告クリック(任意実装)
onAdWillPresentFullScreen(ad: AdropRewardedAd)フルスクリーン広告表示開始(任意実装)
onAdDidPresentFullScreen(ad: AdropRewardedAd)フルスクリーン広告表示完了(任意実装)
onAdWillDismissFullScreen(ad: AdropRewardedAd)フルスクリーン広告閉じる開始(任意実装)
onAdDidDismissFullScreen(ad: AdropRewardedAd)フルスクリーン広告閉じる完了(任意実装)
onAdFailedToShowFullScreen(ad: AdropRewardedAd, errorCode: AdropErrorCode)広告表示失敗(任意実装)
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropUserDidEarnRewardHandler

リワード付与時に呼び出される型エイリアスです。

定義

typealias AdropUserDidEarnRewardHandler = (type: Int, amount: Int) -> Unit

パラメータ

パラメータ説明
typeIntリワードタイプ
amountIntリワード数量

使用例

rewardedAd.show(this) { type, amount ->
    // ユーザーにリワードを付与
    when (type) {
        0 -> grantCoins(amount)
        1 -> grantLives(amount)
    }
}

AdropPopupAd

ポップアップ広告を表示するクラスです。

コンストラクタ

AdropPopupAd(context: Context, unitId: String)

プロパティ

プロパティ説明
popupAdListenerAdropPopupAdListener?ポップアップ広告イベントリスナー
closeListenerAdropPopupAdCloseListener?ポップアップ閉じるイベントリスナー
useCustomClickBooleanカスタムクリック処理を使用するかどうか
closeTextColorInt?閉じるボタンテキスト色
hideForTodayTextColorInt?「今日は表示しない」テキスト色
ctaTextColorInt?CTAボタンテキスト色
backgroundColorInt?背景色
unitIdString広告ユニットID
creativeIdsList<String>クリエイティブIDリスト
creativeIdString現在のクリエイティブID
destinationURLString遷移先URL
isLoadedBoolean広告読み込み完了かどうか
txIdStringトランザクションID
campaignIdStringキャンペーンID

メソッド

メソッド説明
load()広告を読み込む
show(activity: Activity)広告を表示
open(url: String?)広告ランディングページを開く
close()広告を閉じる
destroy()広告を削除

使用例

val popupAd = AdropPopupAd(this, "YOUR_UNIT_ID")

// スタイルをカスタマイズ
popupAd.closeTextColor = Color.WHITE
popupAd.backgroundColor = Color.parseColor("#80000000")

popupAd.popupAdListener = object : AdropPopupAdListener {
    override fun onAdReceived(ad: AdropPopupAd) {
        // 広告読み込み完了
        ad.show(this@MainActivity)
    }

    override fun onAdFailedToReceive(ad: AdropPopupAd, errorCode: AdropErrorCode) {
        // 広告受信失敗
    }
}

popupAd.closeListener = object : AdropPopupAdCloseListener {
    override fun onTodayOffClicked(ad: AdropPopupAd) {
        // 「今日は表示しない」クリック
    }
}

popupAd.load()

AdropPopupAdListener

ポップアップ広告イベントを処理するインターフェースです。

メソッド

メソッド説明
onAdReceived(ad: AdropPopupAd)広告受信成功
onAdFailedToReceive(ad: AdropPopupAd, errorCode: AdropErrorCode)広告受信失敗
onAdImpression(ad: AdropPopupAd)広告表示(任意実装)
onAdClicked(ad: AdropPopupAd)広告クリック(任意実装)
onAdWillPresentFullScreen(ad: AdropPopupAd)フルスクリーン広告表示開始(任意実装)
onAdDidPresentFullScreen(ad: AdropPopupAd)フルスクリーン広告表示完了(任意実装)
onAdWillDismissFullScreen(ad: AdropPopupAd)フルスクリーン広告閉じる開始(任意実装)
onAdDidDismissFullScreen(ad: AdropPopupAd)フルスクリーン広告閉じる完了(任意実装)
onAdFailedToShowFullScreen(ad: AdropPopupAd, errorCode: AdropErrorCode)広告表示失敗(任意実装)
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropPopupAdCloseListener

ポップアップ広告の閉じるイベントを処理するインターフェースです。

メソッド

メソッド説明
onClosed(ad: AdropPopupAd)ポップアップを閉じる(任意実装)
onDimClicked(ad: AdropPopupAd)ディム領域クリック(任意実装)
onTodayOffClicked(ad: AdropPopupAd)「今日は表示しない」クリック(任意実装)
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropSplashAd

スプラッシュ広告を表示するクラスです。

コンストラクタ

AdropSplashAd(application: Application, shouldSkip: ((splashAd: AdropSplashAd) -> Boolean)?)

パラメータ

パラメータ説明
applicationApplicationアプリケーションインスタンス
shouldSkip((AdropSplashAd) -> Boolean)?スプラッシュ広告スキップ判定関数(任意)

プロパティ

プロパティ説明
splashAdListenerAdropSplashAdListener?スプラッシュ広告イベントリスナー
creativeIdStringクリエイティブID
isClosedBoolean広告が閉じられたかどうか
unitIdString広告ユニットID

メソッド

メソッド説明
close()広告を閉じる

使用例

// AndroidManifest.xmlにAdropSplashAdActivityを追加する必要あり
class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        val splashAd = AdropSplashAd(this) { ad ->
            // 特定の条件でスキップ
            false
        }

        splashAd.splashAdListener = object : AdropSplashAdListener {
            override fun onAdReceived(ad: AdropSplashAd) {
                // 広告受信
            }

            override fun onAdClose(ad: AdropSplashAd, impressed: Boolean) {
                // 広告が閉じられた
            }
        }
    }
}

AdropSplashAdListener

スプラッシュ広告イベントを処理するインターフェースです。

メソッド

メソッド説明
onAdReceived(ad: AdropSplashAd)広告受信成功(任意実装)
onAdFailedToReceive(ad: AdropSplashAd, errorCode: AdropErrorCode)広告受信失敗(任意実装)
onAdImpression(ad: AdropSplashAd)広告表示(任意実装)
onAdClose(ad: AdropSplashAd, impressed: Boolean)広告が閉じられた(必須実装)

パラメータ

パラメータ説明
impressedBoolean広告が実際に表示されたかどうか
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropSplashAdView

スプラッシュ広告をビューとして表示するクラスです。

コンストラクタ

AdropSplashAdView(context: Context, unitId: String, adRequestTimeout: Long = 1000L)
AdropSplashAdView(context: Context, attrs: AttributeSet?)

プロパティ

プロパティ説明
listenerAdropSplashAdViewListener?スプラッシュ広告ビューイベントリスナー
displayDurationLong表示時間(非推奨:コンソールで設定)
creativeIdStringクリエイティブID
isClosedBoolean広告が閉じられたかどうか
unitIdString広告ユニットID
txIdStringトランザクションID
campaignIdStringキャンペーンID

メソッド

メソッド説明
load()広告を読み込む

使用例

val splashAdView = AdropSplashAdView(this, "YOUR_UNIT_ID", adRequestTimeout = 2000L)

splashAdView.listener = object : AdropSplashAdViewListener {
    override fun onAdReceived(ad: AdropSplashAdView) {
        // 広告受信
    }

    override fun onAdClose(ad: AdropSplashAdView, impressed: Boolean) {
        // 広告が閉じられた - メイン画面に遷移
        if (impressed) {
            // 広告が表示された
        }
        startMainActivity()
    }
}

// レイアウトに追加
container.addView(splashAdView)
splashAdView.load()

AdropSplashAdViewListener

スプラッシュ広告ビューイベントを処理するインターフェースです。

メソッド

メソッド説明
onAdReceived(ad: AdropSplashAdView)広告受信成功(任意実装)
onAdFailedToReceive(ad: AdropSplashAdView, errorCode: AdropErrorCode)広告受信失敗(任意実装)
onAdImpression(ad: AdropSplashAdView)広告表示(任意実装)
onAdClose(ad: AdropSplashAdView, impressed: Boolean)広告が閉じられた(必須実装)
すべてのコールバックはメインスレッドで呼び出されます(@UiThread)。

AdropKey

ユーザープロパティキーを定義するクラスです。

定数

定数説明
AGE"AGE"年齢
BIRTH"BIRTH"生年月日
GENDER"GDR"性別

使用例

val params = AdropEventParam.Builder()
    .putInt(AdropKey.AGE, 25)
    .putString(AdropKey.GENDER, AdropValue.AdropGender.MALE)
    .putString(AdropKey.BIRTH, "19990101")
    .build()

AdropValue

ユーザープロパティ値を定義するクラスです。

共通定数

定数説明
UNKNOWN"U"不明

AdropBirth

生年月日フォーマットを定義します。
定数説明
formatYear"yyyy"年のみ(例:1999)
formatYearMonth"yyyyMM"年と月(例:199901)
formatYearMonthDay"yyyyMMdd"年、月、日(例:19990101)

AdropGender

性別値を定義します。
定数説明
MALE"M"男性
FEMALE"F"女性
OTHER"O"その他

使用例

val params = AdropEventParam.Builder()
    .putString(AdropKey.GENDER, AdropValue.AdropGender.MALE)
    .putString(AdropKey.BIRTH, "19990101") // formatYearMonthDayを使用
    .build()

CreativeSize

クリエイティブのサイズを表すデータクラスです。

プロパティ

プロパティ説明
widthDouble幅(dp)
heightDouble高さ(dp)

使用例

val banner = AdropBanner(this, "YOUR_UNIT_ID")
banner.adSize = CreativeSize(320.0, 50.0)

AdropEventParam

カスタムイベントパラメータを作成するクラスです。

Builderメソッド

メソッド説明
putBoolean(key: String, value: Boolean)Boolean値を追加
putInt(key: String, value: Int)Int値を追加
putFloat(key: String, value: Float)Float値を追加
putString(key: String, value: String)String値を追加
putLong(key: String, value: Long)Long値を追加(最大値:9007199254740991)
build()AdropEventParamインスタンスを生成

使用例

val params = AdropEventParam.Builder()
    .putString(AdropKey.GENDER, AdropValue.AdropGender.MALE)
    .putInt(AdropKey.AGE, 25)
    .putString(AdropKey.BIRTH, "19990101")
    .build()
putLong()に渡す値はJavaScriptのMAX_SAFE_INTEGER(9007199254740991)を超えることはできません。