Unity Ads iOS SDK API リファレンス

UnityAds.h ライブラリを使用して, 動画リワード広告, 非リワード型動画広告, インタースティシャル広告, バナー広告などの基本的な広告コンテンツを実装します。

#import "UnityAds.h"

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

クラス

• UnityAds
• UADSLoadOptions
• UADSBannerView

列挙型

• UnityAdsBannerPosition
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsError

デリゲート

• UnityAdsInitializationDelegate
• UnityAdsLoadDelegate
• UnityAdsShowDelegate
• UADSBannerDelegate
• UADSBannerAdRefreshViewDelegate

クラス

クラス

UnityAds

UnityAds

#import <UnityAds/UnityAds.h>

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

initialize

initialize

+ (void) initialize: (NSString *)gameId
    testMode: (BOOL)testMode
    initializationDelegate: (nullable id<UnityAdsInitializationDelegate>)initializationDelegate;
}

指定された ゲーム ID, テストモード のステータス, 初期化デリゲートを使用して, 広告サービスを初期化します。

load

load

+ (void)load: (NSString *)placementId options: (UADSLoadOptions *)options loadDelegate: (nullable id<UnityAdsLoadDelegate>)loadDelegate {
  [UADSLoadModule.sharedInstance loadForPlacementID: placementId
                                            options: options
                                       loadDelegate: loadDelegate];
}

指定された 広告ユニット の広告コンテンツをロードします。show を呼び出す前に, load を呼び出す必要があります。

isReady

isReady

+ (BOOL)isReady: (NSString *)adUnitId {
    return [UnityServices isSupported] && [UnityServices isInitialized] && [UADSPlacement isReady: adUnitId];
}

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

.

show

show

+ (void)show: (UIViewController *)viewController placementId: (NSString *)placementId showDelegate: (nullable id<UnityAdsShowDelegate>)showDelegate {
    	[self show: viewController
          adUnitId: placementId
    	   options: [UADSShowOptions new]
   	  showDelegate: showDelegate];
}

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

addDelegate

addDelegate

+ (void)addDelegate: (__nullable id<UnityAdsDelegate>)delegate {
    [UADSProperties addDelegate: delegate];
}

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

removeDelegate

removeDelegate

+ (void)removeDelegate: (id<UnityAdsDelegate>)delegate {
    [UADSProperties removeDelegate: delegate];
}

アクティブな UnityAdsDelegate リスナーを削除します。

setDebugMode

setDebugMode

+ (BOOL)getDebugMode {
    return [UnityServices getDebugMode];
}

SDK からのログ出力数を制御します。より堅実にログを残すには, YES に設定します。

getDebugMode

getDebugMode

+ (void)getDebugMode: (BOOL)enableDebugMode {
    [UnityServices setDebugMode: enableDebugMode];
}

SDK がデバッグモードの場合は YES, それ以外の場合は NO を返します。

getVersion

getVersion

+ (NSString *)getVersion {
    return [UnityServices getVersion];
}

Unity Ads SDK の現在のバージョンを返します。

isInitialized

isInitialized

+ (BOOL)isInitialized {
    return [USRVSdkProperties isInitialized];
}

SDK が正常に初期化された場合は YES, それ以外の場合は NO を返します。

UADSLoadOptions

UADSLoadOptions

#import <UnityAds/UADSBaseOptions.h>

@interface UADSLoadOptions : UADSBaseOptions

@property (nonatomic, readwrite) NSString *adMarkup;

@end

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

setAdMarkup

setAdMarkup

- (void)setAdMarkup: (NSString *)adMarkup

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

UADSBannerView

UADSBannerView

@interface UADSBannerView : UIView

バナー広告を実装 するには, このクラスを使用します。Unity Ads バージョン 3.3 以降は, 1 つの 広告ユニット を介した複数のバナーインスタンスに対応しています。

initWithPlacementId

initWithPlacementId

-(instancetype)initWithPlacementId:(NSString *)placementId size:(CGSize)size;

広告ユニット ID とバナーサイズを使用してバナービューを実装します。initWithPlacementId を呼び出してオブジェクトを初期化してから, load を呼び出して広告コンテンツをロードします。バナーオブジェクトが UADSBannerViewDelegate リスナーを介してライフサイクルイベントにアクセスすることに注意してください。

load

load

- (void)load;

バナーに広告をリクエストするための基本メソッドです。

列挙型

列挙型

UnityAdsPlacementState

UnityAdsPlacementState

typedef NS_ENUM(NSInteger, UnityAdsPlacementState)

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

UnityAdsFinishState

UnityAdsFinishState

typedef NS_ENUM(NSInteger, UnityAdsFinishState)

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

UnityAdsInitializationError

UnityAdsInitializationError

typedef NS_ENUM (NSInteger, UnityAdsInitializationError)

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

UnityAdsLoadError

UnityAdsLoadError

typedef NS_ENUM (NSInteger, UnityAdsLoadError)

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

UnityAdsShowCompletionState

UnityAdsShowCompletionState

typedef NS_ENUM (NSInteger, UnityAdsShowCompletionState)

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

UnityAdsShowError

UnityAdsShowError

typedef NS_ENUM (NSInteger, UnityAdsShowError)

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

UnityAdsError

UnityAdsError

typedef NS_ENUM (NSInteger, UnityAdsError)

