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

5 minute read

Chansup Yang

REQUEST

Publisher SSP

As a TARGETPICK affiliated DSP (external advertising) API, it is called when a TARGETPICK noad occurs to help increase F / R.

Creates an object defined below in the HTTP GET method to call the SSP interface.

Domain info

Division URL
test http://211.62.152.217
real 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 request condition

division error_code use_ssp ad_type
house AD (non-charged) 0 AD success 1 use ssp 4 house AD (non-charged AD)
AD run out 5 No AD 1 use ssp *

If there are no SSP ads after calling under SSP conditions, expose the house ads. When NOAD is on, you can implement a passback.

Field Type Required Description
e_version integer Y 2 : fixed value
a_publisher integer Y publisher code (issued by TARGETPICK)
a_media integer Y media code (issued by TARGETPICK)
a_section integer Y section code (issued by TARGETPICK)
i_response_format string Y json : fixed value
i_request_id string recommended Publisher creates and manages unique code when requesting advertising
(universally unique identifier, UUID)
d_used_type string Y used type
api : fixed value
i_banner_w integer Y width size of ad area
i_banner_h integer Y height size of ad area
Field Type Required Description
d_adid string Y Android : Google AdvertiseID
iOS : IDFA
d_os_index integer Y 2 : iOS, 3 : Android
d_os string recommended device OS name
ex) Android, iPad, iPhone..
d_osv string Y device OS version
ex) 7.0, 8.0
d_app_id string Y app package code
d_app_ver string recommended app version
d_app_name string Y app name
d_geo_lat float recommended u_gps_flag : when GPS use agreed
d_geo_lon float recommended u_gps_flag : when GPS use agreed
d_screen int recommended classified by using the User Agent when not delivered
Refer to code definition.
d_maker string recommended device maker
d_model string recommended device model
d_network_index integer recommended Refer to code definition.
d_network string recommended device network status
d_carrier string recommended device carrier
d_w integer recommended device width size
d_h integer recommended device height size
d_densty integer recommended device density
d_orientation integer recommended Refer to code definition.
d_language string recommended device language
ex) ko, en…
d_mcc integer recommended USIM country code
d_mnc integer recommended USIM carrier code
Field Type Required Description
u_age integer recommended user age
u_gender integer recommended user gender, Refer to code definition.
u_ml_id string recommended user login ID
m2_ml_email string recommended user email
u_age_level string Y User age level
0: children(under 13)
1:adult(13 or more)
-1:unknown
u_gps_flag integer recommended GPS use agreed
0 : No(default)
1 : Yes

RESPONSE

SSP Publisher

SSP responses to the object defined below according to the JSON format.

response object in JSON format

Field Type Required Description
error_code string Y Refer to error definition.
ad_pd_attr string Y Refet to code definition.
code_type string Y 2 : fixed value
img_path string N creative url ( unused )
landing_url string N destination url ( unused )
width string Y width size of ad
height string Y hegith size of ad
bg_color string Y backgroudn color
ssp_imp string Y impression API processing (exception required)
dsp_imp string N impression tracking (exception required)
ssp_click string Y click API processing (exception required)
Check for duplicate values by saving parameter i_request_key value of ssp_click passed
dsp_click string N click tracking ( unused )
html string N html ( unused )
adm string Y HTML creative

{
    "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.me...",
    "ssp_click" : "http://ssp.meba.kr/sspclick.mezzo/?...",
    "dsp_click" : "",
    "html"  : "<html>...</html>",
    "adm"   : "<html>...</html>"
}

Code definition

error code

Code Description
2 invalid AD request
3 invalid parameter
4 No publihser/media/section code issued by TARGETPICK
5 No AD
97 incorrect tracking Request Key information (logic is in process)
98 incorrect tracking information
99 ad server error

ad code

Field Code Description
i_response_format json
xml
JSON response format
XML response format
i_product_type / product_type 1
2
3
banner
video
Native
i_product_attr / product_attr 1
2
3
4
6
10
banner
interstitial
interstitialEnd
movie
square and rectangle
native
i_product / product 1
2
3
4
9
10
11
12
14
19
20
30
31
44
68
69
70
71
banner320x50
interstitial750x1200
interstitialEnd750x1200
video
banner320x100
CJ Enmvideo
Naverbanner640x240
banner640x100
interstitial640x960
interstitialEnd640x960
banner300x250
interstitialvideo
shortvideo
inline_rectangle300x250
native_interstitial_image
native_interstitial_video
native_banner_image
native_banner_video
d_screen 1
3
4
5
smart phone, tablet
desktop
TV
DOOH
d_network_index Refer to d_network_index definition. network type
d_orientation 1
2
vertical
horizontal
d_mcc / d_mnc USIM country/carrier code USIM country/carrier code
d_os_index 2
3
iOS
Android
u_gender 2
3
male
female
click_action_type 0
3
5
Web Link
Store Link
Tel Link
ad_type 1
2
3
4
5
6
guaruantee
auction
non-charge
house
reward
period

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

Updated: