레퍼런스

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

  // 다중 미디어 소재의 미디어, 미디어 아이디가 키 (1.4.0+)
  extraAssets?: Record<string, AdropNativeAsset>;
}

interface AdropNativeAsset {
  id: string;                    // 콘솔에서 정한 미디어 아이디 (예: 'm1', 'm2')
  asset: string;                 // 이미지 또는 동영상 파일 URL
  ad: string;                    // 동영상 미디어를 재생하는 HTML (트래킹 포함)
  cover?: string;                // 동영상의 포스터 이미지 URL. 이미지면 없음
  type?: 'display' | 'video';    // 이미지 또는 동영상
  isVideo: boolean;              // 동영상인지 여부
}

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;