ドキュメント

​
​

Development

User Acquisition

Monetization

産業

Unity Ads Monetization

SDK 4.19.0

サポート対象
​

iOS API リファレンス - Swift

iOS API リファレンス - Objective-C

Unity Ads Monetization

SDK 4.19.0

サポート対象
​

iOS developer guides
​
​
iOS 開発者ガイド
  • iOS SDK インテグレーションガイド
  • Unity Ads プライバシー ガイド
  • Unity Ads SDK トラブルシューティング ガイド
  • iOS 開発者 API リファレンス - Swift
  • iOS 開発者 API リファレンス - Objective-C
  • iOS の非推奨 API
  1. Unity Ads SDK iOS 開発者 Monetization
  2. iOS 開発者向け Unity Ads SDK インテグレーションガイド
  3. iOS 開発者 API リファレンス

Unity Ads iOS SDK API リファレンス - Swift

Unity Ads SDK のパブリック API リファレンスにアクセスして、Swift で使用可能なクラス、メソッド、プロパティを表示し、iOS アプリケーションの広告動作を統合およびコントロールできます。
読み終わるまでの所要時間 49 分
最終更新 7日前

Swift で Unity Ads Android SDK API を使用して Unity Ads を iOS アプリケーションに統合する場合は、このリファレンスを参照してください。
このAPIを使用する前に、アプリケーションでMonetizationを有効にするために
UnityAds
ライブラリをインポートしていることを確認してください。詳細については、UnityAds ライブラリのインポート を参照してください。

クラス

UADSBannerAd

UADSBannerAd
クラスはバナー広告のロードと表示を管理します。

load(_:completion)

public class UADSBannerAd:NSObject { パブリック静的関数ロード(_ 設定:UADSBannerLoadConfiguration, completion: @escaping (UADSBannerAd?, UnityAdsError?) -> Void)}
指定した設定のバナー広告をロードします。

Parameters

説明

configurationバナー広告をロードするためのオプション。
completionバナーがロードされたときに呼び出されるコールバック。ロードに成功した場合はロードされた UADSBannerAd インスタンスを返し、ロードに失敗した場合は UnityAdsError を返します。

onAdExpired

public var onAdExpired: ((UADSBannerAd) -> Void)?
広告の有効期限が切れたときにトリガーされるコールバック。このプロパティは、ロードされたバナー広告が期限切れになり、有効でなくなったときに通知されるように設定します。

ビュー

public class UADSBannerAd:UIView { public var ビュー:UIView}
バナー広告インスタンスへのアクセスを提供するビュープロパティ。このプロパティを使用して、アプリケーションの既存のビュー階層内の目的の場所にバナー広告を挿入します。

UADSBannerView

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSBannerAd
を使用してください。移行の詳細については、iOS 非推奨 API を参照してください。
UADSBannerView
はバナー広告をロードおよび表示するための前のクラスです。

UADSBannerViewDelegate

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSBannerAdDelegate
を使用してください。移行の詳細については、iOS 非推奨 API を参照してください。
UADSBannerViewDelegate
はバナー広告イベントを処理するための以前のデリゲートプロトコルです。

UADSBannerLoadConfiguration

UADSBannerLoadConfiguration
クラスはバナー広告のロードに必要なオプションをカプセル化します。これには、配置 ID、バナーサイズ、任意の広告マークアップ、任意デリゲート、その他のパラメータの指定が含まれます。
パブリッククラス UADSBannerLoadConfiguration:NSObject { @objc public private(set) var placementId:String @objc public private(set) var adMarkup:文字列? @objc public private(set) var bannerSize:CGSize @objc public private(set) var delegate:UADSBannerAdDelegate @objc public private(set) var mediationAdUnitId:文字列? @objc public private(set) var mediationInfo:UADSMediationInfo? @objc public private(set) var extras: [文字列:String]}

Property

説明

必須

placementId
Unity 収益化ダッシュボードで定義された配置 ID。はい
adMarkup
入札を通じて広告をロードするときに使用される広告マークアップデータ。いいえ
bannerSize
バナー広告のサイズ。はい
delegate
バナー広告イベントをハンドルするデリゲート。はい
mediationAdUnitId
メディエーションパートナーのダッシュボードで定義された広告単位または配置 ID。いいえ
mediationInfo
メディエーションインテグレーションの詳細を指定します。いいえ
extras
追加のカスタム キーと値のペア。いいえ

UADSBannerLoadConfigurationBuilder

