リファレンス - Ad Control Help Center

クラス

Adrop

SDKのメインクラスです。SDKの初期化とグローバル設定を管理します。

静的メソッド

メソッド	戻り値の型	説明
`initialize(production:useInAppBrowser:targetCountries:)`	`void`	SDKの初期化
`setUID(_:)`	`void`	ユーザー識別子の設定
`setTheme(_:)`	`void`	アプリテーマの設定
`setMarketingConsent(_:)`	`void`	プッシュ通知広告のターゲティングのため、ユーザーのマーケティング同意状態を設定します。`initialize()`の後に呼び出す必要があります。
`handleDeepLink(url:)`	`Bool`	ディープリンクの処理
`openQuest(channel:path:)`	`@discardableResult Bool`	Quest画面を開く
`registerWebView(_:)`	`void`	バックフィル広告用のWKWebViewを登録

静的プロパティ

プロパティ	型	説明
`sdkVersion`	`String`	SDKバージョン (読み取り専用)
`consentManager`	`AdropConsentManager?`	Consent Manager (AdropAdsBackfillインストール時に自動設定、読み書き)

初期化メソッド

static func initialize(
    production: Bool = false,
    useInAppBrowser: Bool = false,
    targetCountries: [String]? = nil
)

Bool

デフォルト:"false"

プロダクションモード。デプロイ時にtrueに設定

Bool

デフォルト:"false"

インアプリブラウザの使用有無。trueの場合、広告クリック時にアプリ内で開く

[String]?

デフォルト:"nil"

ターゲット国コード配列 (例: [“KR”, “US”])。nilの場合すべての国

使用例:

// AppDelegate.swift
func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
    Adrop.initialize(production: false)
    return true
}

ユーザー識別子の設定

static func setUID(_ uid: String)

String

必須

ユーザーを識別するための一意のID (最大100文字)

使用例:

Adrop.setUID("user_12345")

テーマ設定

static func setTheme(_ theme: AdropTheme)

AdropTheme

必須

アプリテーマ (light, dark, auto)

使用例:

Adrop.setTheme(.dark)

AdropBanner

バナー広告を表示するクラスです。UIViewを継承します。

初期化

init(unitId: String, contextId: String = "")

String

必須

Ad Controlコンソールで作成したバナー広告ユニットID

String

コンテキストターゲティングID（デフォルト：空文字列）

メソッド

メソッド	戻り値の型	説明
`load()`	`void`	広告リクエストと読み込み
`open(_:useInAppBrowser:)`	`void`	URLを開く（デフォルトは`destinationURL`）
`play()`	`void`	ビデオバナーの再生を開始または再開
`pause()`	`void`	ビデオバナーの再生を一時停止
`destroy()`	`void`	バナーリソースを解放（idempotent、呼び出し後は再利用不可） — ライフサイクル管理参照

静的メソッド

メソッド	戻り値の型	説明
`loads(unitId:contextId:delegate:)`	`void`	最大5個のバナー広告を一括ロード — 一括ロード参照
`preload(unitId:contextId:adSize:delegate:)`	`void`	バックフィルバナー広告をプリロード（1.17.0+） — バックフィル広告のプリロード参照

静的プロパティ

プロパティ	型	説明
`maxLoadsBatch`	`Int`	`loads(...)`が返す広告の最大数（値：`5`）

プロパティ

プロパティ	型	説明
`unitId`	`String`	ユニットID (読み取り専用)
`contextId`	`String`	コンテキストターゲティングID (読み取り専用、initで設定)
`creativeSize`	`CGSize`	広告クリエイティブサイズ (読み取り専用、デフォルトはzero)
`destinationURL`	`String?`	広告遷移先URL (読み取り専用)
`txId`	`String`	トランザクションID (読み取り専用)
`campaignId`	`String`	キャンペーンID (読み取り専用)
`creativeId`	`String`	クリエイティブID (読み取り専用)
`creativeType`	`String`	ロードされたクリエイティブタイプ（`"display"`または`"video"`）。広告レスポンスを受信するまでは`"display"`を返します。 (読み取り専用)
`isBackfilled`	`Bool`	バックフィル広告かどうか (読み取り専用)
`useCustomClick`	`Bool`	カスタムクリック処理を使用するかどうか (読み書き)
`browserTarget`	`BrowserTarget?`	広告クリック時のURL表示方法 (読み取り専用)
`delegate`	`AdropBannerDelegate?`	デリゲート (読み書き)
`onAdReceived`	`((AdropBanner) -> Void)?`	広告受信時のクロージャ
`onAdFailedToReceive`	`((AdropBanner, AdropErrorCode) -> Void)?`	広告受信失敗時のクロージャ
`onAdImpression`	`((AdropBanner) -> Void)?`	広告インプレッション時のクロージャ
`onAdClicked`	`((AdropBanner) -> Void)?`	広告クリック時のクロージャ
`onAdVideoStart`	`((AdropBanner) -> Void)?`	動画再生開始時のクロージャ
`onAdVideoEnd`	`((AdropBanner) -> Void)?`	動画再生終了時のクロージャ

使用例:

let banner = AdropBanner(unitId: "YOUR_UNIT_ID", contextId: "sport")
banner.delegate = self
banner.load()

AdropNativeAd

ネイティブ広告データを管理するクラスです。

初期化

init(unitId: String, contextId: String = "")

String

必須

Ad Controlコンソールで作成したネイティブ広告ユニットID

String

コンテキストターゲティングID（デフォルト：空文字列）

メソッド

メソッド	戻り値の型	説明
`load()`	`void`	広告リクエストと読み込み
`open(_:useInAppBrowser:)`	`void`	URLを開く（デフォルトは`destinationURL`）

静的メソッド

メソッド	戻り値の型	説明
`loads(unitId:contextId:delegate:)`	`void`	最大5個のネイティブ広告を一括ロード — 一括ロード参照
`preload(unitId:contextId:preferredAdChoicesPosition:delegate:)`	`void`	バックフィルネイティブ広告をプリロード（1.17.0+） — バックフィル広告のプリロード参照

