ドキュメント

サポート

Unity Ads Monetization

Android developer monetization guide

iOS developer monetization guide

Privacy consent setup

Unity Ads Monetization

Unity Ads Android SDK API リファレンス

Access the Unity Ads SDK public API reference to view available classes, methods, and properties you can use in Java to integrate and control ad behavior in your Android app.
読み終わるまでの所要時間 7 分最終更新 19 hours ago
この記事は以下の API ドキュメントを含んでいます。 クラス 列挙型 インターフェース

クラス

UnityAds

この名前空間は, 動画リワード広告, 非リワード型動画広告, インタースティシャル広告, バナー広告などの 基本的な広告コンテンツを実装する ために使用します。

initialize

initialize(final Context context, final String gameId, final boolean testMode, final IUnityAdsInitializationListener initializationListener)
指定された ゲーム ID, テストモード のステータス, 初期化リスナーを使用して, 広告サービスを初期化します。

パラメーター

説明

context
現在の Android 
Context
。
gameId
プラットフォーム固有のプロジェクトの Unity ゲーム識別子。Monetization (収益化) ダッシュボード から見つけることができます。
testMode
テストモードを使用すると, 実際の広告を表示することなく, インテグレーションをテストできます。テストモードで初期化するには 
true
を使用します。
initializationListener
任意で 
IUnityAdsInitializationListener
 コールバックを使用して SDK を有効にします (バージョン 3.7.0 以降)。

load

public static void load(final String adUnitId, final UnityAdsLoadOptions loadOptions, final IUnityAdsLoadListener listener)
指定された 広告ユニット の広告コンテンツをロードします。
show
 を呼び出す前に, 
load
を呼び出す必要があります。

パラメーター

説明

adUnitId
広告コンテンツと共にロードする広告ユニットの識別子。
loadOptions
広告の動作を変更するオプションのコレクション。
listener
任意で 
IUnityAdsLoadListener
 コールバックを使用して広告コンテンツをロードします (バージョン 3.7.0 以降)。

show

public static void show(final Activity activity, final String adUnitId, final UnityAdsShowOptions options, final IUnityAdsShowListener showListener)
指定した 広告ユニット にロードされた広告コンテンツを表示します。

パラメーター

説明

activity
現在の Android 
Activity
。
adUnitId
表示する広告ユニットの識別子。
options
広告の動作を変更する オプション のコレクション。
showListener
任意で 
IUnityAdsShowListener
 コールバックを使用してコンテンツを表示します (バージョン 3.7.0 以降)。

addListener

public static void addListener(IUnityAdsListener listener)
Unity Ads コールバックを受け取るリスナーを追加します。バージョン 3.1.0 以降では, 複数のリスナーを登録できます。これは メディエーション の顧客にとって特に便利です。

パラメーター

説明

listener
Unity Ads コールバックの リスナー。

removeListener

public static void removeListener(IUnityAdsListener listener)
アクティブな 
IUnityAdsListener
 を削除します。

パラメーター

説明

listener
Unity Ads コールバックのリスナー。

getVersion

public static String getVersion()
現在の Unity Ads SDK のバージョンを返します。

getPlacementState

public static PlacementState getPlacementState(String adUnitId)
指定された 広告ユニット の 状態 を返します。

パラメーター

説明

adUnitId
クエリを実行する広告ユニットの識別子。

setDebugMode

public static void setDebugMode(boolean debugMode)
SDK からのログ出力数を制御します。より堅実にログを残すには, 
true
に設定します。

getDebugMode

public static boolean getDebugMode()
SDK がデバッグモードである場合は 
true
を返します。

isInitialized

public static boolean isInitialized()
SDK が正常に初期化された場合は 
true
, それ以外の場合は 
false
を返します。

isSupported

public static bool isSupported()
SDK が現在のプラットフォームでサポートされる場合は 
true
, それ以外の場合は 
false
を返します。

UnityAdsLoadOptions

public class UnityAdsLoadOptions extends UnityAdsBaseOptions
このクラスには, 
load
 メソッドに追加する任意のメタデータが含まれています。サードパーティのメディエーションのヘッダー入札を使用しているお客様は, Unity ネットワークからの入札者が広告オークションで落札した場合にこれを使用する必要があります。

setAdMarkup

public void setAdMarkup(String adMarkup)
このメソッドは, 入札者サービスから返される広告マークアップを取得します。Unity の広告ネットワークからの入札者がヘッダー入札オークションで落札すると, Unity Ads SDK はメディエーションエクスチェンジから広告マークアップを受け取ります。広告マークアップ文字列には, Unity が広告をロードおよび表示するために必要な情報が含まれています。