UADSBannerLoadConfigurationBuilder
を使用して、
UADSBannerLoadConfiguration
クラスのインスタンスを作成し、返します。

init(placementId, bannerSize, delegate)

public init(placementId:文字列、 bannerSize:CGSize、 デリゲート:UADSBannerAdDelegate)
UADSBannerLoadConfigurationBuilder
の新しいインスタンスを作成します。

Property

説明

必須

placementId
Unity 収益化ダッシュボードで定義された配置 ID。はい
bannerSize
バナー広告のサイズ。はい
delegate
バナー広告イベントをハンドルするデリゲート。はい
戻り値:
UADSBannerLoadConfigurationBuilder
のインスタンス

with(adMarkup:)_

public func with(adMarkup:文字列) -> Self
adMarkup を
UADSBannerLoadConfigurationBuilder
に追加します。

パラメーター

説明

adMarkup入札を通じて広告をロードするときに使用される広告マークアップデータ。
戻り値:更新された
UADSBannerLoadConfigurationBuilder
インスタンス。

with(mediationAdUnitId:)_

public func with(mediationAdUnitId:文字列) -> Self
メディエーション広告単位 ID を
UADSBannerLoadConfigurationBuilder
に追加します。

パラメーター

説明

mediationAdUnitIdメディエーションパートナーのダッシュボードで定義された広告単位または配置 ID。
戻り値:更新された
UADSBannerLoadConfigurationBuilder
インスタンス。

with(mediationInfo:)_

public func with(mediationInfo:UADSMediationInfo) -> Self
メディエーション情報を
UADSBannerLoadConfigurationBuilder
に追加します。

パラメーター

説明

mediationInfoメディエーションのインテグレーションに関する詳細(名前、バージョン、アダプタのバージョン)。
戻り値:更新された
UADSBannerLoadConfigurationBuilder
インスタンス。

with(extras:)_

public func with(extras: [文字列:String]) -> Self
余分なキーと値のパラメータを
UADSBannerLoadConfigurationBuilder
に追加します。

パラメーター

説明

extrasバナー ロードのカスタム パラメータ。
戻り値:更新された UADSBannerLoadConfigurationBuilder インスタンス

build()_

public func build() -> UADSBannerLoadConfiguration
UADSBannerLoadConfiguration
インスタンスをビルドして返します。
戻り値:
UADSBannerLoadConfiguration
のインスタンス

UADSBannerLoadOptions

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSBannerLoadConfiguration
と
UADSBannerLoadConfigurationBuilder
を使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UADSBannerLoadOptions
はバナー ロード オプションを指定するための前のクラスです。

UADSInitializationConfiguration

public クラス UADSInitializationConfiguration:NSObject { @objc public private(set) var gameId:String @objc public private(set) var isTestModeEnabled:ブーリアン @objc public private(set) var logLevel:UADSLogLevel @objc public private(set) var mediationInfo:UADSMediationInfo? @objc public private(set) var extras: [文字列:String]}
UADSInitializationConfiguration
クラスは、Unity Ads SDK の初期化に必要なアプリケーションに関する重要な情報で構成される オブジェクトを作成します。

Property

説明

必須

gameId
Unity Ads の収益化ダッシュボードからの一意のゲーム識別子。はい
isTestModeEnabled
テストモードを有効にするブーリアンです。true の場合、テスト広告のみが表示されます。デフォルトは false。いいえ
logLevel
ログ出力の LOD を指定します。デフォルトは INFO です。いいえ
mediationInfo
メディエーションのインテグレーションに関する情報を格納するオブジェクト。いいえ
extras
カスタム設定の追加キー/値パラメータのマップ。いいえ

UADSInitializationConfigurationBuilder

UADSInitializationConfigurationBuilder
を使用して、
UADSInitializationConfiguration
クラスのインスタンスを作成し、返します。

Initialize

public 静的 func initialize(_ 設定:)UADSInitializationConfiguration, completion: @escaping (UnityAdsError?) -> Void)
指定した設定で Unity Ads SDK を初期化します。完了ハンドラーは、初期化が成功または失敗で完了したときに呼び出されます。

パラメーター

説明

configurationSDK の初期化に必要な設定を含む UADSInitializationConfiguration オブジェクト。
completion完了コールバックは完了時に呼び出され、成功を示すか、エラーメッセージとエラーコードで失敗の理由を詳しく示します。

init(gameId:)_

public init(gameId:文字列)
UADSInitializationConfigurationBuilder
の新しいインスタンスを作成します。

パラメーター

説明