静的プロパティ

プロパティ	型	説明
`maxLoadsBatch`	`Int`	`loads(...)`が返す広告の最大数（値：`5`）

プロパティ

プロパティ	型	説明
`unitId`	`String`	ユニットID (読み取り専用)
`contextId`	`String`	コンテキストターゲティングID (読み取り専用、initで設定)
`txId`	`String`	トランザクションID (読み取り専用)
`campaignId`	`String`	キャンペーンID (読み取り専用)
`creativeId`	`String`	クリエイティブID (読み取り専用)
`creativeType`	`String`	ロードされたクリエイティブタイプ（`"display"`または`"video"`）。広告レスポンスを受信するまでは`"display"`を返します。 (読み取り専用)
`isLoaded`	`Bool`	広告が読み込まれたかどうか (読み取り専用)
`isBackfilled`	`Bool`	バックフィル広告かどうか (読み取り専用)
`headline`	`String`	広告タイトル (読み取り専用)
`body`	`String`	広告本文 (読み取り専用)
`callToAction`	`String`	CTAボタンテキスト (読み取り専用)
`icon`	`String`	広告アイコンURL (読み取り専用)
`cover`	`String`	広告カバー画像URL (読み取り専用)
`asset`	`String`	メイン画像URL (読み取り専用)
`creative`	`String`	HTMLクリエイティブコンテンツ (読み取り専用)
`advertiser`	`String`	広告主名 (読み取り専用)
`advertiserURL`	`String`	広告主URL (読み取り専用)
`profile`	`AdropNativeAdProfile`	広告主プロフィール (読み取り専用)
`extra`	`[String: String]`	追加テキストフィールド (読み取り専用)
`extraAssets`	`[String: AdropNativeAsset]`	メディアIDをキーとする、複数メディアのクリエイティブのメディア。メディアが1つのクリエイティブとバックフィル広告では空 (読み取り専用、1.16.0+)
`accountTag`	`[String: Any]`	アカウントタグデータ (読み取り専用)
`creativeTag`	`[String: Any]`	クリエイティブタグデータ (読み取り専用)
`creativeSize`	`CGSize`	広告クリエイティブサイズ (読み取り専用、デフォルトはzero)
`destinationURL`	`String?`	広告遷移先URL (読み取り専用)
`useCustomClick`	`Bool`	カスタムクリック処理を使用するかどうか (読み書き)
`preferredAdChoicesPosition`	`AdropAdChoicesPosition`	バックフィルネイティブ広告のAdChoicesマーク表示位置 (読み書き、デフォルト: `.topRight`)
`browserTarget`	`BrowserTarget?`	広告クリック時のURL表示方法 (読み取り専用)
`delegate`	`AdropNativeAdDelegate?`	デリゲート (読み書き)
`onAdReceived`	`((AdropNativeAd) -> Void)?`	広告受信時のクロージャ
`onAdFailedToReceive`	`((AdropNativeAd, AdropErrorCode) -> Void)?`	広告受信失敗時のクロージャ
`onAdImpression`	`((AdropNativeAd) -> Void)?`	広告インプレッション時のクロージャ
`onAdClicked`	`((AdropNativeAd) -> Void)?`	広告クリック時のクロージャ
`onAdVideoStart`	`((AdropNativeAd) -> Void)?`	動画再生開始時のクロージャ
`onAdVideoEnd`	`((AdropNativeAd) -> Void)?`	動画再生終了時のクロージャ

使用例:

let nativeAd = AdropNativeAd(unitId: "YOUR_UNIT_ID")
nativeAd.delegate = self
nativeAd.load()

// 広告読み込み後
titleLabel.text = nativeAd.headline
bodyLabel.text = nativeAd.body
ctaButton.setTitle(nativeAd.callToAction, for: .normal)

AdropInterstitialAd

インタースティシャル広告を表示するクラスです。

初期化

init(unitId: String)

String

必須

Ad Controlコンソールで作成したインタースティシャル広告ユニットID

メソッド

メソッド	戻り値の型	説明
`load()`	`void`	広告の事前読み込み
`show(fromRootViewController:)`	`void`	広告の表示

showメソッド

func show(fromRootViewController viewController: UIViewController)

UIViewController

必須

広告を表示する画面のビューコントローラー

プロパティ

プロパティ	型	説明
`delegate`	`AdropInterstitialAdDelegate?`	デリゲート (読み書き)
`isLoaded`	`Bool`	広告が読み込まれたかどうか (読み取り専用)
`unitId`	`String`	ユニットID (読み取り専用)
`txId`	`String`	トランザクションID (読み取り専用)
`campaignId`	`String`	キャンペーンID (読み取り専用)
`creativeId`	`String`	クリエイティブID (読み取り専用)
`isBackfilled`	`Bool`	バックフィル広告かどうか (読み取り専用)
`destinationURL`	`String`	広告遷移先URL (読み取り専用)
`browserTarget`	`BrowserTarget?`	広告クリック時のURL表示方法 (読み取り専用)
`onAdReceived`	`((AdropInterstitialAd) -> Void)?`	広告受信時のクロージャ
`onAdFailedToReceive`	`((AdropInterstitialAd, AdropErrorCode) -> Void)?`	広告受信失敗時のクロージャ
`onAdImpression`	`((AdropInterstitialAd) -> Void)?`	広告インプレッション時のクロージャ
`onAdClicked`	`((AdropInterstitialAd) -> Void)?`	広告クリック時のクロージャ
`onAdWillPresentFullScreen`	`((AdropInterstitialAd) -> Void)?`	広告表示前のクロージャ
`onAdDidPresentFullScreen`	`((AdropInterstitialAd) -> Void)?`	広告表示後のクロージャ
`onAdWillDismissFullScreen`	`((AdropInterstitialAd) -> Void)?`	広告を閉じる前のクロージャ
`onAdDidDismissFullScreen`	`((AdropInterstitialAd) -> Void)?`	広告を閉じた後のクロージャ
`onAdFailedToShowFullScreen`	`((AdropInterstitialAd, AdropErrorCode) -> Void)?`	広告表示失敗時のクロージャ

