Unity Ads Android SDK API リファレンス - Kotlin および Java
Unity Ads SDK のパブリック API リファレンスにアクセスして、Kotlin および Java で使用可能なクラス、メソッド、プロパティを表示し、Android アプリの広告動作を統合および制御できます。
読み終わるまでの所要時間 61 分最終更新 6日前
Unity Ads を Android アプリケーションに統合する際は、この Unity Ads Android SDK API リファレンス(Java および Kotlin)を使用してください。
この API を使用する前に、アプリで収益化を有効にするために ライブラリをインポートしていることを確認してください。詳細については、UnityAds ライブラリのインポートを参照してください。
UnityAdsクラス
BannerAd
BannerAdBannerLoadConfiguration
BannerAdパラメーター | 説明 | 必須 |
|---|---|---|
| バナープレースメントの一意の識別子。 | はい |
| 広告の | はい |
| 入札シナリオ用の広告マークアップ。 | いいえ |
| メディエーションパートナー情報。 | いいえ |
| パフォーマンス追跡のためにメディエーションで使用されます。 | いいえ |
| 追加のキーと値のペアのマップ。 | いいえ |
| バナーのライフサイクルイベントを処理するための BannerShowListener。 | いいえ |
val bannerLoadConfiguration = BannerLoadConfiguration.Builder("banner_placement", bannerSize) .withAdMarkup("ad_markup") .withMediationInfo(mediationInfo) .withMediationAdUnitId("mediation_ad_unit_id") .withExtras(mapOf("key" to "value")) .withListener(bannerListener) .build()
BannerLoadConfiguration.Builder
BannerLoadConfigurationコンストラクター
Builder(placementId:String, bannerSize:BannerSize)
パラメーター | 説明 | 必須 |
|---|---|---|
| バナープレースメントの一意の識別子。 | はい |
| 広告の | はい |
戻り値:新しい インスタンス。
BannerLoadConfiguration.Builderビルダーメソッド
メソッド | パラメーター | 必須 | Returns | 説明 |
|---|---|---|---|---|
| | | | 広告マークアップを設定し、チェーン用にビルダーを返します。 |
| | | | メディエーション情報を設定し、チェーン用にビルダーを返します。 |
| | | | メディエーション広告ユニットIDを設定し、チェーン用にビルダーを返します。 |
| | | | エクストラマップを設定し、チェーン用にビルダーを返します。 |
| | | | 表示リスナーを設定し、チェーン用にビルダーを返します。 |
| なし | | | 設定されたパラメータで |
val bannerLoadConfiguration = BannerLoadConfiguration.Builder("banner_placement", bannerSize) .withAdMarkup("ad_markup") .withMediationInfo(mediationInfo) .withMediationAdUnitId("mediation_ad_unit_id") .withExtras(mapOf("key" to "value")) .withListener(bannerListener) .build()
load()
指定された BannerLoadConfiguration でバナー広告をロードします。
パラメーター | 説明 | 必須 |
|---|---|---|
| バナー固有のロードオプションを含む | はい |
| | はい |
戻り値: (void) - これは非同期メソッドであり、直ちに返されます。結果は コールバックを通じて提供されます。
UnitBannerLoadListenerval bannerSize = BannerSize(320, 50)val loadConfig = BannerLoadConfiguration.Builder("banner_placement", bannerSize).build()BannerAd.load(loadConfig, { bannerAd, error -> if (bannerAd != null) { // バナーが正常にロードされました。ビュー階層に追加できます this.bannerAd = bannerAd } else { // ロードエラーを処理します }})
view
バナー広告インスタンスにアクセスできるビュープロパティです。このプロパティを使用して、アプリの既存のビュー階層の目的の場所にバナー広告を挿入します。
戻り値: (nullable View) - バナー広告を含む Android View。広告が正常にロードされていない場合は null。
View?// 'bannerAd' がロード済みの BannerAd インスタンスであると想定します// 'adPlaceholder' が広告を表示するレイアウト内の ViewGroup (LinearLayout、FrameLayout など) であると想定しますbannerAd.view?.let { adPlaceholder.addView(it)}
BannerView
BannerViewBannerView.IListener
BannerView.IListenerBannerSize
バナー広告の次元を表すデータクラスです。
パラメーター | 説明 | 必須 |
|---|---|---|
| バナーの幅(ピクセル単位)。 | はい |
| バナーの高さ(ピクセル単位)。 | はい |
val bannerSize = BannerSize(320, 50)
UnityBannerSize
UnityBannerSizeInitializationConfiguration
SDK 初期化のためのすべての設定を含むクラスです。このクラスのインスタンスは、その を使用して作成されます。
Builderパラメーター | 説明 | 必須 |
|---|---|---|
| Unity Ads Monetization ダッシュボードから取得した一意のゲーム識別子。 | はい |
| テストモードを有効にするブーリアン値。true の場合、テスト広告のみが表示されます。デフォルトは false です。 | いいえ |
| ログ出力の詳細レベルを指定します。以下を参照してください | いいえ |
| メディエーションパートナーに関する情報を含むオブジェクト。以下を参照してください | いいえ |
| 高度な設定のための追加のキーと値のペアのマップ。 | いいえ |
InitializationConfiguration.Builder
InitializationConfigurationコンストラクター
Builder(gameId:文字列)
パラメーター | 説明 | 必須 |
|---|---|---|
| Unity Ads Monetization ダッシュボードから取得した一意のゲーム識別子。 | はい |
戻り値:新しい インスタンス。
InitializationConfiguration.Builderビルダーメソッド
メソッド | パラメーター | 必須 | Returns | 説明 |
|---|---|---|---|---|
| | | | テストモードを設定し、チェーン用にビルダーを返します。 |
| | | | ログレベルを設定し、チェーン用にビルダーを返します。 |
| | | | メディエーション情報を設定し、チェーン用にビルダーを返します。 |
| | | | 追加のマップを設定し、チェーン用にビルダーを返します。 |
| なし | | | 設定されたパラメータを使用して |
val config = InitializationConfiguration.Builder("YOUR_GAME_ID") .withTestMode(true) .withLogLevel(LogLevel.DEBUG) .withMediationInfo(mediationInfo) .withExtras(mapOf("key" to "value")) .build()
initialize()
指定された設定でUnity Ads SDKを初期化します。は、初期化が成功または失敗で完了したときに呼び出されます。
InitializationListenerパラメーター | 説明 | 必須 |
|---|---|---|
| SDKを初期化するために必要な設定を含む | いいえ |
| | いいえ |
戻り値: (void) - これは非同期メソッドであり、すぐに制御が戻ります。結果は コールバックを通じて提供されます。
UnitInitializationListener@OptIn(UnityAdsExperimental::class)fun initializeUnityAds(context:コンテキスト) { val config = InitializationConfiguration.Builder("YOUR_GAME_ID") .withTestMode(true) .build() val listener = InitializationListener { error -> if (error == null) { // Initialization successful } else { // Handle initialization error } } UnityAds.initialize(config, listener)}
InterstitialAd
InterstitialAdload()
指定された LoadConfiguration でインタースティシャル広告を読み込みます。
パラメーター | 説明 | 必須 |
|---|---|---|
| 広告読み込みオプションを含む | いいえ |
| 読み込み完了時に呼び出される | いいえ |
InterstitialAd.load(loadConfig, { interstitialAd, error -> if (interstitialAd != null) { // 広告の読み込みに成功しました。表示可能です。 this.interstitialAd = interstitialAd } else { // 読み込みエラーを処理します。 }})
show()
以前に読み込んだインタースティシャル広告を表示します。
パラメーター | 説明 | 必須 |
|---|---|---|
| 広告表示オプションを含む | いいえ |
| 広告ライフサイクルイベントを処理するための任意の | いいえ |
戻り値: (void) - このメソッドは、広告表示プロセスを開始した直後に戻ります。ライフサイクルイベントは コールバックを通じて提供されます。
UnitShowListenerinterstitialAd.show(showConfig, interstitialShowListener)
LoadConfiguration
InterstitialAdRewardedAdパラメーター | 説明 | 必須 |
|---|---|---|
| Unity Monetization ダッシュボードで確認できる、広告プレースメントの一意の識別子。 | はい |
| 入札シナリオ用の広告マークアップ。 | いいえ |
| メディエーションパートナー情報。 | いいえ |
| メディエーションによるパフォーマンス追跡に使用されます。 | いいえ |
| 追加のキーと値のペアのマップ。 | いいえ |
val loadConfiguration = LoadConfiguration.Builder("interstitial_placement") .withAdMarkup("ad_markup") .withMediationInfo(mediationInfo) .withMediationAdUnitId("mediation_ad_unit_id") .withExtras(mapOf("key" to "value")) // これを複数回呼び出すと、前の値が上書きされます。 .build()
LoadConfiguration.Builder
LoadConfigurationコンストラクタ
Builder(placementId:文字列)
パラメーター | 説明 | 必須 |
|---|---|---|
| Unity Monetization ダッシュボードで確認できる、広告プレースメントの一意の識別子。 | はい |
戻り値:新しい インスタンス。
LoadConfiguration.Builderビルダーメソッド
メソッド | パラメーター | 必須 | Returns | 説明 |
|---|---|---|---|---|
| | いいえ | | 広告マークアップを設定し、チェーン用にビルダーを返します。 |
| | いいえ | | メディエーション情報を設定し、チェーン用にビルダーを返します。 |
| | いいえ | | メディエーション広告ユニットIDを設定し、チェーン用にビルダーを返します。 |
| | いいえ | | 余分なキーと値のペアのマップを設定し、チェーン用にビルダーを返します。 |
| なし | いいえ | | 設定されたパラメーターを使用して |
UnityAdsLoadOptions
UnityAdsLoadOptionsMediationInfo
使用されているメディエーションパートナーに関する情報を含むクラスです。
パラメーター | 説明 | 必須 |
|---|---|---|
| メディエーションパートナーの名前。 | はい |
| メディエーションパートナーのSDKのバージョン。 | はい |
| メディエーションパートナー用のUnity Adsアダプターのバージョン。 | はい |
val mediationInfo = MediationInfo("partner_name", "1.2.3", "4.5.6")
MediationMetaData
MediationMetaDataRewardedAd
RewardedAdload()
指定された で動画リワード広告を読み込みます。
LoadConfigurationパラメーター | 説明 | 必須 |
|---|---|---|
| 広告読み込みオプションを含む | はい |
| 読み込み完了時に呼び出され、RewardedAd インスタンスまたはエラーを提供する | はい |
RewardedAd.load(loadConfig, { rewardedAd, error -> if (rewardedAd != null) { // 広告の読み込みに成功しました。表示可能です。 this.rewardedAd = rewardedAd } else { // 読み込みエラーを処理します。 }})
show()
以前に読み込まれたリワード広告を表示します。
パラメーター | 説明 | 必須 |
|---|---|---|
| 広告表示オプションを含む | はい |
| ユーザー報酬コールバックを含む広告イベントを処理するための任意の | はい |
戻り値: (void) - このメソッドは、広告表示プロセスを開始した直後に戻ります。ライフサイクルイベントは コールバックを通じて提供されます。
UnitShowListenerrewardedAd.show(showConfig, rewardedAdShowListener)
ShowConfiguration
InterstitialAdRewardedAdパラメーター | 説明 | 必須 |
|---|---|---|
| 完了を追跡するために使用されます。 | いいえ |
| 広告表示時に渡される追加のキーと値のペアのマップ。 | いいえ |
val showConfiguration = ShowConfiguration.Builder().withCustomRewardString("custom_reward_string").withExtras(mapOf("key" to "value")).build()
ShowConfiguration.Builder
ShowConfigurationコンストラクタ
Builder()
戻り値:新しい インスタンス。
ShowConfiguration.Builderビルダーメソッド
メソッド | パラメーター | 必須 | Returns | 説明 |
|---|---|---|---|---|
| | | | カスタムリワード文字列を設定し、チェーン用にビルダーを返します。 |
| | | | 余分なキーと値のペアのマップを設定し、チェーン用にビルダーを返します。 |
| なし | | | 設定されたパラメータを使用して |
UnityAdsShowOptions
UnityAdsShowOptionsTokenConfiguration
入札トークンを生成するための設定を含むクラス。
パラメーター | 説明 | 必須 |
|---|---|---|
| トークンを生成する対象の AdFormat(例: | はい |
| メディエーションパートナーに関する情報を含むオブジェクト。 | いいえ |
| 追加のキーと値のパラメーターのマップ。 | いいえ |
val tokenConfig = TokenConfiguration.Builder(AdFormat.REWARDED) .withMediationInfo(mediationInfo) .withExtras(extras) .build()
TokenConfiguration.Builder
TokenConfigurationコンストラクタ
Builder(adFormat:AdFormat)
パラメーター | 説明 | 必須 |
|---|---|---|
| トークンを生成する対象の AdFormat(例: | はい |
戻り値:新しい インスタンス。
TokenConfiguration.Builderビルダーメソッド
メソッド | パラメーター | 必須 | Returns | 説明 |
|---|---|---|---|---|
| | | | メディエーション情報を設定し、チェーン用にビルダーを返します。 |
| | | | extrasマップを設定し、チェーン用にビルダーを返します。 |
| なし | | | 設定されたパラメータを使用して |
getToken
提供された に基づいて入札トークンを取得し、トークンリスナーに渡します。
TokenConfigurationパラメーター | 説明 | 必須 |
|---|---|---|
| 広告フォーマット、メディエーション情報、およびその他のパラメータを指定する | はい |
| トークンが正常に取得された場合は、そのトークンと共にリスナーが呼び出され、エラーが発生した場合にはnullが渡されるリスナーです。 | はい |
戻り値: (void) - これは即座に値を返す非同期メソッドです。結果はコールバックを通じて提供されます。
UnitTokenListenerUnityAds.getToken(tokenConfig, listener)
UnityAds
UnityAdsクラスは、SDKの主要なエントリポイントとして機能する静的クラスです。初期化やトークンの取得を処理し、グローバルSDKプロパティへのアクセスを提供します。
静的変数
isInitialized
Unity Ads SDKが正常に初期化されたかどうかを判断するブーリアンプロパティ。
戻り値: Unity Ads SDKが正常に初期化された場合はtrue。
val isInitialized = UnityAds.isInitialized
version
Unity Ads SDKの現在のバージョンを返す文字列プロパティ。
戻り値:現在インストールされているUnity Ads SDKのバージョン。
val sdkVersion = UnityAds.version
userIdentifier
アプリの各ユーザーの一意のIDを表す文字列プロパティ。
戻り値:現在の値。
UnityAds.userIdentifier = "my-user-id"
プライバシー
以下のメソッドを使用してプライバシーおよびユーザー同意フラグを設定し、サポートされているプライバシー規制への準拠を支援します。
setUserConsent()
パーソナライズされた広告に対するユーザーのオプトインの選択を表示します。
setUserOptOut()
データ収集およびパーソナライズされた広告のオプトアウトのオプションをユーザーに提供します。
setNonBehavioral()
コンテキストによる(パーソナライズされていない)広告の表示を有効にします。
UnityAds.userConsent = trueUnityAds.userOptOut = falseUnityAds.nonBehavioral = false
メタデータ
MetaDataUnityAdsError
class UnityAdsError internal constructor( val code:Int, val message:String)
Unity Ads でエラーが発生した場合に公開される例外です。
パラメーター | 説明 |
|---|---|
| エラーに関連するメッセージです。 |
| エラーのコードです。 |
BannerErrorCode
BannerErrorCodeBannerErrorInfo
BannerErrorInfoUnityAds.UnityAdsInitializationError
UnityAds.UnityAdsInitializationErrorUnityAds.UnityAdsLoadError
UnityAds.UnityAdsLoadErrorUnityAds.UnityAdsShowError
UnityAds.UnityAdsShowErrorインターフェース
BannerLoadListener
BannerAdBannerAdメソッドシグネチャ
fun interface BannerLoadListener { fun onBannerLoaded(bannerAd:BannerAd?, error:UnityAdsError?)}
メソッド | Parameters | 説明 |
|---|---|---|
| | バナー広告の読み込みリクエストが完了したときに呼び出されます。パラメーターのうち、いずれか1つだけがnull以外になります。 |
val bannerLoadListener = BannerLoadListener { bannerAd, error -> if (bannerAd != null) { // Banner loaded successfully this.bannerAd = bannerAd // Add banner.view to your view hierarchy } else { // Handle load error Log.e("UnityAds", "Banner load failed: ${error?.message}") }}
BannerShowListener
BannerAdメソッドシグネチャ
interface BannerShowListener { fun onBannerShown(bannerAd:BannerAd) fun onBannerClicked(bannerAd:BannerAd) fun onBannerFailedToShow(bannerAd:BannerAd, error:UnityAdsError)}
メソッド | Parameters | 説明 |
|---|---|---|
| | バナー広告が画面に正常に表示されたときに呼び出されます。 |
| | ユーザーがバナーをクリックしたときに呼び出されます。 |
| | バナーの表示に失敗したときに呼び出されます。 |
val bannerShowListener = object :BannerShowListener { override fun onBannerShown(bannerAd:BannerAd) { Log.d("UnityAds", "Banner shown") } override fun onBannerClicked(bannerAd:BannerAd) { Log.d("UnityAds", "Banner clicked") } override fun onBannerFailedToShow(bannerAd:BannerAd, error:UnityAdsError) { Log.e("UnityAds", "Banner failed to show: ${error.message}") }}
InitializationListener
SDKの初期化状態に関するコールバックを受け取るためのインターフェース。このリスナーは、SDKの初期化プロセスが完了したときに呼び出されます。
メソッドシグネチャ
fun interface InitializationListener { fun onInitializationComplete(error:UnityAdsError?)}
メソッド | Parameters | 説明 |
|---|---|---|
| | SDK の初期化が完了したときに呼び出されます。error が null の場合、初期化は成功しました。 |
val listener = InitializationListener { error -> if (error == null) { Log.d("UnityAds", "SDK initialized successfully.") } else { Log.e("UnityAds", "SDK initialization failed: ${error.message}") }}
IUnityAdsInitializationListener
IUnityAdsInitializationListenerInterstitialLoadListener
InterstitialAdInterstitialAdメソッドシグネチャ
fun interface InterstitialLoadListener { fun onInterstitialLoaded(interstitialAd:InterstitialAd?, error:UnityAdsError?)}
メソッド | Parameters | 説明 |
|---|---|---|
| | インタースティシャル広告のロードリクエストが完了したときに呼び出されます。パラメーターのうち、いずれか1つだけがnull以外になります。 |
val interstitialLoadListener = InterstitialLoadListener { interstitialAd, error -> if (interstitialAd != null) { // インタースティシャル広告のロードに成功しました this.interstitialAd = interstitialAd // これで広告を表示できます } else { // ロードエラーを処理する Log.e("UnityAds", "Interstitial load failed: ${error?.message}") }}
RewardedLoadListener
RewardedAdRewardedAdメソッドシグネチャ
fun interface RewardedLoadListener { fun onRewardedLoaded(rewardedAd:RewardedAd?, error:UnityAdsError?)}
メソッド | Parameters | 説明 |
|---|---|---|
| | リワード広告の読み込みリクエストが完了したときに呼び出されます。パラメーターのうち、いずれか1つが必ず非nullになります。 |
val rewardedLoadListener = RewardedLoadListener { rewardedAd, error -> if (rewardedAd != null) { // リワード広告の読み込みに成功しました this.rewardedAd = rewardedAd // これで広告を表示できます } else { // 読み込みエラーを処理します Log.e("UnityAds", "Rewarded ad load failed: ${error?.message}") }}
IUnityAdsLoadListener
IUnityAdsLoadListenerShowListener
ShowAdRewardedAdメソッドシグネチャ
interface ShowListener<T> { fun onStarted(unityAd:T) fun onClicked(unityAd:T) fun onCompleted(unityAd:T, state:ShowFinishState) fun onFailed(unityAd:T, error:UnityAdsError)}interface InterstitialShowListener :ShowListener<InterstitialAd>// Specialized listener for RewardedAd with reward callbackinterface RewardedShowListener :ShowListener<RewardedAd> { fun onRewarded(unityAd:RewardedAd)}
メソッド | Parameters | 説明 |
|---|---|---|
| | 広告が画面に表示され始めると呼び出されます。 |
| | ユーザーが広告をクリックすると呼び出されます。 |
| | 広告の表示が終了したときに呼び出されます。リワード広告の場合、 |
| | 広告の表示に失敗したときに呼び出されます。 |
| | ユーザーがリワード広告を最後まで視聴し、報酬を獲得したときに呼び出されます。 |
val interstitialListener = object :InterstitialShowListener { override fun onStarted(unityAd:InterstitialAd) { // 何らかの処理を実行します } override fun onClicked(unityAd:InterstitialAd) { // Do something } override fun onCompleted(unityAd:InterstitialAd, state:ShowFinishState) { // Do something } override fun onFailed(unityAd:InterstitialAd、エラー:UnityAdsError) { // Do something }}val rewardedListener = object :RewardedShowListener { override fun onStarted(unityAd:RewardedAd) { // Do something } override fun onClicked(unityAd:RewardedAd) { // Do something } override fun onCompleted(unityAd:RewardedAd、ステート:ShowFinishState) { // Do something } override fun onFailed(unityAd:RewardedAd、エラー:UnityAdsError) { // Do something } override fun onRewarded(unityAd:RewardedAd) { // Do something }}
IUnityAdsShowListener
IUnityAdsShowListenerTokenListener
getTokenメソッドシグネチャ
fun interface TokenListener { fun onTokenReady(token:String?)}
メソッド | Parameters | 説明 |
|---|---|---|
| | トークンのリクエストが完了したときに呼び出されます。トークンは、入札のためにメディエーションパートナーの SDK に渡す必要があります。 |
val listener = TokenListener { token -> if (token != null) { // トークンをメディエーションパートナーの SDK に渡します Log.d("UnityAds", "Token received: $token") } else { // トークンの取得失敗を処理します Log.e("UnityAds", "Token retrieval failed") }}
onAdExpired
InterstitialAdRewardedAdメソッドシグネチャ
// On InterstitialAdvar onAdExpired:AdExpiredListener?// On RewardedAdvar onAdExpired:AdExpiredListener?fun interface AdExpiredListener { fun onAdExpired(ad:T) // TはInterstitialAdまたはRewardedAd}
パラメーター | 説明 |
|---|---|
| (必須) 広告の有効期限が切れたときに、期限切れの広告インスタンスを受け取る関数。 |
戻り値: (void) - このメソッドはコールバックを登録し、直ちに制御を戻します。
Unit// For InterstitialAdinterstitialAd.onAdExpired = AdExpiredListener { ad -> // 広告の有効期限切れを処理 - 新しい広告を読み込む Log.d("UnityAds", "Interstitial ad expired") // 新しい広告を読み込む}// For RewardedAdrewardedAd.onAdExpired = AdExpiredListener { ad -> // Handle ad expiration - load a new ad Log.d("UnityAds", "Rewarded ad expired") // Load a new ad}
列挙型
AdFormat
異なる広告形式の列挙型。
値 | 説明 |
|---|---|
| アプリの自然な区切りで表示される全画面広告で、数秒後にスキップできます。 |
| アプリ内報酬と引き換えにユーザーが視聴を選択する全画面広告。 |
| 画面の一部、通常は上部または下部を占有する広告。 |
LogLevel
ログの詳細レベルを示す列挙型。
値 | 説明 |
|---|---|
| Unity Adsに関連するログは出力されません。 |
| デフォルトレベル。標準的な統合およびライフサイクルメッセージを表示します。 |
| デバッグ目的の詳細なログを表示します。 |
| 初期化、ロード、表示操作からの重要なエラー、および開発者が注意を払うべき重大な障害。 |
ShowFinishState
広告が表示された後の最終状態を記述する列挙型。
値 | 説明 |
|---|---|
| ユーザーは広告の再生が完了する前にスキップしました。 |
| 広告が最後まで視聴されました。 |
UnityAds.UnityAdsShowCompletionState
UnityAds.UnityAdsShowCompletionState