クラス
Adrop
SDKのメインクラスです。SDKの初期化とグローバル設定を管理します。
静的メソッド
| メソッド | 戻り値型 | 説明 |
|---|
initialize(production:useInAppBrowser:targetCountries:) | void | SDKの初期化 |
setUID(_:) | void | ユーザー識別子の設定 |
setTheme(_:) | void | アプリテーマの設定 |
handleDeepLink(url:) | Bool | ディープリンクの処理 |
初期化メソッド
static func initialize(
production: String,
useInAppBrowser: Bool = true,
targetCountries: [String]? = nil
)
Adropコンソールから発行されたプロダクションキー
インアプリブラウザの使用有無。trueの場合、広告クリック時にアプリ内で開く
ターゲット国コード配列 (例: [“KR”, “US”])。nilの場合すべての国
使用例:
// AppDelegate.swift
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
Adrop.initialize(production: "YOUR_PRODUCTION_KEY")
return true
}
AdropBanner
バナー広告を表示するクラスです。UIViewを継承します。
初期化
Adropコンソールで作成したバナー広告ユニットID
メソッド
| メソッド | 戻り値型 | 説明 |
|---|
load() | void | 広告リクエストと読み込み |
プロパティ
| プロパティ | 型 | 説明 |
|---|
unitId | String | ユニットID (読み取り専用) |
contextId | String? | コンテキストターゲティングID (読み書き) |
delegate | AdropBannerDelegate? | デリゲート (読み書き) |
AdropNativeAd
ネイティブ広告データを管理するクラスです。
初期化
プロパティ
| プロパティ | 型 | 説明 |
|---|
headline | String? | 広告タイトル (読み取り専用) |
body | String? | 広告本文 (読み取り専用) |
callToAction | String? | CTAボタンテキスト (読み取り専用) |
asset | String? | メイン画像/動画URL (読み取り専用) |
profile | AdropProfile? | 広告主プロフィール (読み取り専用) |
extra | [String: String]? | 追加カスタムフィールド (読み取り専用) |
AdropInterstitialAd
インタースティシャル広告を表示するクラスです。
初期化
メソッド
| メソッド | 戻り値型 | 説明 |
|---|
load() | void | 広告の事前読み込み |
show(fromRootViewController:) | void | 広告の表示 |
プロパティ
| プロパティ | 型 | 説明 |
|---|
delegate | AdropInterstitialAdDelegate? | デリゲート (読み書き) |
isLoaded | Bool | 広告が読み込まれたかどうか (読み取り専用) |
AdropRewardedAd
リワード広告を表示するクラスです。
初期化
メソッド
| メソッド | 戻り値型 | 説明 |
|---|
load() | void | 広告の事前読み込み |
show(fromRootViewController:userDidEarnRewardHandler:) | void | 広告の表示とリワードハンドラーの設定 |
ポップアップ広告を表示するクラスです。
初期化
プロパティ
| プロパティ | 型 | 説明 |
|---|
delegate | AdropPopupAdDelegate? | 広告イベントデリゲート (読み書き) |
closeDelegate | AdropPopupAdCloseDelegate? | 閉じるイベントデリゲート (読み書き) |
isLoaded | Bool | 広告が読み込まれたかどうか (読み取り専用) |
AdropSplashAd
スプラッシュ広告を管理するクラスです。
初期化
プロトコル (Delegates)
AdropBannerDelegate
バナー広告のライフサイクルイベントを処理するプロトコルです。
必須メソッド
func onAdReceived(_ banner: AdropBanner)
広告受信成功時に呼び出されます。
func onAdFailedToReceive(_ banner: AdropBanner, _ errorCode: AdropErrorCode)
広告受信失敗時に呼び出されます。
オプションメソッド
optional func onAdImpression(_ banner: AdropBanner)
広告が画面に表示されたときに呼び出されます。
optional func onAdClicked(_ banner: AdropBanner)
ユーザーが広告をクリックしたときに呼び出されます。
AdropNativeAdDelegate
ネイティブ広告のライフサイクルイベントを処理するプロトコルです。
必須メソッド
func onAdReceived(_ nativeAd: AdropNativeAd)
広告受信成功時に呼び出されます。
func onAdFailedToReceive(_ nativeAd: AdropNativeAd, _ errorCode: AdropErrorCode)
広告受信失敗時に呼び出されます。
AdropInterstitialAdDelegate
インタースティシャル広告のライフサイクルイベントを処理するプロトコルです。
必須メソッド
func onAdReceived(_ ad: AdropInterstitialAd)
広告受信成功時に呼び出されます。
func onAdFailedToReceive(_ ad: AdropInterstitialAd, _ errorCode: AdropErrorCode)
広告受信失敗時に呼び出されます。
AdropRewardedAdDelegate
リワード広告のライフサイクルイベントを処理するプロトコルです。
必須メソッド
func onAdReceived(_ ad: AdropRewardedAd)
広告受信成功時に呼び出されます。
func onAdFailedToReceive(_ ad: AdropRewardedAd, _ errorCode: AdropErrorCode)
広告受信失敗時に呼び出されます。
列挙型 (Enums)
AdropErrorCode
広告の読み込みおよび表示中に発生する可能性のあるエラーコードです。
| ケース | コード値 | 説明 |
|---|
ERROR_CODE_NETWORK | 1000 | ネットワークエラー |
ERROR_CODE_INTERNAL | 2000 | 内部エラー |
ERROR_CODE_INITIALIZE | 3000 | SDK初期化失敗 |
ERROR_CODE_INVALID_UNIT | 4000 | 無効なユニットID |
ERROR_CODE_NOT_TARGET_COUNTRY | 4010 | ターゲット国ではない |
ERROR_CODE_AD_INACTIVE | 4100 | アクティブキャンペーンなし |
ERROR_CODE_AD_NO_FILL | 4200 | 表示可能な広告なし |
ERROR_CODE_AD_LOAD_DUPLICATED | 5000 | 重複した広告読み込みリクエスト |
ERROR_CODE_AD_LOADING | 5001 | 広告読み込み中 |
ERROR_CODE_AD_EMPTY | 5002 | 広告が読み込まれていない |
ERROR_CODE_AD_SHOWN | 5003 | 広告がすでに表示されている |
ERROR_CODE_AD_HIDE_FOR_TODAY | 5100 | 今日は表示しない設定 |
エラーコード別説明
ネットワーク関連
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: 現在表示可能な広告がありません。
使用例:
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
アプリのテーマ設定を表す列挙型です。
| ケース | 説明 |
|---|
light | ライトモード |
dark | ダークモード |
auto | システム設定に従う (デフォルト) |
使用例:
// ライトモードの設定
Adrop.setTheme(.light)
// ダークモードの設定
Adrop.setTheme(.dark)
// システム設定に従う
Adrop.setTheme(.auto)
構造体と型
AdropProfile
広告主のプロフィール情報を含む構造体です。
struct AdropProfile {
let displayLogo: String? // 広告主ロゴURL
let displayName: String? // 広告主名
let link: String? // 広告主プロフィールリンク
}
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_SMALL: String
static let PUBLIC_TEST_UNIT_ID_NATIVE_MEDIUM: String
static let PUBLIC_TEST_UNIT_ID_NATIVE_LARGE: String
// インタースティシャル広告
static let PUBLIC_TEST_UNIT_ID_INTERSTITIAL: String
// リワード広告
static let PUBLIC_TEST_UNIT_ID_REWARDED: String
// ポップアップ広告
static let PUBLIC_TEST_UNIT_ID_POPUP: 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_SPLASH: String
}
テストユニットIDは開発環境でのみ使用してください。本番環境では必ずコンソールで作成した実際のユニットIDを使用する必要があります。
追加リソース