使用例:

let interstitial = AdropInterstitialAd(unitId: "YOUR_UNIT_ID")
interstitial.delegate = self
interstitial.load()

// 広告読み込み後
if interstitial.isLoaded {
    interstitial.show(fromRootViewController: self)
}

AdropRewardedAd

リワード広告を表示するクラスです。

初期化

init(unitId: String)

String

必須

Ad Controlコンソールで作成したリワード広告ユニットID

メソッド

メソッド	戻り値の型	説明
`load()`	`void`	広告の事前読み込み
`show(fromRootViewController:userDidEarnRewardHandler:)`	`void`	広告の表示とリワードハンドラーの設定

showメソッド

func show(
    fromRootViewController viewController: UIViewController,
    userDidEarnRewardHandler: @escaping (_ type: Int, _ amount: Int) -> Void
)

UIViewController

必須

広告を表示する画面のビューコントローラー

(_ type: Int, _ amount: Int) -> Void

必須

ユーザーがリワードを獲得したときに呼び出されるクロージャ。typeはリワードの種類、amountはAd Controlコンソールで設定したリワード数量です。

プロパティ

プロパティ	型	説明
`delegate`	`AdropRewardedAdDelegate?`	デリゲート (読み書き)
`isLoaded`	`Bool`	広告が読み込まれたかどうか (読み取り専用)
`unitId`	`String`	ユニットID (読み取り専用)
`txId`	`String`	トランザクションID (読み取り専用)
`campaignId`	`String`	キャンペーンID (読み取り専用)
`creativeId`	`String`	クリエイティブID (読み取り専用)
`isBackfilled`	`Bool`	バックフィル広告かどうか (読み取り専用)
`destinationURL`	`String`	広告遷移先URL (読み取り専用)
`browserTarget`	`BrowserTarget?`	広告クリック時のURL表示方法 (読み取り専用)
`serverSideVerificationOptions`	`AdropServerSideVerificationOptions?`	サーバーサイド検証オプション (読み書き)
`onAdReceived`	`((AdropRewardedAd) -> Void)?`	広告受信時のクロージャ
`onAdFailedToReceive`	`((AdropRewardedAd, AdropErrorCode) -> Void)?`	広告受信失敗時のクロージャ
`onAdImpression`	`((AdropRewardedAd) -> Void)?`	広告インプレッション時のクロージャ
`onAdClicked`	`((AdropRewardedAd) -> Void)?`	広告クリック時のクロージャ
`onAdWillPresentFullScreen`	`((AdropRewardedAd) -> Void)?`	広告表示前のクロージャ
`onAdDidPresentFullScreen`	`((AdropRewardedAd) -> Void)?`	広告表示後のクロージャ
`onAdWillDismissFullScreen`	`((AdropRewardedAd) -> Void)?`	広告を閉じる前のクロージャ
`onAdDidDismissFullScreen`	`((AdropRewardedAd) -> Void)?`	広告を閉じた後のクロージャ
`onAdFailedToShowFullScreen`	`((AdropRewardedAd, AdropErrorCode) -> Void)?`	広告表示失敗時のクロージャ

使用例:

let rewardedAd = AdropRewardedAd(unitId: "YOUR_UNIT_ID")
rewardedAd.delegate = self
rewardedAd.load()

// 広告読み込み後
if rewardedAd.isLoaded {
    rewardedAd.show(fromRootViewController: self) { type, amount in
        print("ユーザーがリワードを獲得しました！ type: \(type), amount: \(amount)")
        // リワード付与ロジック
    }
}

AdropPopupAd

ポップアップ広告を表示するクラスです。

初期化

init(unitId: String)

String

必須

Ad Controlコンソールで作成したポップアップ広告ユニットID

メソッド

メソッド	戻り値の型	説明
`load()`	`void`	広告の事前読み込み
`show(fromRootViewController:)`	`void`	広告の表示
`close()`	`void`	広告を閉じる
`open(_:useInAppBrowser:)`	`void`	URLを開く（デフォルトは`destinationURL`）

showメソッド

func show(fromRootViewController viewController: UIViewController)

UIViewController

必須

広告を表示する画面のビューコントローラー

プロパティ

プロパティ	型	説明
`delegate`	`AdropPopupAdDelegate?`	広告イベントデリゲート (読み書き)
`closeDelegate`	`AdropPopupAdCloseDelegate?`	閉じるイベントデリゲート (読み書き)
`isLoaded`	`Bool`	広告が読み込まれたかどうか (読み取り専用)
`unitId`	`String`	ユニットID (読み取り専用)
`txId`	`String`	現在のトランザクションID (読み取り専用)
`txIds`	`[String]`	すべてのトランザクションID (読み取り専用)
`campaignId`	`String`	現在のキャンペーンID (読み取り専用)
`campaignIds`	`[String]`	すべてのキャンペーンID (読み取り専用)
`creativeId`	`String?`	現在のクリエイティブID (読み取り専用)
`creativeIds`	`[String]`	すべてのクリエイティブID (読み取り専用)
`creativeType`	`String`	ロードされたクリエイティブタイプ（`"display"`または`"video"`）。広告レスポンスを受信するまでは`"display"`を返します。 (読み取り専用)
`destinationURL`	`String?`	広告遷移先URL (読み取り専用)
`useCustomClick`	`Bool`	カスタムクリック処理を使用するかどうか (読み書き)
`browserTarget`	`BrowserTarget?`	広告クリック時のURL表示方法 (読み取り専用)
`backgroundColor`	`UIColor?`	ポップアップ背景色 (読み書き)
`hideForTodayTextColor`	`UIColor?`	「今日は表示しない」テキスト色 (読み書き)
`closeTextColor`	`UIColor?`	閉じるボタンテキスト色 (読み書き)
`ctaTextColor`	`UIColor?`	CTAテキスト色 (読み書き)
`onAdReceived`	`((AdropPopupAd) -> Void)?`	広告受信時のクロージャ
`onAdFailedToReceive`	`((AdropPopupAd, AdropErrorCode) -> Void)?`	広告受信失敗時のクロージャ
`onAdImpression`	`((AdropPopupAd) -> Void)?`	広告インプレッション時のクロージャ
`onAdClicked`	`((AdropPopupAd) -> Void)?`	広告クリック時のクロージャ
`onAdWillPresentFullScreen`	`((AdropPopupAd) -> Void)?`	広告表示前のクロージャ
`onAdDidPresentFullScreen`	`((AdropPopupAd) -> Void)?`	広告表示後のクロージャ
`onAdWillDismissFullScreen`	`((AdropPopupAd) -> Void)?`	広告を閉じる前のクロージャ
`onAdDidDismissFullScreen`	`((AdropPopupAd) -> Void)?`	広告を閉じた後のクロージャ
`onAdFailedToShowFullScreen`	`((AdropPopupAd, AdropErrorCode) -> Void)?`	広告表示失敗時のクロージャ
`onAdVideoStart`	`((AdropPopupAd) -> Void)?`	動画再生開始時のクロージャ
`onAdVideoEnd`	`((AdropPopupAd) -> Void)?`	動画再生終了時のクロージャ
`onClosed`	`((AdropPopupAd) -> Void)?`	閉じるボタンのクロージャ
`onDimClicked`	`((AdropPopupAd) -> Void)?`	背景エリアクリック時のクロージャ
`onTodayOffClicked`	`((AdropPopupAd) -> Void)?`	「今日は表示しない」のクロージャ

