CustomAd

커스텀형 광고 객체 입니다.

CustomAd

메서드 요약

메서드
설명

광고의 미디어 스펙 ID 목록을 반환합니다.

광고의 랜딩, 리소스, 값 정보를 반환합니다.

광고의 광고상품, 캠페인, 광고그룹, 광고의 ID를 반환합니다.

광고의 노출 성과를 기록합니다.

광고의 특정 미디어 스펙의 클릭 성과를 기록합니다.


getAvailableMediaSpecIds

getAvailableMediaSpecIds(): string[]

광고의 소재스펙을 구성하고 있는 미디어 스펙 ID 목록을 반환합니다.

예시

nestads.pubAds().addEventListener("loaderResponseReceived", (event) => {
  const customAds = event.customAds
  console.log(customAds[0].getAvailableMediaSpecIds()) // Returns  ['Banner', 'AdText']
});

getAdMeta

getAdMeta(mediaSpecId: string): {landingUrl?: string; landingUrlType?: string; resourceUrl?: string; width?: number; height?: number; value?: string;}

광고의 소재스펙을 구성하고 있는 미디어 스펙 ID 로 랜딩URL, 리소스URL, 텍스트 값 등을 반환합니다.

이 정보를 가지고 원하는 광고 UI를 그릴 수 있습니다.

예시

nestads.pubAds().addEventListener("loaderResponseReceived", (event) => {
  const customAds = event.customAds
  console.log(customAds[0].getAdMeta("Banner")) // Returns {landingUrl: "http://www.wisebirds.co.kr", landingUrlType: "OUTLINK", resourceUrl: "https://static.nestads.com/sample/300x250.png", width: 300, height: 250}

  console.log(customAds[0].getAdMeta("AdText")) // Returns {value: 'We know the way and ready to fly with You, Wisebirds'}

  //Set image url
  document.querySelector("#image").src = customAds[0].getAdMeta("Banner").resourceUrl
});
매개변수
설명

mediaSpecId: string

미디어 스펙 ID

  • 이미지 소재 (IMAGE, PROFILE_IMAGE 타입의 미디어 스펙 )

반환 값
설명

landingUrl?: string

해당 미디어 스펙의 랜딩URL

landingUrlType?: string

해당 미디어 스펙의 랜딩URL 타입

resourceUrl: string

해당 소재의 리소스URL

width: number

해당 소재의 width

height: number

해당 소재의 height

  • 텍스트 소재 (TEXT, CTA_BUTTON, ADBADGE 타입의 미디어 스펙)

반환 값
설명

landingUrl?: string

해당 미디어 스펙의 랜딩URL

landingUrlType?: string

해당 미디어 스펙의 랜딩URL 타입

value: string

해당 소재의 텍스트 값


getAdInfo

getAdInfo(): {adProductId: number; campaignId: number; adGroupId: number; adId: number}

광고의 광고상품, 캠페인, 광고그룹, 광고의 ID를 반환합니다.


recordImpression

async recordImpression(): Promise<void>

광고의 노출 성과를 기록합니다. 소재스펙 메뉴의 성과 필드 매핑 > 노출수와 매핑된 미디어 스펙의 뷰가 노출되면 호출합니다.


performClick

async performClick(mediaSpecId: string): Promise<void>

광고 미디어 스펙의 클릭 성과를 기록합니다. 소재스펙 메뉴의 성과 필드 매핑 > 클릭수/행동유도 클릭수와 매핑된 미디어 스펙의 뷰가 클릭되면 호출합니다.

Last updated