Classes

Adrop (Main SDK Class)

Adrop는 Web SDK의 핵심 클래스입니다.

DOM 감지, 광고 요청, 광고 렌더링, 이벤트 처리 등을 담당합니다.

Static Methods

observe(config: AdropConfig): Adrop

DOM을 관찰(Observe)하여 data-adrop-unit 속성이 포함된 모든 요소에 자동으로 광고를 로딩합니다.

Singleton 패턴으로 동작하며, 이미 초기화된 경우 기존 인스턴스를 반환합니다.

  • Parameters

    • config: SDK 설정 객체

      (이미 초기화된 경우 기존 설정과 병합됩니다)

  • Returns

    • Adrop 인스턴스

instance(): Adrop

Adrop 인스턴스를 return합니다.

  • Returns

    • Adrop 인스턴스

Instance Methods

setConfig(config: AdropConfig): void

기존 SDK 설정에 새로운 설정 값을 업데이트합니다.

  • Parameters

    • config: 변경할 설정 값

renderAd(container: HTMLElement | string, request?: AdropAdRequest): Promise

지정된 컨테이너에 광고를 렌더링합니다.

  • Parameters

    • container: HTML Element 또는 Element ID

    • request(optional): 광고 요청 파라미터

      (컨테이너에 data attributes에 대응되는 값들은 생략 가능)

requestAd(request: AdropAdRequest): Promise

광고를 렌더링하지 않고 광고 데이터만 요청합니다.

  • Parameters

    • request: 광고 요청 정보

  • Returns

    • 광고 응답(AdropAdResponse)

clear(container: HTMLElement | string): void

해당 컨테이너에 렌더링된 광고를 제거합니다.

  • Parameters

    • container: HTML Element 또는 Element ID

on(event, callback, filter?): void

SDK 이벤트를 등록합니다.

  • Parameters

    • event: 이벤트 이름 (Adrop.Events)

    • callback: 이벤트 처리 함수

    • filter(optional): 유닛 필터 등 조건부 이벤트 처리

off(event, callback): void

등록된 이벤트 리스너를 제거합니다.

  • Parameters

    • event: 이벤트 이름

    • callback: 제거할 콜백 함수

AdropMetrics

사용자/App/Device/Custom 속성(property)을 관리하는 모듈입니다.

사용자 속성을 업데이트하거나 서버로 전달하는 역할을 합니다.

Instance Methods

properties(): Properties

모든 속성의 병합된 값을 반환합니다.

우선순위는 아래와 같습니다:

device < app < user

  • Returns

    • 병합된 properties

clear(): void

App 및 User 속성을 초기화합니다.

(Device 속성은 초기화되지 않습니다)

setAppProperties(properties: AppProperties): this

App 관련 속성을 설정합니다.

  • Parameters

    • properties: 앱 속성

  • Returns

    • AdropMetrics(this) — 메서드 체이닝 가능

setUserProperties(properties: UserProperties): this

User 속성을 설정합니다.

AppProperties 또는 DeviceProperties에 해당하는 키는 자동으로 필터링됩니다.

  • Parameters

    • properties: 유저 속성

  • Returns

    • AdropMetrics(this)

commit(): Promise<void>

변경된 사용자 속성을 서버로 업데이트합니다.

appKey와 uid가 config에 설정되어 있어야 합니다.

PreviousAppendixNextInterfaces

Last updated