使用例:

let popupAd = AdropPopupAd(unitId: "YOUR_UNIT_ID")
popupAd.delegate = self
popupAd.closeDelegate = self
popupAd.load()

// 広告読み込み後
if popupAd.isLoaded {
    popupAd.show(fromRootViewController: self)
}

AdropSplashAd

スプラッシュ広告を管理するクラスです。

AdropSplashAdは直接インスタンス化できません（イニシャライザはinternal）。スプラッシュ広告を表示するにはAdropSplashAdViewControllerまたはAdropSplashAdViewを使用してください。

プロパティ

プロパティ	型	説明
`delegate`	`AdropSplashAdDelegate?`	デリゲート (読み書き)
`unitId`	`String`	ユニットID (読み取り専用)
`txId`	`String`	トランザクションID (読み取り専用)
`campaignId`	`String`	キャンペーンID (読み取り専用)
`creativeId`	`String`	クリエイティブID (読み取り専用)
`destinationURL`	`String`	広告遷移先URL (読み取り専用)
`readyToShow`	`Bool`	広告表示の準備ができているかどうか (読み取り専用)
`adImage`	`UIImage?`	キャッシュされた広告画像 (読み取り専用)

AdropSplashAdViewController

スプラッシュ広告をフルスクリーンで表示するビューコントローラーです。

初期化

init(unitId: String, adRequestTimeout: TimeInterval = 1)

String

必須

Ad Controlコンソールで作成したスプラッシュ広告ユニットID

TimeInterval

デフォルト:"1"

広告リクエストタイムアウト（秒）

メソッド

メソッド	戻り値の型	説明
`close()`	`void`	スプラッシュ広告を閉じて`mainViewController`に遷移

プロパティ

プロパティ	型	説明
`delegate`	`AdropSplashAdDelegate?`	デリゲート (読み書き)
`splashAd`	`AdropSplashAd`	基盤となるスプラッシュ広告オブジェクト (読み取り専用)
`displayDuration`	`TimeInterval`	広告表示時間 (デフォルト: 1秒、deprecated — コンソールで設定)
`logoImage`	`UIImage?`	下部に表示するロゴ画像 (読み書き)
`backgroundColor`	`UIColor?`	背景色 (読み書き)
`mainViewController`	`UIViewController?`	スプラッシュ広告終了後に遷移するメインビューコントローラー (読み書き)

使用例:

let splashVC = AdropSplashAdViewController(unitId: "YOUR_UNIT_ID")
splashVC.delegate = self
splashVC.displayDuration = 3.0  // 3秒間表示
splashVC.logoImage = UIImage(named: "app_logo")  // ロゴ画像の設定
splashVC.modalPresentationStyle = .fullScreen
present(splashVC, animated: false)

AdropSplashAdView

スプラッシュ広告を表示するビューです。UIImageViewを継承します。

初期化

init(unitId: String, adRequestTimeout: TimeInterval = 1)

String

必須

Ad Controlコンソールで作成したスプラッシュ広告ユニットID

TimeInterval

デフォルト:"1"

広告リクエストタイムアウト（秒）

広告の読み込みは初期化時に自動的に行われます。load()を直接呼び出さないでください。

プロパティ

プロパティ	型	説明
`delegate`	`AdropSplashAdViewDelegate?`	デリゲート (読み書き)
`ad`	`AdropSplashAd`	基盤となるスプラッシュ広告オブジェクト (読み取り専用)
`unitId`	`String`	ユニットID (読み取り専用)
`txId`	`String?`	トランザクションID (読み取り専用)
`creativeId`	`String`	クリエイティブID (読み取り専用)
`isClosed`	`Bool`	スプラッシュ広告が閉じたかどうか (読み取り専用)
`displayDuration`	`TimeInterval`	広告表示時間 (deprecated — コンソールで設定)

AdropMetrics

ユーザープロパティとイベントを管理するクラスです。

静的プロパティ

プロパティ	型	説明
`userDataConsent`	`Bool`	ユーザーデータ同意状態 (デフォルト: `true`、読み取り専用)

静的メソッド

メソッド	戻り値の型	説明
`setUserDataConsent(_:)`	`void`	ユーザーデータ収集の同意状態を設定 (`true` = 同意、`false` = 非同意)。`false`の場合、データはローカルに保存されるがサーバーには送信されない。
`setProperty(key:value:)`	`void`	ユーザープロパティを設定
`properties()`	`[String: Encodable]`	保存されたユーザープロパティを全件取得
`sendEvent(name:params:)`	`void`	ユーザーイベントを送信
`logEvent(name:params:)`	`void`	非推奨。 `sendEvent`を使用してください。

