API

gladsdk

`defineAdSlot()`

defineAdSlot(adSlotInfo: AdSlotInfo): AdSlot

adSlotInfo로 광고 슬롯을 생성하여 반환합니다. adSlotElementId로 생성된 슬롯이 있을 경우 이전에 생성된 슬롯을 반환합니다.

adSlotInfo.adSlotElementId가 전달되지 않는 경우 adUnitId_${광고 슬롯 생성 번호}로 설정됩니다.

var adSlotInfo = {
  adUnitId: 'adUnitId',
};
window.gladsdk.defineAdSlot(adSlotInfo); // adSlotElementId: adUnitId_1
window.gladsdk.defineAdSlot(adSlotInfo); // adSlotElementId: adUnitId_2

Parameter

adSlotInfo: object 타입의 광고 슬롯에 설정할 정보
Return

adSlot: 생성한 광고 슬롯

`hasAdSlot()`

hasAdSlot(adSlotElementId: string): boolean

Parameter

adSlotElementId: 광고 슬롯을 생성할 때 전달한 adSlotInfo.adSlotElementId
Return

boolean: adSlotElemenetId로 생성한 adSlot의 존재 여부

`findAdSlot()`

findAdSlot(adSlotElementId: string): AdSlot | null

Parameter

adSlotElementId: 광고 슬롯을 생성할 때 전달한 adSlotInfo.adSlotElementId
Return

adSlotElemenetId로 찾은 광고 슬롯. 존재하지 않을 경우 null을 반환합니다.

`displayAd()`

displayAd(divOrAdSlot: string | Element | AdSlot): void

Parameter

divOrAdSlot: 광고를 노출할 광고 슬롯의 div 또는 div의 id(adSlotElementId) 또는 adSlot

`displayAdWithResponse()`

displayAdWithResponse(divOrAdSlot: string | Element | AdSlot, waterfallResponse: WaterfallResponse, dedupReqId?: string): void

광고 응답 (waterfallResponse)를 이용하여 광고 슬롯을 렌더링합니다.

Parameter

divOrAdSlot: 광고를 노출할 광고 슬롯의 div 또는 div의 id(adSlotElementId) 또는 adSlot

waterfallResponse: 광고 렌더링에 사용할 광고 응답 객체

dedupReqId: 중복 제어 설정이 필요할 경우 중복 제어 매니저를 식별하기 위한 id

`setMediationList()`

(Deprecated) setMediationList(waterfallResponse: WaterfallResponse, dedupReqId?: string): void

주의

해당 API는 Deprecated 되었습니다. displayAdWithResponse()사용을 권장합니다.

광고 응답 (waterfallResponse)를 이용하여 광고 슬롯을 렌더링합니다.

Parameter

waterfallResponse: 광고 렌더링에 사용할 광고 응답 객체

dedupReqId: 중복 제어 설정이 필요할 경우 중복 제어 매니저를 식별하기 위한 id

`destroyAdSlots()`

destroyAdSlots(adSlots?: AdSlot[]): void

전달받은 adSlots를 삭제합니다. adSlots를 전달하지 않은 경우 모든 슬롯을 삭제합니다.

Parameter

adSlots: 삭제할 adSlots의 배열

`refreshAdSlots()`

refreshAdSlots(adSlots?: AdSlot[]): void

전달받은 adSlots를 새로고침합니다. adSlots를 전달하지 않은 경우 모든 슬롯을 새로고침합니다.

Parameter

adSlots: 새로고침할 adSlots의 배열. adSlots를 전달하지 않을 경우 모든 슬롯을 새로고침 합니다.

`setGlobalConfig()`

setGlobalConfig(gfpConfig: GfpConfig): void

Parameter

gfpConfig: SDK 전역 파라미터 설정값

`getGlobalConfig()`

getGlobalConfig(): GfpConfig

Return

gfpConfig: 설정된 SDK 전역 파라미터 설정값

`setCustomParam()`

setCustomParam(key: string, value: string | string[]): void

Parameter

key & value: 모든 광고 슬롯의 커스텀 파라미터로 설정할 key-value 쌍

`getPhase()`

getPhase(): string

Return

phase(string): SDK 전역 파라미터에 설정된 phase값. phase가 설정되지 않은 경우 SDK의 phase 기본값을 반환합니다.

`getVersion()`

getVersion(): string

Return

version(string): SDK의 버전 정보

`addEventListener()`

addEventListener(event: AdEventType, handler: (ad: GfpAd) => void): void

SDK의 이벤트에 대해 이벤트 리스너를 추가합니다.

Parameter

event: 리스너를 추가할 이벤트

handler: 이벤트 발생 시 실행할 콜백 함수

`removeEventListener()`

removeEventListener(event: AdEventType, handler: (ad: GfpAd) => void): void

addEventListener를 통해 등록했던 이벤트 리스너를 제거합니다.