gameIdUnity Ads 管理ツールまたは Unity エディターによって与えられるゲームの一意の識別子。
戻り値:
UADSInitializationConfigurationBuilder
のインスタンス

with(testMode:)_

public func with(testMode:ブーリアン) -> Self
テストモードを設定します。

パラメーター

説明

testModeこのフラグを
true
に設定すると、テストモードを示し、テスト広告のみが表示されます。
戻り値:更新された
UADSInitializationConfigurationBuilder
インスタンス。

with(logLevel:)_

public func with(logLevel:UADSLogLevel) -> Self
ログ レベルを設定します。ログに含まれる詳細の量を、なしから完全なデバッグ情報までの範囲で定義します。

パラメーター

説明

logLevelログ出力の詳細レベルを指定します。
戻り値:更新された
UADSInitializationConfigurationBuilder
インスタンス。

with(mediationInfo:)_

public func with(mediationInfo:UADSMediationInfo) -> Self
メディエーション情報を設定します。メディエーション名、バージョン、アダプターのバージョンなど、アプリケーションのメディエーションインテグレーションに関する詳細を提供します。

パラメーター

説明

mediationInfoメディエーションインテグレーションの詳細を指定します。
戻り値:更新された
UADSInitializationConfigurationBuilder
インスタンス。

with(extras:)_

public func with(extras: [文字列:String]) -> Self
追加のパラメーターを設定します。

パラメーター

説明

extrasカスタム設定の追加のキーと値のペア。
戻り値:更新された
UADSInitializationConfigurationBuilder
インスタンス。

build()

public func build() -> UADSInitializationConfiguration
UADSInitializationConfiguration
インスタンスをビルドして返します。
戻り値:
UADSInitializationConfiguration
のインスタンス

UADSInterstitialAd

UADSInterstitialAd
クラスは、全画面のインタースティシャル広告のロードと表示を管理します。

load(_:completion)

public class UADSInterstitialAd:NSObject { パブリック静的関数ロード(_ 設定:UADSLoadConfiguration, completion: @escaping (UADSInterstitialAd?, UnityAdsError?) -> Void)}
指定された設定のインタースティシャル広告をロードします。

Parameters

説明

configuration広告のロードオプションを含む UADSLoadConfiguration のインスタンス。
completionロード処理が完了したときに呼び出されるコールバック。成功した場合は UADSInterstitialAd インスタンスを返し、ロードに失敗した場合は UnityAdsError を返します。

show(_:delegate:)

public class UADSInterstitialAd:NSObject { public func show(_ configuration:UADSShowConfiguration? = nil, デリゲート:UADSInterstitialShowDelegate)}
ロードされたインタースティシャル広告を表示します。

パラメーター

説明

configuration広告を表示するための任意設定。
delegate広告イベントをハンドルする UADSInterstitialShowDelegate に準拠したデリゲート。

onAdExpired

広告の有効期限が切れたときにトリガーされるコールバックバックを登録します。
public class UADSInterstitialAd:NSObject { public var onAdExpired: ((UnityAd) -> Void)?}

UADSLoadConfiguration

UADSLoadConfiguration
クラスは、Unity Ads のロードに必要なオプションをカプセル化します。これには、配置 ID、任意の広告マークアップ、追加のパラメータの指定が含まれます。
パブリッククラス UADSLoadConfiguration:NSObject { @objc public private(set) var placementId:String @objc public private(set) var adMarkup:文字列? @objc public private(set) var mediationAdUnitId:文字列? @objc public private(set) var mediationInfo:UADSMediationInfo? @objc public private(set) var extras: [文字列:String]}
UADSLoadConfiguration
の新しいインスタンスを作成します。

Property

説明

必須

placementId
Unity 収益化ダッシュボードで定義された配置 ID。はい
adMarkup
入札を通じて広告をロードするときに使用される広告マークアップデータ。nil の場合はウォーターフォールです。いいえ
mediationAdUnitId
メディエーションパートナーのダッシュボードで使用される配置 ID。いいえ
mediationInfo
メディエーションインテグレーションの詳細を指定します。いいえ
extras
設定用の追加のカスタム キーと値のペア。いいえ
注: adMarkup プロパティは、すべての入札実装で必須です。ウォーターフォール実装の場合は、adMarkup を nil に設定できます。

UADSLoadConfigurationBuilder

UADSLoadConfigurationBuilder
を使用して、
UADSLoadConfiguration
クラスのインスタンスを作成し、返します。

init(placementId:)

public init(placementId:文字列)
UADSLoadConfigurationBuilder
の新しいインスタンスを作成します。