ユーザープロパティの設定

static func setProperty(key: String, value: Encodable?)

String

必須

プロパティキー (最大64文字)

Any

必須

プロパティ値 (String, Int, Double, Bool対応)

使用例:

AdropMetrics.setProperty(key: "age", value: 25)
AdropMetrics.setProperty(key: "gender", value: "male")
AdropMetrics.setProperty(key: "isPremium", value: true)

ユーザープロパティの取得

static func properties() -> [String: Encodable]

setProperty(key:value:)で保存したユーザープロパティ全件を返します。 使用例:

let stored = AdropMetrics.properties()
print(stored)

イベント送信

static func sendEvent(name: String, params: [String: Any]? = nil)

String

必須

イベント名 (1–64文字)

[String: Any]?

イベントパラメータディクショナリ。キーは最大64文字、文字列値は最大1024文字です。

使用例:

// シンプルなイベント
AdropMetrics.sendEvent(name: "app_open")

// パラメータ付きイベント
AdropMetrics.sendEvent(name: "view_item", params: [
    "item_id": "SKU-123",
    "item_name": "Widget",
    "price": 29.99
])

// 複数アイテムイベント（購入）
AdropMetrics.sendEvent(name: "purchase", params: [
    "tx_id": "tx_123",
    "currency": "KRW",
    "items": [
        ["item_id": "A", "item_name": "Product A", "price": 100, "quantity": 1],
        ["item_id": "B", "item_name": "Product B", "price": 200, "quantity": 2]
    ]
])

logEvent()は非推奨であり、将来のバージョンで削除されます。sendEvent()を使用してください。

イベント名は1–64文字である必要があります。
同じ名前とパラメータを持つ重複イベントは500ms以内の送信が制限されます。
sendEvent()を呼び出す前にSDKが初期化されている必要があります。

イベントロギング (非推奨)

@available(*, deprecated, renamed: "sendEvent(name:params:)")
static func logEvent(name: String, params: [String: Encodable]? = [:])

このメソッドは非推奨です。sendEvent(name:params:)を使用してください。

プロトコル (Delegates)

AdropBannerDelegate

バナー広告のライフサイクルイベントを処理するプロトコルです。

必須メソッド

func onAdReceived(_ banner: AdropBanner)

広告受信成功時に呼び出されます。

func onAdFailedToReceive(_ banner: AdropBanner, _ errorCode: AdropErrorCode)

広告受信失敗時に呼び出されます。

オプションメソッド

optional func onAdImpression(_ banner: AdropBanner)

広告が画面に表示されたときに呼び出されます。

optional func onAdClicked(_ banner: AdropBanner)

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

optional func onAdsReceived(_ banners: [AdropBanner])

AdropBanner.loads(...)でリクエストしたバナーバッチが配信されたときに呼び出されます。

optional func onAdsFailedToReceive(_ errorCode: AdropErrorCode)

AdropBanner.loads(...)のバッチロードが失敗したときに呼び出されます。

optional func onAdVideoStart(_ banner: AdropBanner)

ビデオ広告の再生が開始されたときに呼び出されます。

optional func onAdVideoEnd(_ banner: AdropBanner)

ビデオ広告の再生が終了したときに呼び出されます。

optional func onAdPreloadReceived(_ unitId: String, _ contextId: String)

AdropBanner.preload(...)のプリロードが完了したときに呼び出されます（1.17.0+）。

optional func onAdPreloadFailedToReceive(_ unitId: String, _ contextId: String, _ errorCode: AdropErrorCode)

AdropBanner.preload(...)が広告をプリロードできなかったときに呼び出されます（1.17.0+）。 実装例:

extension ViewController: AdropBannerDelegate {
    func onAdReceived(_ banner: AdropBanner) {
        print("バナー広告受信")
    }

    func onAdFailedToReceive(_ banner: AdropBanner, _ errorCode: AdropErrorCode) {
        print("バナー広告失敗: \(errorCode)")
    }

    func onAdImpression(_ banner: AdropBanner) {
        print("バナー広告インプレッション")
    }

    func onAdClicked(_ banner: AdropBanner) {
        print("バナー広告クリック")
    }
}

AdropNativeAdDelegate

ネイティブ広告のライフサイクルイベントを処理するプロトコルです。

必須メソッド

func onAdReceived(_ ad: AdropNativeAd)

広告受信成功時に呼び出されます。

func onAdFailedToReceive(_ ad: AdropNativeAd, _ errorCode: AdropErrorCode)

広告受信失敗時に呼び出されます。

オプションメソッド

optional func onAdImpression(_ ad: AdropNativeAd)

広告が画面に表示されたときに呼び出されます。

optional func onAdClicked(_ ad: AdropNativeAd)

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

optional func onAdsReceived(_ ads: [AdropNativeAd])

AdropNativeAd.loads(...)でリクエストしたネイティブバッチが配信されたときに呼び出されます。

optional func onAdsFailedToReceive(_ errorCode: AdropErrorCode)

AdropNativeAd.loads(...)のバッチロードが失敗したときに呼び出されます。

optional func onAdVideoStart(_ ad: AdropNativeAd)

ビデオ広告の再生が開始されたときに呼び出されます。

optional func onAdVideoEnd(_ ad: AdropNativeAd)

ビデオ広告の再生が終了したときに呼び出されます。

optional func onAdPreloadReceived(_ unitId: String, _ contextId: String)

AdropNativeAd.preload(...)のプリロードが完了したときに呼び出されます（1.17.0+）。

optional func onAdPreloadFailedToReceive(_ unitId: String, _ contextId: String, _ errorCode: AdropErrorCode)

AdropNativeAd.preload(...)が広告をプリロードできなかったときに呼び出されます（1.17.0+）。

AdropInterstitialAdDelegate