Parameter

event: 리스너를 제거할 이벤트

handler: addEventListener를 통해 등록했던 콜백 함수

`removeAllEventListener()`

removeAllEventListener(): void

SDK에 설정된 모든 이벤트 리스너를 제거합니다.

`setAdDeduplication()`

setAdDeduplication(dedupReqId: string, maxDedupReqCount: number): AdDeduplicationManager

중복 제어 매니저를 생성합니다.

Parameter

dedupReqId: 중복 제어 매니저를 식별하기 위한 ID

maxDedupReqCount: 중복 제어를 적용할 광고 슬롯의 개수 - 1
Return

adDeduplicationManager: 생성된 중복 제어 매니저. dedupReqId로 생성된 매니저가 있을 경우 생성된 매니저를 반환합니다.

`clearAdDeduplication()`

clearAdDeduplication(dedupReqId: string): void

중복 제어 매니저를 삭제합니다.

Parameter

dedupReqId: 중복 제어 매니저를 식별하기 위한 ID

`findAdDedupManager()`

findAdDedupManager(dedupReqId: string): AdDeduplicationManager | null

Parameter

dedupReqId: 중복 제어 매니저를 식별하기 위한 ID
Return

adDeduplicationManager: dedupReqId로 찾은 중복 제어 매니저. 찾지 못할 경우 null을 반환합니다.

`setHostMeta()`

setHostMeta(key: string, value: number | string | boolean | object): void

모든 광고 슬롯에 매체에서 광고 소재에 전달할 hostMeta값을 설정합니다.

Parameter

key & value : key-value 형태의 hostMeta 값

`setForceSafeFrame()`

setForceSafeFrame(forceSafeFrame: boolean): void

렌더링될 모든 광고 iFrame에 대해 SafeFrame 여부를 설정합니다. true로 설정할 경우 크로스 도메인 설정과 sandbox 속성값이 추가되며 SafeFrame 형태로 광고 iFrame이 렌더링됩니다. (default: false)

Parameter

forceSafeFrame: SafeFrame 적용 여부 (boolean)

`callNativeBounce()`

callNativeBounce(): void

네이티브 광고의 Bounceback 트래킹을 전송합니다. SPA 페이지와 같이 브라우저 히스토리 백을 감지하지 못할 경우 매체에서 명시적으로 Bounceback 트래킹을 호출할 수 있도록 제공됩니다.

`setPrivacySettings()`

setPrivacySettings(privacySettingsConfig: { underAgeOfConsent?: boolean; childDirectedTreatment?: boolean; }): void

개인 정보 보호와 관련한 설정입니다. 인터페이스 미호출 혹은 상세 파라미터 값(boolean) 미설정 시에 광고 요청에 포함하지 않습니다. 세부 파라미터의 값을 명시적으로 전달하는 경우에만 광고 요청에 포함합니다.

Parameter

privacySettingsConfig : 개인 정보 보호 설정을 위한 구성 객체입니다.
- underAgeOfConsent: 성인이 아닌 사용자에 대한 광고 요청 여부를 나타냅니다.
- childDirectedTreatment: 아동 온라인 개인정보 보호법 (COPPA) 에 의거하여 페이지 또는 앱이 아동 대상 서비스로 취급 되어야 하는지 여부를 나타냅니다.

`setContentId()`

setContentId(contentId: string): void

Parameter

contentId : 네이버 로그인을 사용하는 매체의 컨텐츠 아이디

`setSegmentForABT()`

setSegmentForABT(segment: string): void

AB Test 지원을 위한 인터페이스 입니다.

Parameter

segment: AB Test 파라미터 (string)

getter 함수

AdSlot에 설정된 값들을 확인할 수 있는 getter 함수를 제공합니다.

getAdSlotElementId(): string: AdSlot의 adSlotElementId
getAdUnitId(): string: AdSlot의 adUnitId
getAdProviderName(): string | undefined: AdSlot의 광고 제공자 이름. 광고가 렌더링 되기 이전이나 렌더링 되지 않아 광고 제공자가 설정되지 않은 경우 undefined
getCreativeType(): string | undefined: AdSlot의 광고 타입("BANNER" | "NATIVE"). 광고가 렌더링 되기 이전이나 렌더링 되지 않아 광고 제공자가 설정되지 않은 경우 undefined

`setRenderConfig()`

setRenderConfig(renderConfig: RenderConfig): void

광고를 미리 렌더링하고 노출 이벤트 트래킹을 특정 시점에 처리해야 하는 경우 renderConfig의 preload를 설정합니다. 미리 렌더링한 광고의 노출 이벤트를 시작할 때 initEvent()를 호출합니다.

Parameter

renderConfig: adSlot의 렌더링 설정. preload를 속성으로 가지고 있습니다.
```
adSlot.setRenderConfig({ preload: true });
```

