실시간 애드리스트 API

애드리스트에서는 RESTful API를 통해 실시간 광고목록을 제공합니다. 모든 API는 JSON 형태의 응답형식을 갖습니다. 애드리스트 API를 이용하여 데이터를 수집하려면 고유 API 키가 필요합니다

고유 API 키

제휴사만 사용 가능합니다. 제휴사임에도 키가 보이지 않는다면 로그인 해주세요

실시간 앱 광고 목록 불러오기

다음은 실시간 광고집행/광고노출 중인 앱 혹은 웹사이트 목록을 불러오는 방법입니다

메서드 요청 URL 파라미터 파라미터 예 응답 예
POST https://adlist.co.kr/api/app api_key :
{API 키}
package_name :
{패키지명}
start :
{조회시작시각}
end :
{조회종료시각}
api_key :
"bZGicHRl0G"
package_name : ""com.gau.go.launcherex.gowidget.weatherwidget"
start :
"2018-01-06"
end :
"2018-02-13"
성공시
{
"result": "success",
"dsp": [{
"insert_time": "2018-01-06T17:01:13.000Z",
"ad_network_name": "admob",
"ad_network_type": "medium_rectangle",
"ad_link_type": "deeplink",
"ad_deeplink": "market://details%253Fid%253Dcom.gau.go.launcherex.gowidget.weatherwidget",
"app_name": "투명 시계 및 날씨",
"ad_app_name": "GO날씨 예보/ 날씨 위젯/ 예쁜 테마/ 라이브배경",
"package_name": "com.droid27.transparentclockweather",
"ad_package_name": "com.gau.go.launcherex.gowidget.weatherwidget",
"video_path": null,
"image_path": "http://adlist.co.kr/imgs/com.droid27.transparentclockweather/images/medium_rectangle/1515258073700.png"
},
{
"insert_time": "2018-01-13T22:15:22.000Z",
"ad_network_name": "admob",
"ad_network_type": "large_banner",
"ad_link_type": "deeplink",
"ad_deeplink": "market://details%253Fid%253Dcom.gau.go.launcherex.gowidget.weatherwidget",
"app_name": "정확한 나침반",
"ad_app_name": "GO날씨 예보/ 날씨 위젯/ 예쁜 테마/ 라이브배경",
"package_name": "app.melon.icompass",
"ad_package_name": "com.gau.go.launcherex.gowidget.weatherwidget",
"video_path": null,
"image_path": "http://adlist.co.kr/imgs/app.melon.icompass/images/large_banner/1515881642481.png"
}
],
"ssp": [{
"insert_time": "2018-01-12T13:15:16.000Z",
"ad_network_name": "vungle",
"ad_network_type": "video",
"ad_link_type": "deeplink",
"ad_deeplink": "https://play.google.com/store/apps/details?id=com.droidhang.ad&hl=en",
"app_name": "GO날씨 예보/ 날씨 위젯/ 예쁜 테마/ 라이브배경",
"ad_app_name": "Idle Heroes",
"package_name": "com.gau.go.launcherex.gowidget.weatherwidget",
"ad_package_name": "com.droidhang.ad",
"video_path": "https://cdn-lb.vungle.com/zen/zbup_cml_720x1280-540x960-Q2.mp4",
"image_path": null
},
{
"insert_time": "2018-01-12T14:16:13.000Z",
"ad_network_name": "vungle",
"ad_network_type": "video",
"ad_link_type": "deeplink",
"ad_deeplink": "https://play.google.com/store/apps/details?id=com.droidhang.ad&hl=en",
"app_name": "GO날씨 예보/ 날씨 위젯/ 예쁜 테마/ 라이브배경",
"ad_app_name": "Idle Heroes",
"package_name": "com.gau.go.launcherex.gowidget.weatherwidget",
"ad_package_name": "com.droidhang.ad",
"video_path": "https://cdn-lb.vungle.com/zen/CR_shengji_cm_en_1280x720_1-1280x720-Q2.mp4",
"image_path": null
}]
                                                 


실패시
{
"result": "fail",
"reason": "일치하는 API 키가 없습니다."
}

파라미터

다음은 POST 요청시 필요한 파라미터에 관한 설명입니다

파라미터명 데이터 타입 예시 설명
package_name STRING com.chbreeze.jikbang4a 플레이스토어에 등록된 앱 패키지명입니다
api_key STRING bZGicHRl0G 제휴사 가입시 발급받은 고유키. http://adlist.co.kr/api에서 확인 가능합니다
start STRING 2018-03-01
2018-03-01 10:20:43
죄회 시작일. YYYY-MM-dd 및 YYYY-MM-dd hh:mm:ss 형식을 지원합니다
end STRING 2018-04-01
2018-04-01 07:00:10
죄회 종료일. YYYY-MM-dd 및 YYYY-MM-dd hh:mm:ss 형식 지원합니다

응답 (JSON)

다음은 응답 받은 JSON 데이터에 관한 설명입니다

반환키 반환값 타입 예시 설명
result STRING 1. success
2. fail
요청 결과 성공시 "success", 실패시 "fail"을 반환합니다
dsp ARRAY dsp : [{...}, {...}] "이 앱을 광고한 앱"에 관한 앱리스트 배열을 반환합니다.
ssp ARRAY ssp : [{...}, {...}] "이 앱이 광고한 앱"에 관한 앱리스트 배열을 반환합니다
insert_time TIMESTAMP 2018-01-01T08:17:11.000Z 광고가 포착된 시각.
ad_network_name STRING admob 해당 광고 애드네트워크명. (2018년 3월 기준) 애드리스트는 admob, adpopcorn, adlib, tapjoy, unity, mobvista, vungle, mopub, inmobi, applovin, chartboost, cauly 지원 중 (향후 지속적 업데이트 예정)
ad_network_type STRING banner, large_banner, video, interstitial_video, offerwall 애드네트워크별 광고 타입. (애드네트워크별로 타입이 다양함).
ad_link_type STRING url, deeplink 광고 링크 타입. "url" 혹은 "deeplink"로 반환합니다
ad_url STRING http://facebook.com 광고 링크 타입이 "url"일 경우 해당 url 주소
ad_deeplink STRING https://play.google.com/store/apps/details?id=com.exovoid.weather.app 광고 링크 타입이 "deeplink"일 경우 해당 마켓 주소
package_name STRING or NULL com.exovoid.weather.app dsp의 경우 조회한 앱을 광고한 앱의 패키지명. ssp의 경우 조회한 앱의 광고한 앱의 패키지명. 웹사이트이거나 데이터가 없을 시 null 반환
ad_package_name STRING or NULL com.exovoid.weather.app dsp의 경우 조회한 앱의 패키지명. ssp의 경우 조회한 앱이 광고한 앱의 패키지명. 웹사이트이거나 데이터가 없을 시 null 반환
app_name STRING or NULL 정확한 나침반 package_name의 앱명. 해당 패키지에 대한 정보가 없을 경우 null 반환
ad_app_name STRING or NULL 정확한 나침반 ad_package_name의 앱명. 해당 패키지에 대한 정보가 없을 경우 null 반환
video_path STRING or NULL https://cdn-lb.vungle.com/zen/CR_shengji_cm_en_1280x720_1-1280x720-Q2.mp4 ad_network_type이 비디오 형식일 경우 해당 비디오 URL. 데이터가 없을 경우 null 반환
image_path STRING or NULL http://adlist.co.kr/imgs/com.droid27.transparentclockweather/images/large_banner/1514794590901.png ad_network_type이 이미지 형식일 경우 해당 이미지 URL. 데이터가 없을 경우 null 반환

예제 소스


$.post('https://adlist.co.kr/api/app', {api_key:"bZGicHRl0G", package_name :"com.chbreeze.jikbang4a", start:"2018-03-01", end:"2018-03-10"},
    function(returnedData){
         console.log(returnedData);
});