インタースティシャル広告のライフサイクルイベントを処理するプロトコルです。

必須メソッド

func onAdReceived(_ ad: AdropInterstitialAd)

広告受信成功時に呼び出されます。

func onAdFailedToReceive(_ ad: AdropInterstitialAd, _ errorCode: AdropErrorCode)

広告受信失敗時に呼び出されます。

オプションメソッド

optional func onAdImpression(_ ad: AdropInterstitialAd)

広告が画面に表示されたときに呼び出されます。

optional func onAdClicked(_ ad: AdropInterstitialAd)

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

optional func onAdWillPresentFullScreen(_ ad: AdropInterstitialAd)

広告がフルスクリーンで表示される直前に呼び出されます。

optional func onAdDidPresentFullScreen(_ ad: AdropInterstitialAd)

広告がフルスクリーンで表示された直後に呼び出されます。

optional func onAdWillDismissFullScreen(_ ad: AdropInterstitialAd)

広告が閉じられる直前に呼び出されます。

optional func onAdDidDismissFullScreen(_ ad: AdropInterstitialAd)

広告が閉じられたときに呼び出されます。

optional func onAdFailedToShowFullScreen(_ ad: AdropInterstitialAd, _ errorCode: AdropErrorCode)

広告表示失敗時に呼び出されます。

AdropRewardedAdDelegate

リワード広告のライフサイクルイベントを処理するプロトコルです。

必須メソッド

func onAdReceived(_ ad: AdropRewardedAd)

広告受信成功時に呼び出されます。

func onAdFailedToReceive(_ ad: AdropRewardedAd, _ errorCode: AdropErrorCode)

広告受信失敗時に呼び出されます。

オプションメソッド

optional func onAdImpression(_ ad: AdropRewardedAd)

広告が画面に表示されたときに呼び出されます。

optional func onAdClicked(_ ad: AdropRewardedAd)

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

optional func onAdWillPresentFullScreen(_ ad: AdropRewardedAd)

広告がフルスクリーンで表示される直前に呼び出されます。

optional func onAdDidPresentFullScreen(_ ad: AdropRewardedAd)

広告がフルスクリーンで表示された直後に呼び出されます。

optional func onAdWillDismissFullScreen(_ ad: AdropRewardedAd)

広告が閉じられる直前に呼び出されます。

optional func onAdDidDismissFullScreen(_ ad: AdropRewardedAd)

広告が閉じられたときに呼び出されます。

optional func onAdFailedToShowFullScreen(_ ad: AdropRewardedAd, _ errorCode: AdropErrorCode)

広告表示失敗時に呼び出されます。

AdropPopupAdDelegate

ポップアップ広告のライフサイクルイベントを処理するプロトコルです。

必須メソッド

func onAdReceived(_ ad: AdropPopupAd)

広告受信成功時に呼び出されます。

func onAdFailedToReceive(_ ad: AdropPopupAd, _ errorCode: AdropErrorCode)

広告受信失敗時に呼び出されます。

オプションメソッド

optional func onAdImpression(_ ad: AdropPopupAd)

広告が画面に表示されたときに呼び出されます。

optional func onAdClicked(_ ad: AdropPopupAd)

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

optional func onAdWillPresentFullScreen(_ ad: AdropPopupAd)

ポップアップ広告が表示される直前に呼び出されます。

optional func onAdDidPresentFullScreen(_ ad: AdropPopupAd)

ポップアップ広告が表示された直後に呼び出されます。

optional func onAdWillDismissFullScreen(_ ad: AdropPopupAd)

ポップアップ広告が閉じられる直前に呼び出されます。

optional func onAdDidDismissFullScreen(_ ad: AdropPopupAd)

広告が閉じられたときに呼び出されます。

optional func onAdFailedToShowFullScreen(_ ad: AdropPopupAd, _ errorCode: AdropErrorCode)

広告表示失敗時に呼び出されます。

optional func onAdVideoStart(_ ad: AdropPopupAd)

ビデオ広告の再生が開始されたときに呼び出されます。

optional func onAdVideoEnd(_ ad: AdropPopupAd)

ビデオ広告の再生が終了したときに呼び出されます。

AdropPopupAdCloseDelegate

ポップアップ広告の閉じるイベントを処理するプロトコルです。

オプションメソッド

optional func onClosed(_ ad: AdropPopupAd)

ユーザーが閉じるボタンをクリックしたときに呼び出されます。

optional func onDimClicked(_ ad: AdropPopupAd)

ユーザーがポップアップの外側（暗い領域）をクリックしたときに呼び出されます。

optional func onTodayOffClicked(_ ad: AdropPopupAd)

ユーザーが「今日は表示しない」を選択したときに呼び出されます。

AdropSplashAdDelegate

スプラッシュ広告のライフサイクルイベントを処理するプロトコルです。すべてのメソッドは@objc optionalです。

オプションメソッド

optional func onAdReceived(_ ad: AdropSplashAd)

広告受信成功時に呼び出されます。

optional func onAdFailedToReceive(_ ad: AdropSplashAd, _ errorCode: AdropErrorCode)

広告受信失敗時に呼び出されます。

optional func onAdImpression(_ ad: AdropSplashAd)

広告が画面に表示されたときに呼び出されます。

optional func onAdClose(_ ad: AdropSplashAd, impressed: Bool)

スプラッシュ広告が閉じられたときに呼び出されます。impressedは広告が完全に表示されたかどうかを示します。

AdropSplashAdViewDelegate

スプラッシュ広告ビューのライフサイクルイベントを処理するプロトコルです。

必須メソッド

func onAdClose(_ adView: AdropSplashAdView, impressed: Bool)

スプラッシュ広告ビューが閉じられたときに呼び出されます。impressedは広告が完全に表示されたかどうかを示します。

オプションメソッド

optional func onAdReceived(_ adView: AdropSplashAdView)

広告受信成功時に呼び出されます。

optional func onAdFailedToReceive(_ adView: AdropSplashAdView, _ errorCode: AdropErrorCode)