setObjectId

public void setObjectId(String objectId)
このメソッドは, ロードされた広告オブジェクト ID を, 表示する広告オブジェクト ID として設定します。

BannerView

public BannerView(Activity activity, String adUnitId, UnityBannerSize size)

パラメーター

説明

activity
現在の Android 
Activity
。
adUnitId
表示する広告ユニットの識別子。
size
バナーオブジェクトの 
サイズ
。

getPlacementId

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
バナー広告ユニットの 広告ユニット ID を返します。

getSize

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
バナーの 
size
。

setListener

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
バナーのアクティブリスナーを設定します。

getListener

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
バナーのアクティブリスナーを取得します。

load

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
バナーに広告をリクエストするための基本メソッドです。

destroy

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
不要になったバナーをビュー階層から削除するには, このメソッドを呼び出します。

UnityBannerSize

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
このクラスを使用して, バナーオブジェクト の高さと幅を定義します。

getWidth

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
バナーオブジェクト の幅をピクセル単位で返します。

getHeight

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
バナーオブジェクト の高さをピクセル単位で返します。

列挙型

PlacementState

広告ユニット の状態を表す列挙型。

値

説明

READY
広告ユニットは広告を表示できる状態になっています。
NOT_AVAILABLE
広告ユニットを利用できません。
DISABLED
広告ユニットは無効になっています。
WAITING
広告ユニットは準備中です。
NO_FILL
広告ユニットには表示する広告がありません。

FinishState

ユーザーと広告とのインタラクションの状態を表す列挙型。広告が完了すると, SDK がこの値を 
onUnityAdsDidFinish
 コールバックメソッドに渡します。

値

説明

ERROR
Unity サービスのエラーにより広告を最後まで表示できなかったことを示します。
SKIPPED
ユーザーが広告をスキップしたことを示します。
COMPLETED
ユーザーが最後まで広告を見たことを示します。

UnityAdsInitializationError

SDK の初期化に失敗した理由を表す列挙型です。

値

説明

INTERNAL_ERROR
環境または内部サービスが原因でエラーが発生しました。
INVALID_ARGUMENT
initialize
 メソッド内の無効な引数が原因でエラーが発生しました。
AD_BLOCKER_DETECTED
URL がブロックされたことが原因でエラーが発生しました。

UnityAdsShowCompletionState

広告が終了した原因を表す列挙型です。

値

説明

SKIPPED
ユーザーが広告をスキップしたことを示します。
COMPLETED
広告が最後まで再生されたことを示します。これは一般的にユーザーが広告全体を視聴したことで報酬を受け取ることができることを示します。

UnityAdsLoadError

広告ユニット のロードが失敗した理由を表す列挙型。

値

説明

INITIALIZE_FAILED
SDK が初期化されていないことによって広告のロードに失敗しました。
INTERNAL_ERROR
Unity Ads の内部サービスエラーによって広告のロードに失敗しました。
INVALID_ARGUMENT
load
 メソッド内の無効な引数により広告のロードに失敗しました。
NO_FILL
ネットワークに利用可能なコンテンツがなかったため広告のロードに失敗しました。
TIMEOUT
指定の時間内に広告をロードできませんでした。

UnityAdsShowError

広告ユニット の表示に失敗した理由を表す列挙型。

値

説明

NOT_INITIALIZED
SDK が初期化されていなかったため広告の表示に失敗しました。
NOT_READY
広告ユニットの準備ができていなかったため広告の表示に失敗しました。
VIDEO_PLAYER_ERROR
メディアプレイヤーのエラーにより広告の表示に失敗しました。
INVALID_ARGUMENT
show
 メソッド内の無効な引数により広告の表示に失敗しました。
NO_CONNECTION
インターネット接続エラーにより広告の表示に失敗しました。
ALREADY_SHOWING
広告がすでに表示されていたため広告の表示に失敗しました。
INTERNAL_ERROR
Unity Ads の内部サービスエラーによって広告の表示に失敗しました。

UnityAdsError

String mObjectId = UUID.randomUUID().toString();
	UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
	loadOptions.setAdMarkup(markup);
	loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
追加に失敗した理由を表す列挙型です。

インターフェース

IUnityAdsInitializationListener

String mObjectId = UUID.randomUUID().toString();
	UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
	loadOptions.setAdMarkup(markup);
	loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
