Reference

interface AdropConfig {
  appId: string;             // App ID (required)
  uid?: string;              // User identifier
  appKey?: string;           // API authentication key
  debug?: boolean;           // Debug logging (default: false)
  backfillMode?: BackfillMode; // Global backfill rendering mode (1.2.3+, default: 'responsive')
}

interface AdropAdRequest {
  unit: string;              // Unit ID (required)
  uid?: string;              // User identifier
  contextId?: string;        // Contextual targeting ID
  trackMode?: 0 | 1;         // 0: auto, 1: manual (native)
  isEntireClick?: boolean;   // Entire area click (native)
  theme?: AdTheme;           // Theme
  useCustomClick?: boolean;  // Custom click handling
  backfillMode?: BackfillMode; // Per-slot backfill rendering mode override (1.2.3+)
  adId?: string;             // Advertising identifier — required for View on Device preview
}

interface AdropAdResponse {
  code: AdropErrorCode;  // Response code
  msg: string;           // Response message
  result?: AdData;       // Ad data (on success)
}

interface AdropAdsResponse {
  code: AdropErrorCode;  // Response code
  msg: string;           // Response message
  results?: AdData[];    // Ad data array (on success)
}

interface AdData {
  // Common
  format: AdFormat;       // Ad format
  unit: string;           // Unit ID
  ad: string;             // Ad HTML content
  w: number;              // Ad width
  h: number;              // Ad height
  type?: string;          // Ad type
  target?: string;        // Target URL open method

  // Native ad fields
  headline?: string;      // Ad title
  body?: string;          // Ad description
  callToAction?: string;  // CTA button text
  asset?: string;         // Main image URL
  destinationURL?: string; // Click destination URL

  // Identifier fields
  id?: string;            // Ad ID
  cpId?: string;          // Campaign ID
  creativeId?: string;    // Creative ID
  accountTag?: string;    // Account-level tag
  creativeTag?: string;   // Creative-level tag

  // Tracker fields (trackMode=1)
  pixelTracker?: string;  // Pixel tracker URL (1x1 image for impression)
  imprTracker?: string;   // Impression tracker URL
  clickTracker?: string;  // Click tracker URL

  // Advertiser profile
  profile?: {
    displayLogo?: string;  // Advertiser logo URL
    displayName?: string;  // Advertiser name
    link?: string;         // Advertiser profile link
  };

  // Extra text items
  extra?: Record<string, string>;
}

interface AdropEventFilter {
  unit?: string;  // Filter specific unit only
}

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

type AdTheme = 'light' | 'dark';

type BackfillMode = 'responsive' | 'fixed';

// Ad received, impression, click
type AdReceivedCallback = (unit: string, adData: AdData) => void;
type AdImpressionCallback = (unit: string, adData: AdData) => void;
type AdClickedCallback = (unit: string, adData: AdData) => void;

// No ad, failed, backfill no fill
type AdNoFillCallback = (unit: string) => void;
type AdFailedCallback = (unit: string) => void;
type AdBackfillNoFillCallback = (unit: string) => void;

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