広告受信失敗時に呼び出されます。

optional func onAdImpression(_ adView: AdropSplashAdView)

広告が画面に表示されたときに呼び出されます。

UseCustomClick

広告クリック動作をカスタマイズするためのプロトコルです。AdropBanner、AdropNativeAd、AdropPopupAdで実装されています。

プロパティ / メソッド	型	説明
`destinationURL`	`String?`	広告のリンク先URL（読み取り専用）
`useCustomClick`	`Bool`	`true`に設定すると、広告クリック時の自動URL遷移が無効になります
`open(_:useInAppBrowser:)`	メソッド	URLを手動で開きます。`useCustomClick`が`true`の場合、クリックコールバックで呼び出してください

列挙型 (Enums)

AdropErrorCode

広告の読み込みおよび表示中に発生する可能性のあるエラーコードです。

enum AdropErrorCode: Int

ケース	コード値	説明
`ERROR_CODE_NETWORK`	0	ネットワークエラー
`ERROR_CODE_INTERNAL`	1	内部エラー
`ERROR_CODE_INITIALIZE`	2	SDK初期化失敗
`ERROR_CODE_INVALID_UNIT`	3	無効なユニットID
`ERROR_CODE_NOT_TARGET_COUNTRY`	4	ターゲット国ではない
`ERROR_CODE_AD_INACTIVE`	5	アクティブキャンペーンなし
`ERROR_CODE_AD_NO_FILL`	6	表示可能な広告なし
`ERROR_CODE_AD_LOAD_DUPLICATED`	7	重複した広告読み込みリクエスト
`ERROR_CODE_AD_LOADING`	8	広告読み込み中
`ERROR_CODE_AD_EMPTY`	9	広告が読み込まれていない
`ERROR_CODE_AD_SHOWN`	10	広告がすでに表示されている
`ERROR_CODE_AD_HIDE_FOR_TODAY`	11	「今日は表示しない」設定
`ERROR_CODE_ACCOUNT_USAGE_LIMIT_EXCEEDED`	12	アカウント使用量制限超過
`ERROR_CODE_LANDSCAPE_UNSUPPORTED`	13	横向きモード非対応
`ERROR_CODE_AD_BACKFILL_NO_FILL`	14	バックフィル広告なし
`ERROR_CODE_AD_PRELOAD_SKIPPED`	15	preloadがバックフィル広告をリクエストしなかった（1.17.0+）

エラーコード別説明

ネットワーク関連

ERROR_CODE_NETWORK: ネットワーク接続エラーが発生しました。インターネット接続を確認してください。

初期化関連

ERROR_CODE_INITIALIZE: SDKが初期化されていません。Adrop.initialize()を先に呼び出してください。

ユニット関連

ERROR_CODE_INVALID_UNIT: 無効なユニットIDです。コンソールで確認してください。
ERROR_CODE_NOT_TARGET_COUNTRY: 現在のユーザーの国がターゲット国ではありません。

広告関連

ERROR_CODE_AD_INACTIVE: 該当ユニットに有効化されたキャンペーンがありません。
ERROR_CODE_AD_NO_FILL: 現在表示可能な広告がありません。
ERROR_CODE_AD_BACKFILL_NO_FILL: バックフィル広告もありません。
ERROR_CODE_AD_PRELOAD_SKIPPED: ダイレクト広告が表示される可能性があるか、まだ確認されていないため、preloadがバックフィル広告をリクエストしませんでした。正常な結果です。バックフィル広告のプリロードを参照してください。

広告状態関連

ERROR_CODE_AD_LOAD_DUPLICATED: すでに広告を読み込み中です。
ERROR_CODE_AD_LOADING: 広告がまだ読み込み中です。
ERROR_CODE_AD_EMPTY: 広告を表示する前に読み込む必要があります。
ERROR_CODE_AD_SHOWN: 広告はすでに表示されています。新しい広告を読み込んでください。
ERROR_CODE_AD_HIDE_FOR_TODAY: ユーザーが「今日は表示しない」を選択しました。

その他

ERROR_CODE_INTERNAL: 内部エラーが発生しました。
ERROR_CODE_ACCOUNT_USAGE_LIMIT_EXCEEDED: アカウントの広告使用量制限を超過しました。
ERROR_CODE_LANDSCAPE_UNSUPPORTED: この広告は横向きモードをサポートしていません。

使用例:

func onAdFailedToReceive(_ banner: AdropBanner, _ errorCode: AdropErrorCode) {
    switch errorCode {
    case .ERROR_CODE_NETWORK:
        print("ネットワークエラー: 接続を確認してください")
    case .ERROR_CODE_AD_NO_FILL:
        print("表示可能な広告がありません")
    case .ERROR_CODE_INVALID_UNIT:
        print("無効なユニットIDです")
    default:
        print("広告読み込み失敗: \(errorCode.rawValue)")
    }
}

AdropTheme

アプリのテーマ設定を表す列挙型です。

enum AdropTheme

ケース	説明
`light`	ライトモード
`dark`	ダークモード
`auto`	システム設定に従う (デフォルト)

使用例:

// ライトモードの設定
Adrop.setTheme(.light)

// ダークモードの設定
Adrop.setTheme(.dark)

// システム設定に従う
Adrop.setTheme(.auto)

BrowserTarget

広告URLの開き方を制御します。

値	説明
`EXTERNAL`	デフォルトの外部ブラウザでURLを開きます（デフォルト）
`INTERNAL`	アプリ内ブラウザでURLを開きます

構造体と型

AdropNativeAdProfile

広告主のプロフィール情報を含む構造体です。

struct AdropNativeAdProfile {
    let displayLogo: String     // 広告主ロゴURL
    let displayName: String     // 広告主名
    let link: String?           // 広告主プロフィールリンク
}

使用例:

let profile = nativeAd.profile
profileNameLabel.text = profile.displayName
loadImage(from: profile.displayLogo, into: profileImageView)

AdropNativeAsset

