nestads

API에 사용하는 전역 네임스페이스입니다.

변수 요약

변수	설명
apiReady	NestAds API가 로드되어 호출할 준비가 되었음을 나타내는 플래그입니다.
cmd	NestAds 관련 호출의 비동기 실행을 위한 전역 명령 큐입니다.
pubAdsReady	PubAdsService가 사용 설정되어 로드되어 완전히 작동함을 나타내는 플래그입니다.

함수 요약

함수	설명
defineSlot	광고 게재위치 코드 및 크기를 가진 광고 슬롯을 만들어 광고가 포함될 페이지의 div 엘리먼트 ID와 연결합니다. divId 를 설정하지 않으면 body 영역 하위로 광고가 그려집니다.
destroySlots	지정된 슬롯을 폐기하여 NestAds에서 해당 슬롯과 관련된 모든 객체와 참조를 제거합니다.
display	지정된 슬롯에 광고를 요청하고 응답을 받으면 그려줍니다.
load	지정된 슬롯에 광고를 요청합니다.
show	지정된 슬롯에 광고를 그려줍니다.
dismiss	지정된 슬롯에 광고를 표시를 중지합니다. (단순 display 설정 변경)
enableServices	페이지의 광고 슬롯에 정의된 모든 NestAds 서비스를 사용 설정합니다.
getVersion	NestAds의 현재 버전을 반환합니다.
pubAds	PubAdsService 참조를 반환합니다.
setAdIframeTitle	이 시점부터 PubAdsService에서 생성된 모든 광고 컨테이너 iframe의 제목을 설정합니다.

---

nestads.apiReady

apiReady: boolean | undefined

NestAds SDK가 로드되어 API 호출할 준비가 되었음을 나타내는 플래그입니다. 로드가 완료되기 전까지는 해당 값은 undefiend입니다.

NestAds API를 안전하게 사용할 수 있는지 확인하기 위해 이 값을 사용하기 보다는 NestAds가 준비 되었을 때 콜백을 큐에 추가하는 nestads.cmd를 사용하는 것을 추천합니다. 해당 큐를 이용했을 경우 실행이 보장되므로 nestads.apiReady를 확인할 필요가 없습니다.

예시

if (window.nestads && nestads.apiReady) {
  // NestAds API can be called safely
}

---

nestads.cmd

cmd: Array<(this: typeof globalThis) => void> | CommandArray

비동기 실행을 위한 전역 명령 큐입니다.

NestAds가 로드 되기 전 nestads.cmd는 배열로 초기화 됩니다. 표준 Array.push 메서드와 같은 cmd.push를 통해 명령어를 추가해줍니다.

NestAds가 로드 되면 nestads.cmd 배열을 확인하고 함수를 순차적으로 실행시킵니다. 이 후 cmd 를 CommandArray 로 대체 합니다.

예시

nestads.cmd.push(() => {
  nestads.defineSlot(`${placementCode}`, [160, 600], `${divId}`).addService(nestads.pubAds());
});

---

nestads.pubAdsReady

pubAdsReady: boolean | undefined

PubAdsService 가 사용 설정되어 로드되어 완전히 작동함을 나타내는 플래그입니다. 이 속성은 enableServices 가 호출되고 PubAdsService 가 로드되고 초기화될 때까지 undefined 입니다.

---

nestads.defineSlot

defineSlot(placementCode: string, size: [number, number] | "FLUID", divId?: string): Slot | null

게재위치 코드 및 크기를 가진 광고 슬롯을 만들어 광고가 포함될 페이지 div ID와 연결합니다.

divId 를 설정하지 않으면 body 영역 하위로 광고가 그려집니다.

예시

nestads.defineSlot(`${placementCode}`, [728, 90], `${divId}`);

매개변수	설명
placementCode: string	광고의 게재위치 코드
size: [number, number] | "FLUID"	광고 요청에 사용되는 크기 고정 크기:[width, height] 변동 크기: "FLUID" 변동 크기로 설정하는 경우 부모 요소의 width 100% 를 차지하고, 소재의 비율에 맞게 그려집니다. 주의) 변동 크기는 현재 프리미엄 배너 광고의 Mobile 전용 레이아웃에서만 동작합니다.
divId?: string	광고 단위가 포함될 div의 ID 설정하지 않으면 body 영역 하위로 광고 생성

반환 값	설명
Slot | null	새로 생성된 슬롯 또는 슬롯을 만들 수 없는 경우 null

---

nestads.destroySlots

destroySlots(slots?: Slot[]): boolean

NestAds에서 해당 슬롯과 관련된 모든 객체와 참조를 제거합니다.

예시

const slot1 = nestads.defineSlot(`${placementCode}`, [728, 90], `${divId}`);
nestads.display(`${divId}`);

// slot1 을 제거합니다.
nestads.destroySlots([slot1]);

// 정의된 모든 slot을 제거합니다.
nestads.destroySlots();

매개변수	설명
slots?: Slot[]	제거할 슬롯의 배열이 있으면 해당 배열만 삭제 매개변수가 없으면 모든 슬롯 삭제

반환 값	설명
boolean	슬롯이 소멸된 경우 true, 그렇지 않은 경우 false

---

nestads.defineLoader

defineLoader(placementCode: string, creativeSpecIds: number[]): Loader

게재위치 코드 및 소재스펙 ID 를 넣어 광고 로더를 정의합니다. 해당 게재위치와 연결된 광고 중 해당 소재스펙 ID 에 맞는 광고를 요청할 수 있습니다.

예시

nestads.defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...]);

매개변수	설명
placementCode: string	광고의 게재위치 코드
creativeSpecIds: number[]	광고의 소재스펙 ID

반환 값	설명
Loader	새로 생성된 로더

---

nestads.display

display(divOrSlot: string | Element | Slot): void

슬롯에 광고를 요청하고 렌더링 합니다. 슬롯이 정의되고 연결된 서비스가 있어야 동작합니다.

예시

nestads.cmd.push(() => {
  // divId 가 있을 때
  nestads.display("div-1");

  // slot 으로 요청할 때
  const slot1 = nestads.defineSlot(`${placementCode}`, [300, 300]).addService(nestads.pubAds());
  nestads.display(slot1);
});

매개변수	설명
divOrSlot: string | Element | Slot	광고를 게재할 슬롯. 광고 슬롯으로 정의된 div의 ID 혹은 광고 슬롯으로 정의된 div element 혹은 Slot 객체

---

nestads.load

load(divOrSlot: string | Element | Slot): void

슬롯에 광고를 요청합니다. 슬롯이 정의되고 연결된 서비스가 있어야 동작합니다.

load 를 호출한 뒤 show를 호출하지 않으면 광고가 보이지 않습니다.

요청과 렌더링이 다른 시점에 필요한 경우 사용합니다.

예시

nestads.cmd.push(() => {
 // divId 가 있을 때
  nestads.load("div-1");

  // slot 으로 요청할 때
  const slot1 = nestads.defineSlot(`${placementCode}`, [300, 300]).addService(nestads.pubAds());
  nestads.load(slot1);
});

매개변수	설명
divOrSlot: string | Element | Slot	광고를 게재할 슬롯. 광고 슬롯으로 정의된 div의 ID 혹은 광고 슬롯으로 정의된 div element 혹은 Slot 객체

---

nestads.show

show(divOrSlot: string | Element | Slot): void

슬롯에 광고를 렌더링 합니다. 슬롯이 정의되고 연결된 서비스가 있어야하며 show 이전에 load 를 불러줘야 동작합니다.

요청과 렌더링이 다른 시점에 필요한 경우 사용합니다.

예시

nestads.cmd.push(() => {
   // divId 가 있을 때
  nestads.show("div-1");

  // slot 으로 요청할 때
  const slot1 = nestads.defineSlot(`${placementCode}`, [300, 300]).addService(nestads.pubAds());
  nestads.load(slot1); // 광고 요청
  nestads.show(slot1); // 광고 표시
});

매개변수	설명
divOrSlot: string | Element | Slot	광고를 게재할 슬롯. 광고 슬롯으로 정의된 div의 ID 혹은 광고 슬롯으로 정의된 div element 혹은 Slot 객체

---

nestads.dismiss

dismiss(divOrSlot: string | Element | Slot): void

지정된 슬롯에 광고를 표시를 중지합니다.

예시

nestads.cmd.push(() => {
  const slot1 = nestads.defineSlot(`${placementCode}`, [300, 300]).addService(nestads.pubAds());
  nestads.load(slot1); // 광고 요청
  nestads.show(slot1); // 광고 표시

  // 3초의 시간이 지나면 닫기
  setTimeout(()=> {
    nestads.dismiss(slot1);
  }, 3000)
});

매개변수	설명
divOrSlot: string | Element | Slot	광고를 게재할 슬롯. 광고 슬롯으로 정의된 div의 ID 혹은 광고 슬롯으로 정의된 div element 혹은 Slot 객체

---

nestads.enableServices

enableServices(): void

PubAdsService를 사용할 수 있도록 설정합니다.

---

nestads.getVersion

getVersion(): string

NestAds SDK 현재 버전을 반환합니다.

---

nestads.pubAds

pubAds(): PubAdsService

PubAdsService를 반환합니다.

반환 값
PubAdsService	광고 서비스

---

nestads.setAdIframeTitle

setAdIframeTitle(title: string): void

PubAdsService에서 생성된 모든 광고 컨테이너 iframe의 제목을 설정합니다.

예시

nestads.setAdIframeTitle("title");

매개변수	설명
title: string	모든 광고 컨테이너 iframe의 새로운 제목