クラス
Adrop
SDKのメインクラスです。シングルトンパターンで動作します。静的メソッド
| メソッド | 戻り値 | 説明 |
|---|---|---|
observe(config) | Adrop | SDK初期化およびDOM自動検出開始 |
instance() | Adrop | 既存インスタンスを返す |
インスタンスメソッド
| メソッド | 戻り値 | 説明 |
|---|---|---|
renderAd(container, options?) | Promise<void> | 広告レンダリング |
requestAd(options) | Promise<AdropAdResponse> | 広告データのみリクエスト |
clear(container) | void | 広告削除 |
setConfig(config) | void | 設定変更 |
on(event, callback, filter?) | void | イベントリスナー登録 |
off(event, callback) | void | イベントリスナー解除 |
インスタンスプロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
uid | string | ユーザー識別子 (getter/setter) |
appKey | string | API認証キー (getter/setter) |
metrics | AdropMetrics | ユーザー属性管理 |
インターフェース
AdropConfig
SDK初期化オプションです。AdropAdRequest
広告リクエストパラメータです。AdropAdResponse
広告レスポンスオブジェクトです。AdData
広告データオブジェクトです。AdropEventFilter
イベントフィルターオプションです。定数
Adrop.Events
イベント定数です。Adrop.Eventsでアクセスします。
| 定数 | 値 | 説明 |
|---|---|---|
AD_RECEIVED | 'adReceived' | 広告受信成功 |
AD_NO_FILL | 'adNoFill' | 直接広告なし |
AD_IMPRESSION | 'adImpression' | 広告表示 |
AD_CLICKED | 'adClicked' | 広告クリック |
AD_FAILED | 'adFailed' | 広告リクエスト失敗 |
AD_BACKFILL_NO_FILL | 'adBackfillNoFill' | バックフィル広告なし |
Adrop.ErrorCode
エラーコードです。Adrop.ErrorCodeでアクセスします。
| 定数 | 値 | 説明 |
|---|---|---|
OK | 0 | 成功 |
ERROR_CODE_INVALID_UNIT | 4000 | 無効なユニットID |
ERROR_CODE_AD_INACTIVE | 4001 | アクティブなキャンペーンなし |
ERROR_CODE_AD_NO_FILL | 4002 | マッチする広告なし |
ERROR_CODE_INVALID_PARAMS | 4003 | 無効なパラメータ |