メインコンテンツへスキップ

クラス

Adrop

SDKのメインクラスです。シングルトンパターンで動作します。

静的メソッド

メソッド戻り値説明
observe(config)AdropSDK初期化およびDOM自動検出開始
instance()Adrop既存インスタンスを返す

インスタンスメソッド

メソッド戻り値説明
renderAd(container, request?)Promise<void>広告レンダリング
requestAd(request)Promise<AdropAdResponse>広告データのみリクエスト(単一)
requestAds(request)Promise<AdropAdsResponse>複数広告データリクエスト
clear(container)void広告削除
setConfig(config)void設定変更
on(event, callback, filter?)voidイベントリスナー登録
off(event, callback)voidイベントリスナー解除

インスタンスプロパティ

プロパティタイプ説明
uidstringユーザー識別子 (getter/setter)
appKeystringAPI認証キー (getter/setter)
metricsAdropMetricsユーザー属性管理

AdropMetrics

ユーザー属性管理クラスです。

メソッド

メソッド戻り値説明
setUserProperties(props)AdropMetricsユーザー属性を設定(チェーン可能)
setAppProperties(props)AdropMetricsアプリ属性を設定(チェーン可能)
commit()Promise<void>属性をサーバーに保存
properties()Properties現在設定されている属性を返す
clear()void設定された属性をクリア(デバイス属性は保持)

インターフェース

AdropConfig

SDK初期化オプションです。
interface AdropConfig {
  appId: string;      // アプリID(必須)
  uid?: string;       // ユーザー識別子
  appKey?: string;    // API認証キー
  debug?: boolean;    // デバッグログ(デフォルト: false)
}

AdropAdRequest

広告リクエストパラメータです。
interface AdropAdRequest {
  unit: string;           // ユニットID(必須)
  uid?: string;           // ユーザー識別子
  contextId?: string;     // コンテキストターゲティングID
  trackMode?: 0 | 1;      // 0: 自動, 1: 手動(ネイティブ)
  isEntireClick?: boolean; // 全領域クリック(ネイティブ)
  theme?: AdTheme;        // テーマ
  useCustomClick?: boolean; // カスタムクリック処理
}

AdropAdResponse

広告レスポンスオブジェクトです(単一広告)。
interface AdropAdResponse {
  code: AdropErrorCode;  // レスポンスコード
  msg: string;           // レスポンスメッセージ
  result?: AdData;       // 広告データ(成功時)
}

AdropAdsResponse

広告レスポンスオブジェクトです(複数広告)。
interface AdropAdsResponse {
  code: AdropErrorCode;  // レスポンスコード
  msg: string;           // レスポンスメッセージ
  results?: AdData[];    // 広告データ配列(成功時)
}

AdData

広告データオブジェクトです。
interface AdData {
  // 共通
  format: AdFormat;       // 広告フォーマット
  unit: string;           // ユニットID
  ad: string;             // 広告HTMLコンテンツ
  w: number;              // 広告幅
  h: number;              // 広告高さ
  type?: string;          // 広告タイプ
  target?: string;        // ターゲットURL開き方

  // ネイティブ広告フィールド
  headline?: string;      // 広告タイトル
  body?: string;          // 広告説明
  callToAction?: string;  // CTAボタンテキスト
  asset?: string;         // メイン画像URL
  destinationURL?: string; // クリック時遷移URL

  // 識別子フィールド
  id?: string;            // 広告ID
  cpId?: string;          // キャンペーンID
  creativeId?: string;    // クリエイティブID
  accountTag?: string;    // アカウントレベルタグ
  creativeTag?: string;   // クリエイティブレベルタグ

  // トラッカーフィールド (trackMode=1)
  pixelTracker?: string;  // ピクセルトラッカーURL(1x1画像、インプレッション追跡)
  imprTracker?: string;   // インプレッショントラッカーURL
  clickTracker?: string;  // クリックトラッカーURL

  // 広告主プロフィール
  profile?: {
    displayLogo?: string;  // 広告主ロゴURL
    displayName?: string;  // 広告主名
    link?: string;         // 広告主プロフィールリンク
  };

  // 追加テキスト項目
  extra?: Record<string, string>;
}

AdropEventFilter

イベントフィルターオプションです。
interface AdropEventFilter {
  unit?: string;  // 特定ユニットのみフィルタリング
}

定数

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でアクセスします。
定数説明
OK0成功
ERROR_CODE_INVALID_UNIT4000無効なユニットID
ERROR_CODE_AD_INACTIVE4001アクティブなキャンペーンなし
ERROR_CODE_AD_NO_FILL4002マッチする広告なし
ERROR_CODE_INVALID_PARAMS4003無効なパラメータ

タイプ

AdFormat

広告フォーマットタイプです。
type AdFormat = 'banner' | 'nativeAd' | 'backfill';

AdTheme

テーマタイプです。
type AdTheme = 'light' | 'dark';

イベントコールバック

各イベントのコールバックシグネチャです。
// 広告受信、インプレッション、クリック
type AdReceivedCallback = (unit: string, adData: AdData) => void;
type AdImpressionCallback = (unit: string, adData: AdData) => void;
type AdClickedCallback = (unit: string, adData: AdData) => void;

// 広告なし、失敗、バックフィル広告なし
type AdNoFillCallback = (unit: string) => void;
type AdFailedCallback = (unit: string) => void;
type AdBackfillNoFillCallback = (unit: string) => void;
すべてのイベントコールバックは最初の引数としてunitを受け取ります。AD_RECEIVEDAD_IMPRESSIONAD_CLICKEDイベントは2番目の引数としてadDataも受け取ります。