Rest API

API를 통해 배너 및 네이티브 유닛을 연동하실 수 있습니다.

• API 응답(Response)에 포함된 광고 소재 정보를 기반으로, 앱 또는 웹 지면에 직접 렌더링해 적용해주시면 됩니다.

1

엔드포인트

다음 기본 엔드포인트를 사용할 수 있습니다:

• https://api-v2.adrop.io

2

App key Setup

• 앱 키를 누구에게도 공유하지 마세요.

• GET /request엔드포인트에는 앱 키가 필요합니다. 앱 키 생성에 대해서는 이 페이지를 참조하세요.

3

테마 설정(다크 모드)

• 소재의 다크 모드가 정상적으로 표시되기 위해서는 테마 설정이 필요합니다.

• 앱/웹 환경에서 다크 모드가 적용된 소재를 확인하시려면 해당 테마 설정을 반드시 진행해주셔야 합니다.

Web

Rest API로 요청하는 경우 파라미터에 theme를 추가해서 요청하시면 됩니다.

const theme = 'light' // light : 라이트 모드, dark : 다크 모드
const appKey = 'YOUR_APP_KEY'
const unitId = 'YOUR_UNIT_ID'
const response = await fetch(`https://api-v2.adrop.io/request?unit=${unitId}&theme=${theme}`, {
    method: 'GET',
    headers: {
        'Authorization': `${appKey}`,
        'Content-Type': 'application/json'
    }
})

4

데이터

응답으로부터 수신된 데이터의 광고 필드를 이용하여 배너를 표시할 수 있습니다.

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

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

Parameters

이름	타입	필수 여부	설명
unit	STRING	필수	광고 유닛 ID
uid	STRING	권장 사항 (중요)	개인 식별자
pf	STRING	권장 사항	Platform
lcl	STRING	권장 사항	Locale
theme	STRING	선택	light : 라이트 모드 | dark : 다크 모드
adId	STRING	선택	광고 식별자

Platform

소문자를 사용해주세요.

android	Platform value for Android
ios	Platform value for Apple
web	Platform value for Web

Locale

로케일을 지정하려면 언더바를 사용하여 언어 ID와 지역 지정자를 결합해주세요.

• 예) 영국의 영어 사용자에 대한 로케일 ID : en_GB

• 예2) 미국의 영어 사용자에 대한 로케일 ID : en_US

• 언어 지정자 : 언어를 나타내는 코드입니다. 두 글자로 된 ISO 639-1 표준을 사용합니다.

• 지역 지정자 국가를 나타내는 코드입니다. 두 글자의 대문자 코드인 ISO 3166-1 표준을 사용합니다.

---

Response

이름	타입	필수 여부	설명
code	INT	필수	Adrop Error Code
msg	STRING	필수	Adrop Error Code Message
result	JSON	필수	Ad data

Adrop Error Code 페이지를 참조하세요. 성공적인 응답은 다음과 같이 표시됩니다:

{
    "code": 0,
    "msg": "OK",
    "result" : ...
}

Ad Data

이름	타입	Mandatory	설명
format	STRING	필수	광고 형식
unit	STRING	필수	광고 유닛 ID
ad	STRING	필수	광고 소재
w	INT	필수	Width
h	INT	필수	Height
advertiser	STRING	선택	광고주 Name (only for NativeAd)
icon	URL	선택	광고주 Icon (only for NativeAd)
cover	URL	선택	광고주 Cover (only for NativeAd)
advertiserURL	URL	선택	광고주 URL (only for NativeAd)
headline	STRING	선택	헤드라인 텍스트 (only for NativeAd)
body	STRING	선택	본문 텍스트 (only for NativeAd)
callToAction	STRING	선택	CTA 버튼 텍스트 (only for NativeAd)
destinationURL	URL	선택	도착 URL (only for NativeAd)
accountTag	JSON	선택	퍼블리셔가 추가한 Account tag 데이터(only for NativeAd)
creativeTag	JSON	선택	퍼블리셔가 추가한 Creative tag 데이터 (only for NativeAd)

Ad Format

banner	Ad format value for banner
nativeAd	Ad format value for NativeAd

Ad Creative

banner	HTML format response
nativeAd	HTML format response