Banner AD. Delivery API

6 minute read

Chansup Yang

REQUEST

Publisher, SSP TARGETPICK

As TARGETPICK’s own advertising API, noad is generated when the stock runs out.

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

Domain info

Division URL
test http://211.62.152.210
real 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}

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 Refer to code definition. (default - json)
i_request_id string recommended Publisher creates and manages unique code when requesting advertising
(universally unique identifier, UUID)
i_rich_flag integer Y 1: image mode, 0: html mode
d_used_type string Y used type
api : fixed value
keyword string recommended Keyword value passing
Separators are used as ^
keyword value is encoded
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 integer recommended 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

TARGETPICK Publisher

TARGETPICK responds to the object defined below according to the request type (json/xml).

response object in JSON/XML format

Field Type Required Description
version string Y 2 : TARGETPICK AD version
error_code string Y Refer to error definition.
rotatetime string Y ad re-request rotation time(second)
request_id string Y ad request unique code (delivered request_id when ad request)
ad_type string Y ad type, Refer to code definition.
product_type string Y ad product type, Refer to code definition.
product_attr string Y ad product attribution, Refer to code definition.
product string Y ad product code, Refer to code definition.
ad_count string Y ad[Array] the number of ad list
ad object Y Refer to ad object.
Ad
Field Type Required Description
cmp_no string Y campaign ID
ad_group_no string Y ad group ID
ad_no string Y ad ID
img_path string Y creative path
img_name string Y creative file name
click_option string Y click option
click_action_type string Y click action type, Refer to code definition.
In the case of an app, if click_action_type is 3, it should be moved to the store.
landing_url string Y advertiser’s destination URL
bg_color string Y background color ex) #ffffff
width string Y creative width size
height string Y creative height size
end_datetime string Y hours available for advertising
0 : unlimited , N:(end_datetime)_unix timestamp
impression_api string Y impression tracking API
(deliver API when ad is exposed)
click_api string Y click API
(deliver API when ad is clicked - redirect to advertiser page)
click_tracking_api string Y click tracking API
(deliver API when ad is clicked)
html string Y ad HTML creative
(HTML-based delivery of advertising information - including impression/click API)
logo_img_path string Y image used for Opt in/out
logo_landing_url string Y path to move when logo_img_path is clicked.
Replace [adid] with the ID below
Android : Google AdvertiseID
iOS : IDFA
web : null

{
	"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.210/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=d87a692c-70d4-4457-b551-9deb86cdb4d3&i_response_format=json&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=",
			"click_api": "http://211.62.152.210/ad_tracking.mezzo/?e_request_type=click&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=d87a692c-70d4-4457-b551-9deb86cdb4d3&i_response_format=json&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=",
			"click_tracking_api": "http://211.62.152.210/ad_tracking.mezzo/?e_request_type=click_tracking&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=d87a692c-70d4-4457-b551-9deb86cdb4d3&i_response_format=json&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=",
			"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.210/ad_tracking.mezzo/?e_request_type=click&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=d87a692c-70d4-4457-b551-9deb86cdb4d3&i_response_format=json&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=' 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.210/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=d87a692c-70d4-4457-b551-9deb86cdb4d3&i_response_format=json&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url='></div></article></div></body></html>"
		}]
	}
}

<?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.210/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=ac7ca651-b487-4fee-822c-a08cdf00047b&i_response_format=xml&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=]]>  
        </impression_api>  
        <click_api>  
            <![CDATA[http://211.62.152.210/ad_tracking.mezzo/?e_request_type=click&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=ac7ca651-b487-4fee-822c-a08cdf00047b&i_response_format=xml&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=]]>  
        </click_api>  
        <click_tracking_api>  
            <![CDATA[http://211.62.152.210/ad_tracking.mezzo/?e_request_type=click_tracking&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=ac7ca651-b487-4fee-822c-a08cdf00047b&i_response_format=xml&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=]]>  
        </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.210/ad_tracking.mezzo/?e_request_type=click&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=ac7ca651-b487-4fee-822c-a08cdf00047b&i_response_format=xml&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url=' 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.210/ad_tracking.mezzo/?e_request_type=imps_tracking&e_version=2&e_cmp_no=9&e_ad_group_no=121&e_ad_no=13&a_publisher=2&a_media=4&a_section=4&a_name=&a_ver=&a_sspid=&i_request_id=-&i_request_key=ac7ca651-b487-4fee-822c-a08cdf00047b&i_response_format=xml&i_product_type=1&i_product_attr=1&i_product=1&i_banner_w=-1&i_banner_h=-1&d_adid=-&d_sadid=-&d_geo_lat=0.000000&d_geo_lon=0.000000&d_screen=3&d_maker=-&d_model=-&d_network_index=-1&d_network=-&d_carrier=-&d_os_index=-1&d_os=-&d_osv=-&d_w=-1&d_h=-1&d_densty=-1&d_orientation=-1&d_language=-&d_sdk_v=-1&d_mcc=-1&d_mnc=-1&u_age=-1&u_gender=-1&e_target_type=&e_bp=0&e_landing_url='></div></article></div></body></html>]]>  
        </html>  
    </ad>  
  </adsinfo>

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: