Unity Ads SDK API リファレンス#

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

using UnityEngine.Advertisements;

この記事は以下の API ドキュメントを含んでいます。

クラス

• Advertisement
• Banner
• BannerLoadOptions
• BannerOptions
• ShowOptions

列挙型

• ShowResult
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsShowCompletionState
• BannerPosition

インターフェース

• IUnityAdsInitializationListener
• IUnityAdsLoadListener
• IUnityAdsShowListener

クラス#

Advertisement#

Initialize#

public static void Initialize(string gameId, bool testMode, IUnityAdsInitializationListener initializationListener)

指定された ゲーム ID、テストモード のステータス、広告ユニット のロード設定を使用して、広告サービスを初期化します。

Load#

public static void Load (string adUnitId, IUnityAdsLoadListener loadListener)

指定された 広告ユニット の広告コンテンツをロードします。

IsReady#

static bool IsReady (string adUnitId)

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

Show#

public static void Show(string adUnitId, ShowOptions showOptions, IUnityAdsShowListener showListener)

指定した 広告ユニット にロードされた広告コンテンツを表示します。

AddListener#

public static void AddListener(IUnityAdsListener listener)

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

RemoveListener#

public static void RemoveListener(IUnityAdsListener listener)

アクティブな IUnityAdsListener を削除します。

GetPlacementState#

public static PlacementState GetPlacementState(string 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 を呼び出す必要があります。

Show#

public static void Show(string adUnitId, BannerOptions options)

指定されたバナー 広告ユニット の広告コンテンツを表示します。Show を呼び出す前に、Load を呼び出す必要があります。

Hide#

public static void Hide(bool destroy = false)

バナー広告を除去せずに非表示にすることができます。

SetPosition#

public void SetPosition (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#

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

ShowResult#

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

UnityAdsInitializationError#

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

UnityAdsLoadError#

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

UnityAdsShowCompletionState#

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

UnityAdsShowError#

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

BannerPosition#

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

インターフェース#

IUnityAdsInitializationListener#

public interface IUnityAdsInitializationListener {
    void OnInitializationComplete();
    void OnInitializationFailed(UnityAdsInitializationError error, string message);
}

このインターフェースは、Initialize の結果をハンドルするために実装します。

OnInitializationComplete#

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

OnInitializationFailed#

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

IUnityAdsLoadListener#

public interface IUnityAdsLoadListener {
    void OnUnityAdsAdLoaded(string adUnitId);
    void OnUnityAdsFailedToLoad(string adUnitId, UnityAdsLoadError error, string message);
}

このインターフェースは、Load の結果をハンドルするために実装します。

OnUnityAdsLoaded#

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

OnUnityAdsFailedToLoad#

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

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#

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

OnUnityAdsShowStart#

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

OnUnityAdsShowClick#

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

OnUnityAdsShowComplete#

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

IUnityAdsListener#

public interface IUnityAdsListener
{
    void OnUnityAdsReady(string adUnitId);
    void OnUnityAdsDidError(string message);
    void OnUnityAdsDidStart(string adUnitId);
    void OnUnityAdsDidFinish(string adUnitId, ShowResult showResult);
}

このインターフェースは、広告のさまざまな状態をハンドルするために実装します。リワード広告 のロジックを定義するには、このリスナーをスクリプトに実装します。

OnUnityAdsReady#

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

OnUnityAdsDidError#

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

OnUnityAdsDidStart#

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

OnUnityAdsDidFinish#

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