`initEvent()`

initEvent(): void

setRenderConfig()를 통해 preload로 광고가 렌더링된 이후 노출 관련 이벤트를 시작할 때 호출하는 API 입니다.

`setCustomParam()`

setCustomParam(key: string, value: string | string[]): void

Parameter

key & value: 광고 슬롯의 커스텀 파라미터로 설정할 key-value 쌍

`setApsBidTargeting()`

setApsBidTargeting(apsTargeting: ApsTargeting): void

Parameter

apsTargeting: Amazon UAM 비딩 응답 결과

`setPbjsBidTargeting()`

setPbjsBidTargeting(pbjsTargeting: PbjsTargeting[]): void

Parameter

pbjsTargeting: Prebid.js 비딩 응답 결과

`setClickHandler()`

setClickHandler(clickHandler: ClickHandler): void

클릭 핸들러를 설정하여 광고 슬롯에 대한 클릭 이벤트를 커스텀하게 처리할 수 있습니다.

자세한 설명과 예시는 광고 클릭 처리 커스텀를 참고해주세요.

Parameter

clickHandler: 광고 슬롯에 대한 클릭 이벤트 발생 시 실행될 콜백 함수

adSlot.setClickHandler(function (curl, furl, ext) {
  console.debug('curl', curl, 'furl', furl, 'ext', ext, 'type', ext.type);
});

`setHostMeta()`

setHostMeta(key: string, value: number | string | boolean | object): void

광고 슬롯에 매체에서 광고 소재에 전달할 hostMeta값을 설정합니다.

Parameter

key & value : key-value 형태의 hostMeta 값

`setForceSafeFrame()`

setForceSafeFrame(forceSafeFrame: boolean): void

렌더링될 광고 슬롯의 iFrame에 대해 SafeFrame 여부를 설정합니다. true로 설정할 경우 크로스 도메인 설정과 sandbox 속성값이 추가되며 SafeFrame 형태로 광고 iFrame이 렌더링됩니다. (default: false)

Parameter

forceSafeFrame: SafeFrame 적용 여부 (boolean)

`setNativeClickHandler()`

(Deprecated) setNativeClickHandler(clickHandler: ClickHandler): void

주의

해당 API는 Deprecated 되었습니다. setClickHandler()사용을 권장합니다.

Parameter

clickHandler: 네이티브 광고 슬롯에 대한 클릭 이벤트 발생 시 실행될 콜백 함수

adDeduplicationManager

`displayAds()`

displayAds(adSlots: AdSlot[]): void

Parameter

adSlots: 중복 제어 매니저를 통하여 렌더링할 AdSlot의 배열

`restoreAds()`

restoreAds(adSlots?: AdSlot[]): void

Parameter

adSlots: 중복 제어 매니저를 통하여 복원할 AdSlot의 배열

gladsdk​

defineAdSlot()​

hasAdSlot()​

findAdSlot()​

displayAd()​

displayAdWithResponse()​

setMediationList()​

destroyAdSlots()​

refreshAdSlots()​

setGlobalConfig()​

getGlobalConfig()​

setCustomParam()​

getPhase()​

getVersion()​

addEventListener()​

removeEventListener()​

removeAllEventListener()​

setAdDeduplication()​

clearAdDeduplication()​

findAdDedupManager()​

setHostMeta()​

setForceSafeFrame()​

callNativeBounce()​

setPrivacySettings()​

setContentId()​

setSegmentForABT()​

adSlot​

getter 함수​

setRenderConfig()​

initEvent()​

setCustomParam()​

setApsBidTargeting()​

setPbjsBidTargeting()​

setClickHandler()​

setHostMeta()​

setForceSafeFrame()​

setNativeClickHandler()​

adDeduplicationManager​

displayAds()​

restoreAds()​

gladsdk

`defineAdSlot()`

`hasAdSlot()`

`findAdSlot()`

`displayAd()`

`displayAdWithResponse()`

`setMediationList()`

`destroyAdSlots()`

`refreshAdSlots()`

`setGlobalConfig()`

`getGlobalConfig()`

`setCustomParam()`

`getPhase()`

`getVersion()`

`addEventListener()`

`removeEventListener()`

`removeAllEventListener()`

`setAdDeduplication()`

`clearAdDeduplication()`

`findAdDedupManager()`

`setHostMeta()`

`setForceSafeFrame()`

`callNativeBounce()`

`setPrivacySettings()`

`setContentId()`

`setSegmentForABT()`

adSlot

getter 함수

`setRenderConfig()`

`initEvent()`

`setCustomParam()`

`setApsBidTargeting()`

`setPbjsBidTargeting()`

`setClickHandler()`

`setHostMeta()`

`setForceSafeFrame()`

`setNativeClickHandler()`

adDeduplicationManager

`displayAds()`

`restoreAds()`