複数メディアのクリエイティブに含まれる個々のメディアです。AdropNativeAd.extraAssetsの値の型です（1.16.0+）。複数メディアのクリエイティブを参照してください。

@objc public class AdropNativeAsset: NSObject {
    @objc public let id: String         // コンソールで設定したメディアID（例："m1"、"m2"）
    @objc public let asset: String      // 画像または動画ファイルのURL
    @objc public let creative: String   // 動画メディアを再生するHTML（トラッキングを含む）
    @objc public let cover: String?     // 動画のポスター画像URL。画像の場合はnil
    @objc public let type: String?      // "display"（画像）または"video"
    @objc public let isVideo: Bool      // 動画かどうか
}

使用例:

if let media2 = nativeAd.extraAssets["m2"], !media2.isVideo {
    loadImage(from: media2.asset, into: media2ImageView)
}

AdropServerSideVerificationOptions

リワード広告のサーバーサイド検証オプションを設定するクラスです。

class AdropServerSideVerificationOptions: NSObject {
    var userId: String?
    var customData: String?

    init(userId: String? = nil, customData: String? = nil)
}

プロパティ	型	説明
`userId`	`String?`	サーバーサイド検証用のユーザー識別子
`customData`	`String?`	サーバーコールバックに含めるカスタムデータ文字列

使用例:

let options = AdropServerSideVerificationOptions(
    userId: "user_12345",
    customData: "level_5_reward"
)
rewardedAd.serverSideVerificationOptions = options

定数

AdropUnitId

テスト用ユニットID定数です。

struct AdropUnitId {
    // バナー広告
    static let PUBLIC_TEST_UNIT_ID_320_50: String
    static let PUBLIC_TEST_UNIT_ID_320_100: String
    static let PUBLIC_TEST_UNIT_ID_CAROUSEL: String
    static let PUBLIC_TEST_UNIT_ID_BANNER_VIDEO_16_9: String
    static let PUBLIC_TEST_UNIT_ID_BANNER_VIDEO_9_16: String

    // ネイティブ広告
    static let PUBLIC_TEST_UNIT_ID_NATIVE: String
    static let PUBLIC_TEST_UNIT_ID_NATIVE_VIDEO_16_9: String
    static let PUBLIC_TEST_UNIT_ID_NATIVE_VIDEO_9_16: String

    // インタースティシャル広告
    static let PUBLIC_TEST_UNIT_ID_INTERSTITIAL: String

    // リワード広告
    static let PUBLIC_TEST_UNIT_ID_REWARDED: String

    // ポップアップ広告
    static let PUBLIC_TEST_UNIT_ID_POPUP_BOTTOM: String
    static let PUBLIC_TEST_UNIT_ID_POPUP_CENTER: String
    static let PUBLIC_TEST_UNIT_ID_POPUP_BOTTOM_VIDEO_16_9: String
    static let PUBLIC_TEST_UNIT_ID_POPUP_BOTTOM_VIDEO_9_16: String
    static let PUBLIC_TEST_UNIT_ID_POPUP_CENTER_VIDEO_16_9: String
    static let PUBLIC_TEST_UNIT_ID_POPUP_CENTER_VIDEO_9_16: String

    // スプラッシュ広告
    static let PUBLIC_TEST_UNIT_ID_SPLASH: String
}

使用例:

let banner = AdropBanner(unitId: AdropUnitId.PUBLIC_TEST_UNIT_ID_320_100)
let carouselBanner = AdropBanner(unitId: AdropUnitId.PUBLIC_TEST_UNIT_ID_CAROUSEL)
let nativeAd = AdropNativeAd(unitId: AdropUnitId.PUBLIC_TEST_UNIT_ID_NATIVE)
let interstitial = AdropInterstitialAd(unitId: AdropUnitId.PUBLIC_TEST_UNIT_ID_INTERSTITIAL)
let popup = AdropPopupAd(unitId: AdropUnitId.PUBLIC_TEST_UNIT_ID_POPUP_CENTER)

テストユニットIDは開発環境でのみ使用してください。本番環境では必ずコンソールで作成した実際のユニットIDを使用する必要があります。

バックフィル広告収益 (`onPaidEvent`)

バックフィル広告が表示された際に広告収益情報を受け取るコールバックです。バックフィル広告のみで発火し、Adropの直接広告では呼び出されません。

サポートされる広告フォーマット

バナー、ネイティブ、インタースティシャル、リワードでサポートされます。ポップアップ・スプラッシュはサポートされません。

デリゲート / クロージャ

@objc optional func onPaidEvent(_ ad: AdropBanner, _ value: AdropAdValue)

// またはクロージャプロパティ
public var onPaidEvent: ((AdropBanner, AdropAdValue) -> Void)?

`AdropAdValue`

フィールド	タイプ	説明
`network`	`String`	バックフィルネットワーク識別子（例: `admob`）
`adSourceName`	`String?`	ネットワーク内部のメディエーションソース（例: `AppLovin`）
`valueMicros`	`Int64`	マイクロ単位の収益（`currencyCode`の1/1,000,000）
`currencyCode`	`String`	ISO 4217通貨コード
`precision`	`AdropAdValuePrecision`	精度（`unknown`、`estimated`、`publisherProvided`、`precise`）
`value`	`NSDecimalNumber`	`valueMicros × 10⁻⁶` の計算値

使用例

let banner = AdropBanner(unitId: "YOUR_UNIT_ID")
banner.delegate = self

extension YourController: AdropBannerDelegate {
    func onPaidEvent(_ banner: AdropBanner, _ value: AdropAdValue) {
        analytics.track(banner.unitId, value.valueMicros, value.currencyCode)
    }
}

AdropNativeAd、AdropInterstitialAd、AdropRewardedAdでもデリゲートメソッドまたは onPaidEvent クロージャプロパティで同じように登録します。

追加リソース

バナー広告

バナー広告実装ガイド

ネイティブ広告

ネイティブ広告実装ガイド

インタースティシャル広告

インタースティシャル広告実装ガイド

リワード広告

リワード広告実装ガイド