パラメーター

説明

placementId
Unity 収益化ダッシュボードで定義された配置 ID。
戻り値:
UADSLoadConfigurationBuilder
のインスタンス

with(adMarkup:)_

public func with(adMarkup:文字列) -> Self
adMarkup を
UADSLoadConfigurationBuilder
に追加します。

パラメーター

説明

adMarkup入札を通じて広告をロードするときに使用される広告マークアップデータ。nil の場合、広告リクエストはウォーターフォールを使用します。
戻り値:更新された
UADSLoadConfigurationBuilder
インスタンス。

with(mediationAdUnitId:)_

public func with(mediationAdUnitId:文字列) -> Self
メディエーション広告単位 ID を
UADSLoadConfigurationBuilder
に追加します。

Property

説明

mediationAdUnitId
メディエーションパートナーのダッシュボードで使用される配置 ID。
戻り値:更新された
UADSLoadConfigurationBuilder
インスタンス。

with(mediationInfo:)_

public func with(mediationInfo:UADSMediationInfo) -> Self
メディエーション情報を
UADSLoadConfigurationBuilder
に追加します。

パラメーター

説明

mediationInfoメディエーションインテグレーションの詳細を指定します(名前、バージョン、アダプタのバージョン)。
戻り値:更新された
UADSLoadConfigurationBuilder
インスタンス。

with(extras:)_

public func with(extras: [文字列:String]) -> Self
余分な設定キーと値のペアを
UADSLoadConfigurationBuilder
に追加します。

パラメーター

説明

extras広告ロード用のカスタムパラメータのディクショナリ。
戻り値:更新された
UADSLoadConfigurationBuilder
インスタンス。

build()

public func build() -> UADSLoadConfiguration
UADSLoadConfiguration
インスタンスをビルドして返します。
戻り値:
UADSLoadConfiguration
のインスタンス

UADSLoadOptions

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSLoadConfigurationBuilder
を使用してください。移行の詳細については、iOS 非推奨 API を参照してください。
UADSLoadOptions
は、広告ロード オプションを指定するための前のクラスです。

UADSMediationInfo

メディエーションインテグレーションの詳細を指定します。
public クラス UADSMediationInfo:NSObject { public init(name:文字列、バージョン:文字列、adapterVersion:文字列)}

Parameters

説明

nameアプリケーションに統合されているメディエーションプラットフォームの名前。
versionアプリケーションに統合されているメディエーションSDKのバージョン。
adapterVersionメディエーション パートナー用の Unity Ads アダプタのバージョン。
戻り値:
UADSMediationInfo
のインスタンス

UADSMediationMetaData

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSMediationInfo
を使用してください。移行の詳細については、iOS 非推奨 API を参照してください。
UADSMediationMetaData
は、メディエーションパートナー情報を渡すための前のクラスです。

プライバシー

