SSP ( Supply-Side Platform ) Banner AD. Delivery API

5 분 소요

Geonjin Mun

REQUEST

Publisher SSP

TARGETPICK 제휴 DSP(외부 광고) API로써, TARGETPICK noad 발생 시 호출하여 F/R 상승에 도움이 됩니다.

HTTP GET 방식으로 아래 정의된 객체를 작성해 SSP 인터페이스를 호출합니다.

도메인 정보

구분 URL
테스트 http://211.62.152.217
상용 http://ssp.meba.kr

{domain}/ssp.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_banner_w={banner_w}&i_banner_h={banner_h}&d_app_id={d_app_id}&d_app_name={d_app_name}

SSP호출 조건

구분 error_code use_ssp ad_type
하우스인 경우 0 광고성공 1 ssp 사용 4 하우스 광고
광고물량 소진 5 광고소진 1 ssp 사용 *

SSP 조건으로 호출 후 SSP광고가 없으면 하우스 광고를 노출합니다. 광고물량 소진일 경우는 광고없음이나 패스백 처리를 하시면 됩니다.

필드 유형 필수 설명
e_version integer Y 2 : 고정값
a_publisher integer Y 사업자번호 (광고솔루션에서 발급)
a_media integer Y 미디어번호 (광고솔루션에서 발급)
a_section integer Y 섹션번호 (광고솔루션에서 발급)
i_response_format string Y json : 고정값
i_request_id string 권장 광고요청시 Client에서 고유코드를 생성하여 관리
(universally unique identifier, UUID)
d_used_type string Y 사용타입
api : 고정값
i_banner_w integer Y 광고가 노출될 영역 넓이
i_banner_h integer Y 광고가 노출될 영역 높이
필드 유형 필수 설명
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 통신사코드
필드 유형 필수 설명
u_age integer 권장 User 나이
u_gender integer 권장 User 성별 code 코드정의를 참고하세요.
u_ml_id string 권장 User 계정 아이디
m2_ml_email string 권장 User 이메일
u_age_level string Y User 나이 레벨
0: 어린이(만13세 미안)
1:성인 청소년(만13세 이상)
-1:알수없음
u_gps_flag integer 권장 위치 활용 동의 여부
0 : 미활용(Default)
1 : 활용

RESPONSE

SSP Publisher

SSP 는 아래 정의된 객체를 (json)으로 따라 응답합니다.

JSON 형식의 응답 객체입니다.

필드 유형 필수 설명
error_code string Y 에러코드 error 코드정의를 참고하세요.
ad_pd_attr string Y 광고 상품 타입 code 코드정의를 참고하세요.
code_type string Y 2 : 고정값
img_path string N 이미지 url( 미사용 )
landing_url string N 랜딩 url( 미사용 )
width string Y 광고 넓이.
height string Y 광고 높이
bg_color string Y backgroudn color
ssp_imp string Y 노출api전달(예외처리 필수)
dsp_imp string N 트래킹 url(예외처리 필수)
ssp_click string Y click API처리(예외처리 필수)
전달한 ssp_click값의 파라미터 i_request_key값을 저장하여 중복 값 체크
dsp_click string N 클릭 tracking ( 미사용 )
html string N html ( 미사용 )
adm string Y 광고 HTML 소재

{
    "error_code" : "0",
    "ad_pd_attr" : "1",
    "code_type" : "2",
    "img_path" : "http://www.mezzomedia.co.kr",
    "landing_url" : "http://www.mezzomedia.co.kr",
    "width" : "320",
    "height" : "50",
    "bg_color" : "#FFFFFF",
    "ssp_imp" : "http://ssp.meba.kr/sspimp.mezzo/?...",
    "dsp_imp" : "http://...",
    "ssp_click" : "http://ssp.meba.kr/sspclick.mezzo/?...",
    "dsp_click" : "",
    "html"  : "<html>...</html>",
    "adm"   : "<html>...</html>"
}

코드 정의

에러코드

코드 설명
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
3
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

업데이트: