ドキュメント

サポート

Unity Ads Monetization

Android developer monetization guide

iOS developer monetization guide

Privacy consent setup

Unity Ads Monetization

Unity Ads SDK API リファレンス

Access the Unity Ads SDK public API reference to view available classes, methods, and properties you can use in C# to integrate and control ad behavior in your Unity project.
読み終わるまでの所要時間 7 分最終更新 2ヶ月前
Advertisements
名前空間は, 動画リワード広告, 非リワード型動画広告, インタースティシャル広告, バナー広告などの基本的な広告コンテンツを実装するために使用します。 
using UnityEngine.Advertisements;
この記事は以下の API ドキュメントを含んでいます。 クラス 列挙型 インターフェース

クラス

Advertisement

Initialize

public static void Initialize(string gameId, bool testMode, IUnityAdsInitializationListener initializationListener)
指定された ゲーム ID, テストモード のステータス, 広告ユニット のロード設定を使用して, 広告サービスを初期化します。

パラメーター

説明

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

Load

public static void Load (string adUnitId, IUnityAdsLoadListener loadListener)
指定された 広告ユニット の広告コンテンツをロードします。

パラメーター

説明

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

IsReady

static bool IsReady (string adUnitId)
広告を指定した 広告ユニット に表示する準備が整っている場合は, 
true
を返します。SDK 初期化時に 
enablePerPlacementLoad
を有効にした場合, 
Show
 を呼び出す前に 
Load
 を呼び出す必要があります。

パラメーター

説明

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

Show

public static void Show(string adUnitId, ShowOptions showOptions, IUnityAdsShowListener showListener)
指定した 広告ユニット にロードされた広告コンテンツを表示します。

パラメーター

説明

adUnitId
表示する広告ユニットの識別子。
showOptions
resultCallback
 など, 動作を変更するためのオプションのコレクション。
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 コールバックのリスナー。

GetPlacementState

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

パラメーター

説明

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

isInitialized

public static bool isInitialized
SDK が初期化された場合は 
true
, それ以外の場合は 
false
を返します。

isSupported

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

debugMode

public static bool debugMode
SDK がデバッグモードの場合は 
true
, それ以外の場合は 
false
を返します。デバッグモードで SDK からのログのレベルを制御します。

version

public static string version
現在の SDK のバージョンを返します。

isShowing

public static bool isShowing
広告が現在表示されている場合は 
true
, それ以外の場合は 
false
を返します。

Banner

バナー広告を実装 するには, このクラスを使用します。

Load

public static void Load(string adUnitId, BannerLoadOptions options)
指定されたバナー 広告ユニット の広告コンテンツをロードします。SDK 初期化時に 
enablePerPlacementLoad
を有効にした場合, 
Show
 を呼び出す前に 
Load
を呼び出す必要があります。

パラメーター

説明

adUnitId
ロードするバナー広告ユニットの識別子。
options
バナーのロード時に SDK にイベントを通知する オプション のコレクション。

Show

public static void Show(string adUnitId, BannerOptions options)
指定されたバナー 広告ユニット の広告コンテンツを表示します。
Show
を呼び出す前に, 
Load
 を呼び出す必要があります。

パラメーター

説明

adUnitId
ロードするバナー広告ユニットの識別子。
options
バナーの表示時に SDK にイベントを通知する オプション のコレクション。

Hide

public static void Hide(bool destroy = false)
バナー広告を除去せずに非表示にすることができます。

SetPosition

public void SetPosition (BannerPosition bannerPosition)
デバイス上のバナー広告の位置を設定します。

パラメーター

説明

bannerPosition
バナー広告のアンカーとして使用する 位置。

isLoaded

public static bool isLoaded
バナー広告が表示用に現在ロードされている場合は 
true
, それ以外の場合は 
false
を返します。

ShowOptions

これらのオプションを実装して, 広告ユニットでコンテンツを表示するときに SDK にイベントを通知します。
ShowOptions.resultCallback
を使用して, 広告の終了時に 
ShowResult
 列挙型を Show に渡します。

resultCallback

public ShowResult resultCallback { get; set; }
このコールバックは広告の結果を受け取ります。

gamerSid

public string gamerSid { get; set; }
ゲーム内の特定のユーザーの識別子を指定します。

BannerLoadOptions

これらのオプションを実装して, バナー広告のロード時に SDK にイベントを通知します。

loadCallback

public LoadCallback loadCallback { get; set; }
このコールバックは, バナー 広告ユニット が, 表示する準備ができているコンテンツを正常にロードしたときに発生します。

errorCallback

public ErrorCallback errorCallback { get; set; }
このコールバックは, バナー 広告ユニット がコンテンツのロードに失敗したときに発生します。

BannerOptions

これらのオプションを実装して, バナー広告の表示時に SDK にイベントを通知します。

bannerCallback

public BannerCallback bannerCallback { get; set; }
このコールバックは, バナーがユーザーに表示されたときに発生します。

hideCallback

public BannerCallback hideCallback { get; set; }
このコールバックは, バナーがユーザーに対して非表示になったときに発生します。

clickCallback

public BannerCallback clickCallback { get; set; }
このコールバックは, ユーザーがバナーをクリックしたときに発生します。

列挙型

PlacementState

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

値

説明

Ready
広告ユニットは広告を表示できる状態になっています。
NotAvailable
広告ユニットを利用できません。
Disabled
広告ユニットは無効になっています。
Waiting
広告ユニットは準備中です。
NoFill
広告ユニットに表示する広告がありません。

ShowResult

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

値

説明

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

UnityAdsInitializationError

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

値

説明

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

UnityAdsLoadError

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

値

説明

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

UnityAdsShowCompletionState

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

値

説明

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

UnityAdsShowError

広告の表示が失敗した理由を表す列挙型。

値

説明

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

BannerPosition

デバイスのディスプレイ上のバナーを固定する位置を列挙したものです。

値

説明

TOP_LEFT
バナーを画面の左上に固定します。
TOP_CENTER
バナーを画面の上部中央に固定します。
TOP_RIGHT
バナーを画面の右上に固定します。
BOTTOM_LEFT
バナーを画面の左下に固定します。
BOTTOM_CENTER
バナーを画面の下部中央に固定します。
BOTTOM_RIGHT
バナーを画面の右下に固定します。
CENTER
バナーを画面の中央に固定します。

インターフェース

IUnityAdsInitializationListener

public interface IUnityAdsInitializationListener {
    void OnInitializationComplete();
    void OnInitializationFailed(UnityAdsInitializationError error, string message);
}
このインターフェースは, 
Initialize
 の結果をハンドルするために実装します。

OnInitializationComplete

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

OnInitializationFailed

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

パラメーター

説明

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

IUnityAdsLoadListener

public interface IUnityAdsLoadListener {
    void OnUnityAdsAdLoaded(string adUnitId);
    void OnUnityAdsFailedToLoad(string adUnitId, UnityAdsLoadError error, string message);
}
このインターフェースは, 
Load
 の結果をハンドルするために実装します。

OnUnityAdsLoaded

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

パラメーター

説明

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

OnUnityAdsFailedToLoad

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

パラメーター

説明

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

IUnityAdsShowListener

public interface IUnityAdsShowListener {
    void OnUnityAdsShowFailure(string adUnitId, UnityAdsShowError error, string message);
    void OnUnityAdsShowStart(string adUnitId);
    void OnUnityAdsShowClick(string adUnitId);
    void OnUnityAdsShowComplete(string adUnitId, UnityAdsShowCompletionState showCompletionState);
}
このインターフェースは, 
Show
 の結果をハンドルするために実装します。

OnUnityAdsShowFailure

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

パラメーター

説明

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

OnUnityAdsShowStart

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

パラメーター

説明

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

OnUnityAdsShowClick

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

パラメーター

説明

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

OnUnityAdsShowComplete

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

パラメーター

説明

adUnitId
コンテンツを表示している広告ユニットの識別子。
showCompletionState
広告の最終的な 状態 (広告がスキップされたか完了したか) を示します。

IUnityAdsListener

public interface IUnityAdsListener
{
    void OnUnityAdsReady(string adUnitId);
    void OnUnityAdsDidError(string message);
    void OnUnityAdsDidStart(string adUnitId);
    void OnUnityAdsDidFinish(string adUnitId, ShowResult showResult);
}
このインターフェースは, 広告のさまざまな状態をハンドルするために実装します。リワード広告 のロジックを定義するには, このリスナーをスクリプトに実装します。

OnUnityAdsReady

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

パラメーター

説明

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

OnUnityAdsDidError

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

パラメーター

説明

message
エラーに関連するメッセージです。

OnUnityAdsDidStart

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

パラメーター

説明

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

OnUnityAdsDidFinish

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

パラメーター

説明

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