Privacy (プライバシー) は、Unity Ads のプライバシー設定とユーザー同意を管理するための API を提供する列挙型とクラスのセットです。これにより、開発者はGDPR、PIPL、その他の規制に準拠するさまざまなプライバシー設定と同意をハンドルできます。
public クラス Privacy:NSObject { public static func set(privacy:PrivacyFlag、値:PrivacyValue) {} public static func set(consent:PrivacyConsent、値:PrivacyConsentValue) {} // 新しいフラグを設定する場合、既存のフラグを書き込むと例外をスローします。 public 静的 func setPrivacy(_ フラグ:文字列、同意:PrivacyConsentValue) throws {} public 静的 func setPrivacy(_ フラグ:文字列、値:PrivacyValue) が{}をスローする}

UADSMetaData

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
UnityAds
で、
setUserConsent()
、
setUserOptOut()
、および
setNonBehavioral()
の型付きプライバシー方式を使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UADSMetaData
は、GDPRやその他のプライバシー関連のフラグを設定するための前のクラスです。

UADSRewardedAd

UADSRewardedAd
クラスは、リワード広告のロードと表示を管理します。

load(_:completion)_

パブリッククラス UADSRewardedAd:NSObject { パブリック静的関数ロード(_ 設定:UADSLoadConfiguration, completion: @escaping (UADSRewardedAd?, UnityAdsError?) -> Void (空)}
指定されたオプションのリワード広告をロードします。

Parameters

説明

configuration広告のロードオプションを含む UADSLoadConfiguration のインスタンス。
completion広告のロードが完了したときに呼び出されるコールバック。成功した場合は UADSRewardedAd インスタンスを返し、ロードに失敗した場合はエラーを返します。

show(_:delegate:)

パブリッククラス UADSRewardedAd:NSObject { public func show(_ configuration:UADSShowConfiguration? = nil, デリゲート:UADSRewardedShowDelegate)}
ロードされたリワード広告を表示します。

パラメーター

説明

configuration広告を表示するための任意設定。
delegateリワード型広告イベントを処理する任意のデリゲート。

onAdExpired

広告の有効期限が切れたときにトリガーされるコールバックバックを登録します。
パブリッククラス UADSRewardedAd:NSObject { public var onAdExpired: ((UnityAd) -> Void)?}

UADSShowConfiguration

UADSShowConfiguration
クラスは、Unity Ads を表示するときにキーと値のペアの形式で渡す追加のパラメータを指定します。
public class UADSShowConfiguration:NSObject { @objc public private(set) var viewController:UIViewController? @objc public private(set) var customRewardString:文字列? @objc public private(set) var extras: [文字列:String]}
任意の追加パラメータを持つ
UADSShowConfiguration
の新しいインスタンスを作成します。

Property

説明

必須

viewController
広告の表示に使用されるビューコントローラー。いいえ
customRewardString
アドインプレッションのカスタム報酬識別子。いいえ
extras
広告を表示するときに含める追加のキーと値のパラメータ。デフォルトは空のディクショナリです。いいえ

UADSShowConfigurationBuilder

UADSShowConfigurationBuilder
を使用して、
UADSShowConfiguration
クラスのインスタンスを作成し、返します。

*init()

public init()
UADSShowConfigurationBuilder の新しいインスタンスを作成します。

with(viewController:)

public func with(viewController:UIViewController) -> Self
広告を表示するビューコントローラーを設定します。

パラメーター

説明

viewController
広告を表示するビュー コントローラー。
戻り値:更新された UADSShowConfigurationBuilder インスタンス

with(customRewardString:)

public func with(customRewardString:文字列) -> Self
アドインプレッションのカスタム報酬識別子を設定します。

パラメーター

説明

customRewardString
アドインプレッションの一意のリワード ID。
戻り値:更新された
UADSShowConfigurationBuilder
インスタンス。

with(extras:)

public func with(extras: [文字列:String]) -> Self
広告を表示するときに余分なキーと値のパラメータを追加します。

パラメーター

説明

extras
広告ディスプレイのカスタムパラメータ。
戻り値:更新された
UADSShowConfigurationBuilder
インスタンス。

build()

public func build() -> UADSShowConfiguration
UADSShowConfiguration
インスタンスをビルドして返します。
戻り値:
UADSShowConfiguration
のインスタンス

UADSShowOptions

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSShowConfigurationBuilder
を使用してください。移行の詳細については、iOS 非推奨 API を参照してください。
UADSShowOptions
は、広告表示オプションを指定する前のクラスです。

UADSTokenConfiguration

public クラス UADSTokenConfiguration:NSObject { @objc public private(set) var adFormat:UADSAdFormat @objc public private(set) var mediationInfo:UADSMediationInfo? @objc public private(set) var mediationAdUnitId:文字列? @objc public private(set) var placementId:文字列? @objc public private(set) var bannerSize:CGSize? @objc public private(set) var extras: [文字列:String] = [:]}
UADSTokenConfiguration
クラスは、入札トークンの取得に必要な必須情報で構成される オブジェクトを作成します。

Property

説明

必須

adFormat
トークンを生成する広告形式のタイプ。はい
mediationInfo
メディエーションインテグレーションの詳細を指定します。いいえ
mediationAdUnitId
メディエーションパートナーのダッシュボードで使用される配置 ID。いいえ
placementId
Unity 収益化ダッシュボードで定義された配置 ID。いいえ
bannerSize
バナー広告のサイズ(トークンがバナー広告を要求した場合)。いいえ
extras
カスタム設定の追加のキーと値のペア。いいえ

UADSTokenConfigurationBuilder

UADSTokenConfigurationBuilder
を使用して、
UADSTokenConfiguration
クラスのインスタンスを作成し、返します。

init(adFormat:)

public init(adFormat:UADSAdFormat)
UADSTokenConfigurationBuilder
の新しいインスタンスを作成します。

パラメーター

説明

adFormat広告のタイプ(インタースティシャル、リワード、バナー)を指定する UADSAdFormat のインスタンス。
戻り値:
UADSTokenConfigurationBuilder
のインスタンス

with(mediationInfo:)

public func with(mediationInfo:UADSMediationInfo) -> Self
メディエーションインテグレーションの詳細を指定します。

パラメーター

説明

mediationInfoメディエーションインテグレーションの詳細を指定します。
戻り値:更新された
UADSTokenConfigurationBuilder
インスタンス。

withMediationAdUnitId:_

public func with(mediationAdUnitId:文字列) -> Self
メディエーション広告単位 ID を
UADSTokenConfiguration
に追加します。

Property

説明

mediationAdUnitId
メディエーションパートナーのダッシュボードで使用される配置 ID。
戻り値:更新された
UADSUADSTokenConfigurationBuilder
インスタンス。

withPlacementId:_

public func with(placementId:文字列) -> Self
Unity 収益化ダッシュボードで定義された配置 ID を指定します。

パラメーター

説明

placementIdUnity 収益化ダッシュボードで定義された配置 ID。
戻り値:更新された
UADSUADSTokenConfigurationBuilder
インスタンス。

withBannerSize:_

public func with(bannerSize:CGSize) → Self
トークンがバナー広告を要求した場合のバナー広告のサイズを指定します。

パラメーター

説明

bannerSizeバナー広告のサイズ(トークンがバナー広告を要求した場合)。
戻り値:更新された
UADSUADSTokenConfigurationBuilder
インスタンス。

with(extras:)

public func with(extras: [文字列:String]) -> Self
カスタム設定の追加のキーと値のペアを指定します。

パラメーター

説明

extrasカスタム設定の追加のキーと値のペア。
戻り値:更新された
UADSTokenConfigurationBuilder
インスタンス。

build()

public func build() -> UADSTokenConfiguration
UADSTokenConfiguration
インスタンスをビルドして返します。
戻り値:
UADSTokenConfiguration
のインスタンス

UnityAds

UnityAds
クラスは、SDK の主要エントリーポイントとして機能する静的クラスです。初期化とトークンの取得を処理し、グローバル SDK プロパティへのアクセスを提供します。

初期化

initialize(_, completion:)

指定した設定で Unity Ads SDK を初期化します。completion ブロックは、初期化が成功または失敗で完了したときに呼び出されます。
public 静的 func initialize(_ 設定:)UADSInitializationConfiguration、完了:@escaping(UnityAdsError?) -> Void

パラメーター

説明

configurationSDK の初期化に必要な設定を含む UADSInitializationConfiguration オブジェクト。
completionSDK の初期化が完了したときに呼び出されるコールバック。初期化に失敗した場合は UnityAdsError を返します。

GetToken

getToken(_, completion:)

指定された
UADSTokenConfiguration
に基づいて入札トークンをフェッチし、完了ブロックに渡します。
public static func getToken(_ configuration:UADSTokenConfiguration、completion: @escaping (文字列?) -> Void

パラメーター

説明

configuration広告形式、メディエーション情報、およびその他のパラメータを指定する
UADSTokenConfiguration
オブジェクト。
completionトークンの取得に成功した場合は完了ブロックが呼び出され、エラーが発生した場合は null が返されます。

静的変数

IsInitialized

Unity Ads SDK が正常に初期化されたかどうかを決定するブーリアンプロパティ。
@objc public static func isInitialized() -> Bool
戻り値:
true
の場合、Unity Ads は正常に初期化されています。

getVersion

現在使用中の Unity Ads SDK バージョンを決定する文字列プロパティ。
public static func getVersion() -> String
戻り値:現在インストールされている Unity Ads SDK のバージョン。

userIdentifier

アプリケーションの各ユーザーに一意のIDを設定します。
public static var userIdentifier:String

プライバシー

setUserConsent()

パーソナライズ広告に対するユーザーのオプトインの選択肢を表示します。
public static func setUserConsent(_ consentGranted:ブーリアン)

setUserOptOut()

ユーザーにデータ収集とパーソナライズ広告をオプトアウトするオプションを提供します。
public static func setUserOptOut(_ optOut:ブーリアン)

setNonBehavioral()

コンテキスト依存連動型(パーソナライズされていない)広告のディスプレイを有効にします。
public 静的 関数 setNonBehavioral(_ nonBehavioral:ブーリアン)

UnityAdsInitializationDelegate

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UnityAds.initialize(_:completion:)
で補完ブロックを使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UnityAdsInitializationDelegate
は、SDK 初期化コールバックの以前のデリゲートプロトコルです。

UnityAdsLoadDelegate

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに、
UADSInterstitialAd.load(_:completion:)
または
UADSRewardedAd.load(_:completion:)
で補完ブロックを使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UnityAdsLoadDelegate
は、広告ロードコールバックの以前のデリゲートプロトコルです。

UnityAdsShowDelegate

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSInterstitialShowDelegate
または
UADSRewardedShowDelegate
を使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UnityAdsShowDelegate
は、広告表示コールバックの以前のデリゲートプロトコルです。

列挙型

UADSAdFormat

Unity Ads でサポートされているさまざまなタイプの広告フォーマットを定義します。
public enum UADSAdFormat:Int { case unspecified = 0、interstitial、rewarded、バナー}

パラメーター

説明

unspecified指定された広告形式はありません。
interstitialアプリケーションで自然なポーズで表示される全画面の広告。
rewarded完了後にユーザーに報酬を付与する広告。
bannerアプリケーションのレイアウト内に表示される矩形広告。通常は画面の上下に固定されます。

UnityAdsAdFormat

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UADSAdFormat
を使用してください。移行の詳細については、iOS 非推奨 API を参照してください。
UnityAdsAdFormat
は、広告形式タイプの以前の enum です。

UADSLogLevel

Unity Ads のロギング レベルを定義します。
public enum UADSLogLevel:Int { case disabled、error、info、デバッグ}

パラメーター

説明

disabledログ出力なし。
errorinit/ロード/show 操作の重大なエラーと失敗のみをログに記録します。
infoキー操作イベント(初期化の開始/完了、ロードの開始/完了、開始/終了の表示、トークンの生成など)をログに記録します。
debugすべての情報に加えて、ネットワーク リクエストや内部エラーなどの詳細な内部操作をログに記録します。

UADSShowFinishState

表示後の広告の終了状態を表します。
public enum UADSShowFinishState:Int { case skipped = 0, completed}

パラメーター

説明

skippedユーザーが広告を終了する前に広告をクローズまたはスキップしました。
completed最後まで再生された広告。

プロトコル

UADSBannerAdDelegate

public プロトコル UADSBannerAdDelegate:NSObjectProtocol { func bannerImpression(_ banner:UADSBannerAd) func bannerDidClick(_ banner:UADSBannerAd) func bannerDidFailShow(_ banner:UADSBannerAd、エラー:UnityAdsError)}

メソッド

説明

bannerImpression(_:)
バナー広告が正常に表示された(インプレッションが記録された)ときに呼び出されます。
bannerDidClick(_:)
ユーザーがバナー広告をクリックしたときに呼び出されます。
bannerDidFailShow(_:error:)
バナーの表示に失敗した場合に呼び出され、失敗を説明する
UnityAdsError
が表示されます。

UADSInterstitialShowDelegate

public protocol UADSInterstitialShowDelegate:NSObjectProtocol { func showDidStart(_ unityAd:UADSInterstitialAd) func showDidClick(_ unityAd:UADSInterstitialAd) func showDidComplete(_ unityAd:UADSInterstitialAd、状態:UADSShowFinishState) func showDidFailed(_ unityAd:UADSInterstitialAd、エラー:UnityAdsError)}

メソッド

説明

showDidStart(_:)
インタースティシャル広告の表示が開始されたときに呼び出されます。
showDidClick(_:)
インタースティシャル広告がクリックされたときに呼び出されます。
showDidComplete(_:with:)
広告の表示が終了したときに呼び出されます。
UADSShowFinishState
(
skipped
または
completed
)を提供します。
showDidFailed(_:error:)
広告の表示に失敗した場合に呼び出され、失敗を説明する
UnityAdsError
が表示されます。

UADSRewardedShowDelegate

public protocol UADSRewardedShowDelegate:NSObjectProtocol { func showDidStart(_ unityAd:UADSRewardedAd) func showDidClick(_ unityAd:UADSRewardedAd) func showDidComplete(_ unityAd:UADSRewardedAd、状態:UADSShowFinishState) func showDidFailed(_ unityAd:UADSRewardedAd、エラー:UnityAdsError) func showDidReceiveReward(_ unityAd:UADSRewardedAd)}

メソッド

説明

showDidStart(_:)
リワード広告の表示が開始されたときに呼び出されます。
showDidClick(_:)
リワード広告がクリックされたときに呼び出されます。
showDidComplete(_:with:)
広告の表示が終了したときに呼び出されます。
UADSShowFinishState
(
skipped
または
completed
)を提供します。
showDidFailed(_:error:)
広告の表示に失敗した場合に呼び出され、失敗を説明する
UnityAdsError
が表示されます。
showDidReceiveReward(_:)
ユーザーが広告から報酬を獲得したときに呼び出されます。

UnityAdsError

public protocol UnityAdsError { var コード:Int { get } } var message:文字列 { get }}

パラメーター

説明

codeUnity Ads エラーのタイプを識別する数値のエラーコード。
messageエラーの詳細を提供するエラー メッセージ。

UADSBannerErrorCode

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UnityAdsError
プロトコルを使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UADSBannerErrorCode
はバナー固有のエラーコードを表す以前の enum です。

UnityAdsInitializationError

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UnityAdsError
プロトコルを使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UnityAdsInitializationError
は、初期化エラー タイプの以前の enum です。

UnityAdsLoadError

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UnityAdsError
プロトコルを使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UnityAdsLoadError
は、広告ロードエラータイプの以前の enum です。

UnityAdsShowError

注意
バージョン 4.19.0 で非推奨になりました。バージョン 5.0.0 で削除予定
代わりに
UnityAdsError
プロトコルを使用します。移行の詳細については、iOS 非推奨 API を参照してください。
UnityAdsShowError
は、広告表示エラータイプの以前の enum です。

Copyright © 2026 Unity Technologies
法規事項プライバシーポリシークッキーDocumentation Terms of Use私の個人情報を販売または共有しないプライバシーに関する選択 (クッキー設定)

"Unity" の名称、Unity のロゴ、およびその他の Unity の商標は、米国およびその他の国における Unity Technologies またはその関係会社の商標または登録商標です (詳しくはこちら)。その他の名称またはブランドは該当する所有者の商標です。

一部のページは利便性向上のため機械翻訳を使用しており、内容に不正確な表現が含まれる場合があります。内容に齟齬または不一致が生じた場合は、英語版を正本とします。

  • このページ
    • クラス

      • UADSBannerAd

      • load(_:completion)

      • onAdExpired

      • ビュー

      • UADSBannerView

      • UADSBannerViewDelegate

    • UADSBannerLoadConfiguration

    • UADSBannerLoadConfigurationBuilder

      • init(placementId, bannerSize, delegate)

      • with(adMarkup:)_

      • with(mediationAdUnitId:)_

      • with(mediationInfo:)_

      • with(extras:)_

      • build()_

      • UADSBannerLoadOptions

    • UADSInitializationConfiguration

    • UADSInitializationConfigurationBuilder

      • Initialize

      • init(gameId:)_

      • with(testMode:)_

      • with(logLevel:)_

      • with(mediationInfo:)_

      • with(extras:)_

      • build()

    • UADSInterstitialAd

      • load(_:completion)

      • show(_:delegate:)

      • onAdExpired

    • UADSLoadConfiguration

    • UADSLoadConfigurationBuilder

      • init(placementId:)

      • with(adMarkup:)_

      • with(mediationAdUnitId:)_

      • with(mediationInfo:)_

      • with(extras:)_

      • build()

      • UADSLoadOptions

    • UADSMediationInfo

      • UADSMediationMetaData

    • プライバシー

      • UADSMetaData

    • UADSRewardedAd

      • load(_:completion)_

      • show(_:delegate:)

      • onAdExpired

    • UADSShowConfiguration

    • UADSShowConfigurationBuilder

      • *init()

      • with(viewController:)

      • with(customRewardString:)

      • with(extras:)

      • build()

      • UADSShowOptions

    • UADSTokenConfiguration

    • UADSTokenConfigurationBuilder

      • init(adFormat:)

        • with(mediationInfo:)

      • withMediationAdUnitId:_

      • withPlacementId:_

      • withBannerSize:_

        • with(extras:)

      • build()

    • UnityAds

      • 初期化

        • initialize(_, completion:)

      • GetToken

        • getToken(_, completion:)

      • 静的変数

        • IsInitialized

        • getVersion

        • userIdentifier

      • プライバシー

        • setUserConsent()

        • setUserOptOut()

        • setNonBehavioral()

      • UnityAdsInitializationDelegate

      • UnityAdsLoadDelegate

      • UnityAdsShowDelegate

    • 列挙型

      • UADSAdFormat

      • UnityAdsAdFormat

      • UADSLogLevel

      • UADSShowFinishState

    • プロトコル

      • UADSBannerAdDelegate

      • UADSInterstitialShowDelegate

      • UADSRewardedShowDelegate

    • UnityAdsError

      • UADSBannerErrorCode

      • UnityAdsInitializationError

      • UnityAdsLoadError

      • UnityAdsShowError


このページの問題を報告する