このインターフェースは, 
initialize
 の結果をハンドルするために実装します。

onInitializationComplete

このコールバックメソッドは, SDK が問題なく初期化されたときのロジックをハンドルします。

onInitializationFailed

このコールバックメソッドは, SDK の初期化が失敗したときのロジックをハンドルします。

パラメーター

説明

error
初期化の失敗の原因となった 
UnityAdsInitializationError
。
message
エラーに関連するメッセージです。

IUnityAdsLoadListener

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
このインターフェースは, 
load
 の結果をハンドルするために実装します。

onUnityAdsAdLoaded

このコールバックメソッドは, 広告ユニット が正常にロードされたときのロジックをハンドルします。

パラメーター

説明

adUnitId
コンテンツをロードした広告ユニットの識別子。

onUnityAdsFailedToLoad

このコールバックメソッドは, 広告ユニット のロードが失敗したときのロジックをハンドルします。

パラメーター

説明

adUnitId
コンテンツのロードに失敗した広告ユニットの識別子。
error
ロード失敗の原因となった 
UnityAdsLoadError
。
message
エラーに関連するメッセージです。

IUnityAdsShowListener

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
このインターフェースは, 
show
 の結果をハンドルするために実装します。

onUnityAdsShowFailure

このコールバックメソッドは, 広告ユニット の表示が失敗したときのロジックをハンドルします。

パラメーター

説明

adUnitId
コンテンツの表示に失敗した広告ユニットの識別子。
error
表示失敗の原因となった 
UnityAdsShowError
。
message
エラーに関連するメッセージです。

onUnityAdsShowStart

このコールバックメソッドは, 広告再生開始時のロジックをハンドルします。

パラメーター

説明

adUnitId
コンテンツを表示している 広告ユニット の識別子。

onUnityAdsShowClick

このコールバックメソッドは, ユーザーが広告をクリックしたときのロジックをハンドルします。

パラメーター

説明

adUnitId
コンテンツを表示している 広告ユニット の識別子。

onUnityAdsShowComplete

このコールバックメソッドは, 広告視聴終了時のロジックをハンドルします。

パラメーター

説明

adUnitId
コンテンツを表示している 広告ユニット の識別子。
showCompletionState
広告がスキップされたか, 完全視聴したかを示します。

IUnityAdsListener

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
このインターフェースは, 広告のさまざまな状態をハンドルするために実装します。リワード広告 のロジックを定義するには, このリスナーをスクリプトに実装します。

onUnityAdsReady

指定された 広告ユニット を通じて表示する広告コンテンツの準備ができているときのロジックを指定します。

パラメーター

説明

adUnitId
準備ができている広告ユニットの識別子。

onUnityAdsDidError

エラーによって広告コンテンツの表示に失敗したときのロジックを指定します。

パラメーター

説明

error
広告視聴失敗の原因となったエラーです。
message
エラーに関連するメッセージです。

onUnityAdsDidStart

プレイヤーが広告の表示をトリガーしたときのロジックを指定します。

パラメーター

説明

adUnitId
広告を表示している 広告ユニット の識別子。

OnUnityAdsDidFinish

プレイヤーが広告を最後まで見たときのロジックを指定します。

パラメーター

説明

adUnitId
表示が完了した 広告ユニット の識別子。
result
表示している広告の 結果として生成されたユーザーイベント。

IListener

String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);
このインターフェースは, バナーライフサイクルイベントへのアクセスを付与します。さらに, 以下のオーバーライドメソッドを実装できます。 
String mObjectId = UUID.randomUUID().toString();
UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
loadOptions.setAdMarkup(markup);
loadOptions.setObjectId(mObjectId);
UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

onBannerLoaded

このコールバックは, バナーが広告のロードを終了したときに呼び出されます。ビューパラメーターは, ビュー階層に挿入されるバナーを参照します。

パラメーター

説明

bannerAdView
ロードした バナーオブジェクト。

onBannerClick

このコールバックはバナーがクリックされたときに呼び出されます。

パラメーター

説明

bannerAdView
ロードした バナーオブジェクト。

onBannerError

このコールバックはバナー表示時にエラーが発生したときに呼び出されます。

パラメーター

説明

bannerAdView
ロードした バナーオブジェクト。
errorInfo
バナーのロードエラーについての情報を含んでいるクラスです。

onBannerLeftApplication

このコールバックはバナーがアプリ外部へリンクするときに呼び出されます。

パラメーター

説明

bannerAdView
ロードした バナーオブジェクト。