Banner AD. Delivery API
insu Keum
REQUEST
Publisher, SSP TARGETPICK
TARGETPICK 자체 광고 API로써, 물량 소진 시 noad가 발생 됩니다.
HTTP GET 방식으로 아래 정의된 객체를 작성해 TARGETPICK 인터페이스를 호출합니다.
도메인 정보
| 구분 | URL |
|---|---|
| 테스트 | http://211.62.152.216:3400 |
| 상용 | http://mtag.mman.kr |
{domain}/get_ad.mezzo/?e_version=2&a_publisher={publisher_code}&a_media={media_code}&a_section={section_code}&i_response_format=json&d_used_type=api&i_rich_flag={rich_flag}&d_app_id={d_app_id}&d_app_name={d_app_name}
기본 객체
| 필드 | 유형 | 필수 | 설명 |
|---|---|---|---|
| e_version | integer | Y | 2 : 고정값 |
| a_publisher | integer | Y | 사업자번호 (광고솔루션에서 발급) |
| a_media | integer | Y | 미디어번호 (광고솔루션에서 발급) |
| a_section | integer | Y | 섹션번호 (광고솔루션에서 발급) |
| i_response_format | string | Y | code 코드정의를 참고하세요. (미전달시 json) |
| i_request_id | string | 권장 | 광고요청시 Client에서 고유코드를 생성하여 관리 (universally unique identifier, UUID) |
| i_rich_flag | integer | Y | 1: 이미지방식 사용시, 0: html방식 사용시 |
| d_used_type | string | Y | 사용타입 api : 고정값 |
| keyword | string | 권장 | 키워드값 전달 구분자는 ^로 사용 keyword값은 인코딩 |
디바이스 정보
| 필드 | 유형 | 필수 | 설명 |
|---|---|---|---|
| d_adid | string | Y | Android : Google AdvertiseID iOS : IDFA |
| d_os_index | integer | Y | 2 : iOS, 3 : Android |
| d_os | string | 권장 | 디바이스 OS명 ex) Android, iPad, iPhone.. |
| d_osv | string | Y | 디바이스 OS버전 ex) 7.0, 8.0 |
| d_app_id | string | Y | App패키지코드 |
| d_app_ver | string | 권장 | App 버전 |
| d_app_name | string | Y | App 명 |
| d_geo_lat | float | 권장 | u_gps_flag : 위치 활용 동의 상태시 전달 |
| d_geo_lon | float | 권장 | u_gps_flag : 위치 활용 동의 상태시 전달 |
| d_screen | int | 권장 | 미전달시 스마트폰/PC는 User Agent를 이용하여 구분 code 코드정의를 참고하세요. |
| d_maker | string | 권장 | 디바이스 제조사 |
| d_model | string | 권장 | 디바이스 모델명 |
| d_network_index | integer | 권장 | code 코드정의를 참고하세요. |
| d_network | string | 권장 | 디바이스 네트워크 상태명 |
| d_carrier | string | 권장 | 디바이스 통신사명 |
| d_w | integer | 권장 | 디바이스 가로사이즈 |
| d_h | integer | 권장 | 디바이스 세로사이즈 |
| d_densty | integer | 권장 | 디바이스 Densty |
| d_orientation | integer | 권장 | code 코드정의를 참고하세요. |
| d_language | string | 권장 | 디바이스 언어코드 ex) ko, en… |
| d_mcc | integer | 권장 | USIM 국가코드 |
| d_mnc | integer | 권장 | USIM 통신사코드 |
| ua | string | Y | 요청한 사용자의 userAgent(인코딩 필요) |
| ip | string | Y | 요청한 사용자의 ip |
사용자 정보
| 필드 | 유형 | 필수 | 설명 |
|---|---|---|---|
| u_age | integer | 권장 | User 나이 |
| u_gender | integer | 권장 | User 성별 code 코드정의를 참고하세요. |
| u_ml_id | string | 권장 | User 계정 아이디 |
| m2_ml_email | string | 권장 | User 이메일 |
| u_age_level | integer | 권장 | User 나이 레벨 0: 어린이(만13세 미만) 1:성인 청소년(만13세 이상) -1:알수없음 |
| u_gps_flag | integer | 권장 | 위치 활용 동의 여부 0 : 미활용(Default) 1 : 활용 |
RESPONSE
TARGETPICK Publisher
TARGETPICK 는 아래 정의된 객체를 요청 타입(json/xml) 에 따라 응답합니다.
ADS Info
JSON/XML 형식의 응답 객체입니다.
| 필드 | 유형 | 필수 | 설명 |
|---|---|---|---|
| version | string | Y | 2 : TARGETPICK 광고 버전 |
| error_code | string | Y | 에러코드 error 코드정의를 참고하세요. |
| rotatetime | string | Y | 광고 재요청 시간(초) |
| request_id | string | Y | 광고 요청 고유코드 (요청시 전달한 request_id) |
| ad_type | string | Y | 광고 유형 code 코드정의를 참고하세요. |
| product_type | string | Y | 광고 상품 구분 code 코드정의를 참고하세요. |
| product_attr | string | Y | 광고 상품 타입 code 코드정의를 참고하세요. |
| product | string | Y | 광고 상품 코드 code 코드정의를 참고하세요. |
| ad_count | string | Y | ad[Array] 광고 갯수 |
| ad | object | Y | ad 객체를 참고하십시오. |
ad
| 필드 | 유형 | 필수 | 설명 |
|---|---|---|---|
| cmp_no | string | Y | 캠페인 번호 |
| ad_group_no | string | Y | 애즈그룹 번호 |
| ad_no | string | Y | 애즈 번호 |
| img_path | string | Y | 광고 이미지 소재 URL |
| img_name | string | Y | 광고 이미지 소재 파일명 |
| click_option | string | Y | 클릭 옵션 |
| click_action_type | string | Y | 클릭 액션 타입 code 코드정의를 참고하세요. 앱일 경우 click_action_type이 3이면 스토어로 이동시켜야 합니다.( 크롬브라우져 이동 시 가능 ) |
| landing_url | string | Y | 광고주 랜딩 정보 |
| bg_color | string | Y | 백그라운드 색상표 ex) #ffffff |
| width | string | Y | 광고 이미지 소재 넓이 |
| height | string | Y | 광고 이미지 소재 높이 |
| end_datetime | string | Y | 광고 송출 가능 시간 0 : 광고 기간 무제한 , N:(end_datetime)_unix timestamp |
| impression_api | string | Y | 노출 트래킹 API (광고 노출 시점 해당 API를 전달) |
| click_api | string | Y | 클릭 API (광고 클릭 시점 해당 API를 전달 - landing_url로 리다이렉트) |
| click_tracking_api | string | Y | 클릭 트래킹 API (광고 클릭 시점 해당 API를 전달) |
| html | string | Y | 광고 HTML소재 (광고정보를 HTML방식으로 제공 - 노출/클릭 API포함) |
| logo_img_path | string | Y | Opt in/out에 사용될 이미지 |
| logo_landing_url | string | Y | logo_img_path를 클랙 했을때 이동할 경로 [adid]를 아래 아이디로 치환 Android : Google AdvertiseID iOS : IDFA web : 빈값 |
response 예제 (JSON)
{
"adsinfo": {
"version": "2",
"error_code": "0",
"rotatetime": "60",
"request_id": "-",
"ad_type": "1",
"product_type": "1",
"product_attr": "1",
"product": "1",
"ad_count": "1",
"ad": [{
"cmp_no": "9",
"ad_group_no": "121",
"ad_no": "13",
"img_path": "http://advimg.ad-mapps.com/ad_images/hongcho_20150801_640x100.jpg",
"img_name": "홈플러스 띠배너",
"click_option": "2",
"click_action_type": "3",
"landing_url": "http://naver.com",
"bg_color": "#222222",
"logo_img_path": "로고 이미지 경로",
"logo_landing_url": "opt in/out 경로",
"width": "320",
"height": "50",
"end_datetime": "1441033199",
"impression_api": "http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2",
"click_api": "http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=click&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2",
"click_tracking_api": "http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=click_tracking&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2",
"html": "<html><head><meta name='viewport' content='width=device-width; height=device-height;'><title></title></head><body style='margin:0px;'><style type='text/css'> #mz_first {position:absolute; left:0; top:0};</style><link href='http://advimg.ad-mapps.com/ad_images/r_main_50.css' rel='stylesheet' type='text/css' /><div id='mz_wrap' style='text-align:center;background-color:#222222; margin:0 auto; padding:0; text-decoration: none; width:100%;'><article id='mz_article' style='height:50px; margin:0 auto; overflow:hidden; position:relative; width:px;'><a href='http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=click&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2' target='_blank'><img id='mz_first' src='http://advimg.ad-mapps.com/ad_images/hongcho_20150801_640x100.jpg' width='320' height='50'><img id='mz_logo' style='right:2px; top:28px; position:absolute; text-align:right; width:23px; height:20px;' src='http://advimg.ad-mapps.com/ad_images/man_logo.png' alt=''/></a><div id='mz_beacon' style='position:absolute; left:0px; top:0px; visibility:hidden;'><img src='http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2'></div></article></div></body></html>"
}]
}
}
response 예제 (XML)
<?xml version="1.0" encoding="UTF-8"?>
<adsinfo>
<version>
<![CDATA[2]]>
</version>
<error_code>
<![CDATA[0]]>
</error_code>
<rotatetime>
<![CDATA[60]]>
</rotatetime>
<request_id>
<![CDATA[-]]>
</request_id>
<ad_type>
<![CDATA[1]]>
</ad_type>
<product_type>
<![CDATA[1]]>
</product_type>
<product_attr>
<![CDATA[1]]>
</product_attr>
<product>
<![CDATA[1]]>
</product>
<ad_count>
<![CDATA[1]]>
</ad_count>
<ad>
<cmp_no>
<![CDATA[9]]>
</cmp_no>
<ad_group_no>
<![CDATA[121]]>
</ad_group_no>
<img_path>
<![CDATA[http://advimg.ad-mapps.com/ad_images/hongcho_20150801_640x100.jpg]]>
</img_path>
<img_name>
<![CDATA[홈플러스 띠배너]]>
</img_name>
<click_option>
<![CDATA[2]]>
</click_option>
<click_action_type>
<![CDATA[3]]>
</click_action_type>
<landing_url>
<![CDATA[http://naver.com]]>
</landing_url>
<logo_img_path>로고 이미지 경로</logo_img_path>
<logo_landing_url>opt in/out 페이지 경로</logo_landing_url>
<bg_color>
<![CDATA[#222222]]>
</bg_color>
<width>
<![CDATA[320]]>
</width>
<height>
<![CDATA[50]]>
</height>
<end_datetime>
<![CDATA[1441033199]]>
</end_datetime>
<impression_api>
<![CDATA[http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2]]>
</impression_api>
<click_api>
<![CDATA[http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=click&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2]]>
</click_api>
<click_tracking_api>
<![CDATA[http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=click_tracking&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2]]>
</click_tracking_api>
<html>
<![CDATA[<html><head><meta name='viewport' content='width=device-width; height=device-height;'><title></title></head><body style='margin:0px;'><style type='text/css'> #mz_first {position:absolute; left:0; top:0};</style><link href='http://advimg.ad-mapps.com/ad_images/r_main_50.css' rel='stylesheet' type='text/css' /><div id='mz_wrap' style='text-align:center;background-color:#222222; margin:0 auto; padding:0; text-decoration: none; width:100%;'><article id='mz_article' style='height:50px; margin:0 auto; overflow:hidden; position:relative; width:px;'><a href='http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=click&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2' target='_blank'><img id='mz_first' src='http://advimg.ad-mapps.com/ad_images/hongcho_20150801_640x100.jpg' width='320' height='50'><img id='mz_logo' style='right:2px; top:28px; position:absolute; text-align:right; width:23px; height:20px;' src='http://advimg.ad-mapps.com/ad_images/man_logo.png' alt=''/></a><div id='mz_beacon' style='position:absolute; left:0px; top:0px; visibility:hidden;'><img src='http://211.62.152.216:3400/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&i_request_key=e8031cf3-4cdb-4ff8-b733-589e55736129$1226230008$ESFSVVWN&t_ver=2'></div></article></div></body></html>]]>
</html>
</ad>
</adsinfo>
코드 정의
에러코드
| 코드 | 설명 |
|---|---|
| 2 | 잘못된 광고 요청 |
| 3 | 잘못된 파라미터 정보 전달 |
| 4 | 광고 솔루션에서 발급 한 사업자/미디어/섹션 코드 미존재 |
| 5 | 광고없음 |
| 97 | 잘못된 트래킹 Request Key 정보(로직은 진행 됨) |
| 98 | 잘못된 트래킹 정보 |
| 99 | 광고 서버 에러 |
광고코드
| 필드 | 코드 | 설명 |
|---|---|---|
| i_response_format | json xml |
JSON 응답 포멧 XML 응답 포맷 |
| i_product_type / product_type | 1 2 3 |
배너 동영상 Native |
| i_product_attr / product_attr | 1 2 4 6 10 |
띠배너 전면/종료배너 동영상 정사각형 및 직사각형 Native |
| i_product / product | 1 2 3 4 9 10 11 12 14 19 20 30 31 44 68 69 70 71 |
배너320x50 전면배너750x1200 종료배너750x1200 동영상 띠배너320x100 CJ Enm동영상 네이버배너640x240 배너640x100 전면배너640x960 종료배너640x960 배너300x250 전면동영상 범퍼동영상 인라인직사각형300x250 Native_전면배너_이미지 Native_전면배너_동영상 Native_띠배너_이미지 Native_띠배너_동영상 |
| d_screen | 1 3 4 5 |
스마트폰, 태블릿 데스크탑 TV DOOH |
| d_network_index | d_network_index 코드정의를 참고하세요. | 네트워크 타입 |
| d_orientation | 1 2 |
세로 가로 |
| d_mcc / d_mnc | USIM 국가/통신사 코드 | USIM 국가/통신사 코드 |
| d_os_index | 2 3 |
iOS Android |
| u_gender | 2 3 |
남성 여성 |
| click_action_type | 0 3 5 |
Web Link Store Link Tel Link |
| ad_type | 1 2 3 4 5 6 |
보장형 경매형 비과금 하우스 리워드 기간제 |
d_network_index code
| Code | Android | iOS |
|---|---|---|
| Unknown | 0 | 0 |
| Internet | 1 | 1 |
| WIFI | 2 | 2 |
| Cellular Network - 2G | 4, 7, 11 | 4 |
| Cellular Network - 3G | 3, 5, 6, 8, 9, 10, 12, 14, 15 | 5 |
| Cellular Network - 4G | 13 | 6 |
| Cellular Network - 5G | 20 | 7 |
| Cellular Network - Unknown Generation | 0 | 3 |