API 네이티브 광고

1

Request Ad

GET /request

응답부터 수신된 데이터 중, adof result필드를 이용하여 네이티브 광고를 표시할 수 있습니다.

배너는 HTML 형식으로 반환되므로 웹 프로젝트에서 직접 렌더링할 수 있습니다.

다른 플랫폼에서는 WebView를 활용할 수 있습니다.

2

Parameters

이름
타입
필수 여부
설명

unit

STRING

필수

광고 유닛 ID

uid

STRING

권장 사항

개별 유저 식별자

pf

STRING

권장 사항

android | ios | web

lcl

STRING

권장 사항

국가/언어 정보

contextId

STRING

문맥 타겟 광고 요청 시 필수

콘솔 타겟팅 메뉴 > 문맥 타겟팅 에서 설정한 아이디로 광고 요청을 보낼때 사용됩니다.

trackMode

INT

선택

소재에 등록된 이미지의 URL을 내려받고, 노출과 클릭 추적을 직접 처리하려고 할 때 사용하는 모드입니다.

값을 1로 설정하는 경우 응답에 asset, pixelTracker, imprTracker, clickTracker 필드가 추가됩니다.

adId

STRING

내 기기에서 보기 광고 요청시 필수

광고 식별자

3

Response

이름
타입
필수 여부
Description

code

INT

필수

msg

STRING

필수

result

STRING

필수

4

Ad Data

이름
타입
필수 여부
설명

id

STRING

cpId

STRING

필수

type

STRING

필수

"display" | "video"

format

STRING

필수

unit

STRING

필수

광고 유닛 ID

w

INT

필수

Width

h

INT

필수

Height

ad

STRING

선택

광고 소재 (trackMode가 1이 아닐 경우)

target

STRING

선택

애드컨트롤 콘솔에서 소재에 설정한 도착 위치 선택 필드입니다. external : 기본 브라우저 선택 internal : 내부 브라우저 선택

headline

STRING

선택

헤드 라인 텍스트

body

STRING

선택

본문 텍스트

callToAction

STRING

선택

CTA 텍스트

destinationURL

URL

선택

도착 URL

extra

JSON

선택

추가 텍스트 항목

key: 콘솔에서 생성한 추가 텍스트의 id

value: 광고주가 입력한 값

asset

URL

선택

(trackMode가 1인 경우) 소재 이미지 URL

pixelTracker

STRING

선택

(trackMode가 1인 경우) 소재 이미지 URL을 사용해서 화면을 구성하는 경우, 노출 집계를 위해서 1 x 1 픽셀의 투명 이미지를 제공합니다. 해당 이미지를 소재와 함께 화면에 배치하면 광고 노출시 자동으로 집계가 가능합니다. pixelTracker 와 imprTracker 중 한 가지 방법만을 사용해서 노출을 집계해야 합니다.

imprTracker

URL

선택

(trackMode가 1인 경우) 노출을 직접 추적하기 위한 URL입니다. 사용자에게 광고가 노출되었을때 해당 URL을 호출해주어야 정상적으로 노출이 집계됩니다. pixelTracker 와 imprTracker 중 한 가지 방법만을 사용해서 노출을 집계해야 합니다.

clickTracker

URL

선택

(trackMode가 1인 경우) 클릭을 직접 추적하기 위한 URL입니다. 사용자가 광고를 클릭했을 때 해당 URL을 호출해주어야 정상적으로 클릭이 집계됩니다.

profile

JSON

선택

광고유닛에 광고주 프로필을 받도록 설정했을때, 광고주가 소재 등록시 등록한 정보입니다.

displayLogo: 광고주가 업로드한 정사각형 로고

displayName: 광고주가 입력한 이름

link: 광고주가 입력한 링크

5

Example

아래 코드 스니펫에서 생성한 유닛 ID로 코드를 변경해주세요.

혹은 Adrop의 test_유닛ID를 대신해서 테스트 할 수 있습니다.

GET /request?unit={unit_id}&uid={user_id}&pf={platform}&lcl={locale} HTTP/1.1
Host: api-v2.adrop.io
Authorization: {app_key}
{
    "code": 0,
    "msg": "OK",
    "result": {
        "format": "nativeAd",
        "unit": "unit_id",    
        "ad": "...",
        "advertiser": "..."
    }
}

Last updated