リファレンス

interface AdropConfig {
  appId: string;             // アプリID（必須）
  uid?: string;              // ユーザー識別子
  appKey?: string;           // API認証キー
  debug?: boolean;           // デバッグログ（デフォルト: false）
  backfillMode?: BackfillMode; // グローバルバックフィルレンダリングモード（1.2.3+、デフォルト: 'responsive'）
}

interface AdropAdRequest {
  unit: string;              // ユニットID（必須）
  uid?: string;              // ユーザー識別子
  contextId?: string;        // コンテキストターゲティングID
  trackMode?: 0 | 1;         // 0: 自動, 1: 手動（ネイティブ）
  isEntireClick?: boolean;   // 全領域クリック（ネイティブ）
  theme?: AdTheme;           // テーマ
  useCustomClick?: boolean;  // カスタムクリック処理
  backfillMode?: BackfillMode; // スロット単位のバックフィルレンダリングモード上書き（1.2.3+）
  adId?: string;             // 広告識別子 — デバイスで表示時に必須
}

interface AdropAdResponse {
  code: AdropErrorCode;  // レスポンスコード
  msg: string;           // レスポンスメッセージ
  result?: AdData;       // 広告データ（成功時）
}

interface AdropAdsResponse {
  code: AdropErrorCode;  // レスポンスコード
  msg: string;           // レスポンスメッセージ
  results?: 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>;
}

interface AdropEventFilter {
  unit?: string;  // 特定ユニットのみフィルタリング
}

type AdFormat = 'banner' | 'nativeAd' | 'backfill';

type AdTheme = 'light' | 'dark';

type BackfillMode = 'responsive' | 'fixed';

// 広告受信、インプレッション、クリック
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;

// 動画
type AdVideoStartCallback = (unit: string, adData: AdData) => void;
type AdVideoEndCallback = (unit: string, adData: AdData) => void;