Reference

Class, interface, constant, and type definitions for Adrop Web SDK.

Classes

Adrop

The main SDK class. Works as a singleton.

Static Methods

Method	Return Type	Description
observe(config)	Adrop	Initialize SDK and start automatic DOM detection
instance()	Adrop	Return existing instance

Instance Methods

Method	Return Type	Description
renderAd(container, options?)	Promise<void>	Render ad
requestAd(options)	Promise<AdropAdResponse>	Request ad data only
clear(container)	void	Remove ad
setConfig(config)	void	Update configuration
on(event, callback, filter?)	void	Register event listener
off(event, callback)	void	Unregister event listener

Instance Properties

Property	Type	Description
uid	string	User identifier (getter/setter)
appKey	string	API authentication key (getter/setter)
metrics	AdropMetrics	User property management

---

Interfaces

AdropConfig

SDK initialization options.

interface AdropConfig {
  appId: string;      // App ID (required)
  uid?: string;       // User identifier
  appKey?: string;    // API authentication key
  debug?: boolean;    // Debug logging (default: false)
}

AdropAdRequest

Ad request parameters.

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
}

AdropAdResponse

Ad response object.

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

AdData

Ad data object.

interface AdData {
  // Common
  format: AdFormat;       // Ad format
  unit: string;           // Unit ID

  // 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

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

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

AdropEventFilter

Event filter options.

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

---

Constants

Adrop.Events

Event constants. Access via Adrop.Events.

Constant	Value	Description
AD_RECEIVED	'adReceived'	Ad received successfully
AD_NO_FILL	'adNoFill'	No direct ads
AD_IMPRESSION	'adImpression'	Ad impression
AD_CLICKED	'adClicked'	Ad click
AD_FAILED	'adFailed'	Ad request failed
AD_BACKFILL_NO_FILL	'adBackfillNoFill'	No backfill ads

Adrop.ErrorCode

Error codes. Access via Adrop.ErrorCode.

Constant	Value	Description
OK	0	Success
ERROR_CODE_INVALID_UNIT	4000	Invalid unit ID
ERROR_CODE_AD_INACTIVE	4001	No active campaigns
ERROR_CODE_AD_NO_FILL	4002	No matching ads
ERROR_CODE_INVALID_PARAMS	4003	Invalid parameters

---

Types

AdFormat

Ad format type.

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

AdTheme

Theme type.

type AdTheme = 'light' | 'dark';

---

Event Callbacks

Callback signatures for each event.

// 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
type AdNoFillCallback = (unit: string) => void;
type AdFailedCallback = (unit: string) => void;
type AdBackfillNoFillCallback = (unit: string) => void;