unityAdsDidError コールバックを通じて発生した Unity Ads のエラーの原因を表す列挙型。

UnityAdsBannerPosition

UnityAdsBannerPosition

バナー広告のアンカーとして設定可能な位置を表す列挙型。

デリゲート

デリゲート

UnityAdsInitializationDelegate

UnityAdsInitializationDelegate

@protocol UnityAdsInitializationDelegate <NSObject>
- (void)initializationComplete;
- (void)initializationFailed: (UnityAdsInitializationError)error withMessage: (NSString *)message;
@end

このデリゲートは initialize の結果をハンドルするために実装します。

initializationComplete

initializationComplete

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

initializationFailed

initializationFailed

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

UnityAdsLoadDelegate

UnityAdsLoadDelegate

@protocol UnityAdsLoadDelegate <NSObject>
- (void)unityAdsAdLoaded: (NSString *)placementId;
- (void)unityAdsAdFailedToLoad: (NSString *)placementId
                     withError: (UnityAdsLoadError)error
                   withMessage: (NSString *)message;
@end

このデリゲートは load の結果をハンドルするために実装します。

unityAdsAdLoaded

unityAdsAdLoaded

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

unityAdsAdFailedToLoad

unityAdsAdFailedToLoad

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

UnityAdsShowDelegate

UnityAdsShowDelegate

@protocol UnityAdsShowDelegate <NSObject>
- (void)unityAdsShowComplete: (NSString *)adUnitId withFinishState: (UnityAdsShowCompletionState)state;
- (void)unityAdsShowFailed: (NSString *)adUnitId withError: (UnityAdsShowError)error withMessage: (NSString *)message;
- (void)unityAdsShowStart: (NSString *)adUnitId;
- (void)unityAdsShowClick: (NSString *)adUnitId;
@end

このデリゲートは show の結果をハンドルするために実装します。

unityAdsShowComplete

unityAdsShowComplete

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

unityAdsShowStart

unityAdsShowStart

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

unityAdsShowClick

unityAdsShowClick

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

unityAdsShowFailed

unityAdsShowFailed

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

UnityAdsDelegate

UnityAdsDelegate

@protocol UnityAdsDelegate <NSObject>
- (void)unityAdsReady: (NSString *)placementId;
- (void)unityAdsDidError: (UnityAdsError)error withMessage: (NSString *)message;
- (void)unityAdsDidStart: (NSString *)placementId;
- (void)unityAdsDidFinish: (NSString *)placementId
          withFinishState: (UnityAdsFinishState)state;
@end

このデリゲートは広告のさまざまな状態をハンドルするために実装します。リワード広告 のロジックを定義するには, これをスクリプトに実装します。

unityAdsReady

unityAdsReady

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

unityAdsDidError

unityAdsDidError

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

unityAdsDidStart

unityAdsDidStart

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

unityAdsDidFinish

unityAdsDidFinish

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

UADSBannerDelegate

UADSBannerDelegate

@protocol UADSBannerViewDelegate <NSObject>

@optional
- (void)bannerViewDidLoad: (UADSBannerView *)bannerView;
- (void)bannerViewDidClick: (UADSBannerView *)bannerView;
- (void)bannerViewDidLeaveApplication: (UADSBannerView *)bannerView;
- (void)bannerViewDidError: (UADSBannerView *)bannerView error: (UADSBannerError *)error;
@end

このデリゲートは Unity Ads のバナーイベントからのコールバックを提供します。

bannerViewDidLoad

bannerViewDidLoad

このコールバックは, バナーが広告コンテンツを正常にロードしたときに発生します。

bannerViewDidClick

bannerViewDidClick

このコールバックは, ユーザーがバナー広告をクリックしたときに発生します。

bannerViewDidLeaveApplication

bannerViewDidLeaveApplication

このコールバックは, ユーザーがアプリを終了したことでバナーが閉じられたときに発生します。

bannerViewDidError

bannerViewDidError

このコールバックは, UnityAdsBanner でエラーが発生したときに発生します。

UADSBannerAdRefreshViewDelegate

UADSBannerAdRefreshViewDelegate

@protocol UADSBannerAdRefreshViewDelegate <NSObject>

@optional
- (void)unityAdsRefreshBannerDidLoad: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidNoFill: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidShow: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidHide: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidClick: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidError: (UADSBannerAdRefreshView *)bannerAdRefreshView message: (NSString *)message;
@end

このデリゲートは Unity Ads のバナーの再読み込みイベントからのコールバックを提供します。

unityAdsRefreshBannerDidLoad

unityAdsRefreshBannerDidLoad

バナーがロードされ, ビュー階層に配置される準備が整ったときに呼び出されます。

unityAdsRefreshBannerDidNoFill

unityAdsRefreshBannerDidNoFill

バナーに広告コンテンツがないときに呼び出されます。

unityAdsRefreshBannerDidShow

unityAdsRefreshBannerDidShow

バナーがユーザーに表示されているときに呼び出されます。

unityAdsRefreshBannerDidHide

unityAdsRefreshBannerDidHide

バナーがユーザーに表示されていないときに呼び出されます。

unityAdsRefreshBannerDidClick

unityAdsRefreshBannerDidClick

ユーザーがバナー広告をクリックしたときに呼び出されます。

unityAdsRefreshBannerDidError

unityAdsRefreshBannerDidError

UnityAdsBanner でエラーが発生したときに呼び出されます。