Banner

SSP ➡️ DSP

This document is an API guide for providing reports to SSP (Supply Side Platform) partners integrated with TARGETPICK DSP (Demand Side Platform).

To receive DSP reports from TARGETPICK, you must obtain a Token from the CJ MezzoMedia manager before use. Please contact the designated manager to issue a Token for API use.

1. Report Data Request

Information	Description
Service API Name	SSP-provided report data
API response type	XML or JSON
Authentication method	Token
Method	HTTPS
API description	Delivers report results for ads served on the SSP.

URL

Environment	URL	Method
Test	http://211.62.152.212:9000/api/report	Get
Production	https://dsp-report.meba.kr:9000/api/report	Get

Parameters

Field	Type	Required	Description	Example
sDate	String	Y	Report start date	20160101
eDate	String	Y	Report end date	20160131
PartnerID	String	Y	Partner unique ID issued by MezzoMedia	userpartnerid
Token	String	Y	Partner-specific Token value for API use	F379C8K9P0
ADType	Integer	Y	0: ALL 1: banner	1
ReportType	Integer	Y	1: daily report 2: media (PubID) report 3: ad type report	1
format	String	Y	json , xml	json

Sample

Sample URL
http://211.62.152.212:9000/api/report?PartnerID=abcde12345&token=C150KPTR39F0277A743B6&format=xml&ReportType=1&ADType=0&sDate=20190101&eDate=20190131

2. Report Data Response

Basic information - When a request is sent to the report API, report data is returned in the following format.

Field	Type	Description	Example
ListCount	Integer	Number of rows returned in the list	100
ReportType	Integer	1: daily report 2: media (PubID) report 3: ad type report	1
ADType	Integer	banner	banner
Reports.Report	Array
Date	String	Reporting date	20160101
Imp	Integer	Impression count	1000
Click	Integer	Click countClick-through rate	100
CTR	Double	Click-through rate	10.00
PubID	String	ID used to identify the media, such as AppID or SiteID (may be a random or encrypted ID)	publisher123
Revenue	Double	Inventory purchase cost payable by MezzoMedia	100000

Example

Daily Report

<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>1</ReportType> 
		<sDate>20190101</sDate> 
		<eDate>20190131</eDate> 
		<ADType>ALL</ADType> 
		<Reports>
			<Report>
				<Date>20190101</Date>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data>

media-by-PubID report

<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>2</ReportType> 
		<sDate>20160101</sDate> 
		<eDate>20160131</eDate> 
		<ADType>banner</ADType> 
		<Reports>
			<Report>
				<Date>20160101</Date>
				<PubID>publisher123</PubID>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				<Date>20160101</Date>
				<PubID>publisher456</PubID>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>3000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data> xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>1</ReportType> 
		<sDate>20160101</sDate> 
		<eDate>20160131</eDate> 
		<ADType>ALL</ADType> 
		<Reports>
			<Report>
				<Date>20160101</Date>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data>

ad type report

<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>3</ReportType> 
		<sDate>20160101</sDate> 
		<eDate>20160131</eDate> 
		<ADType>ALL</ADType> 
		<Reports>
			<Report>
				<Date>20160101</Date>
				<ADType>banner</ADType>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR> 10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				<Date>20160101</Date>
				<ADType>interstitial</ADType> 
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR> 10.00</CTR>
				<Revenue>3000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data>

3. Error Code

Code	Descirption
000	Success
001	A system error occurred.
002	An unknown error occurred.
003	You do not have permission to view this data.
004	This API does not exist.
005	Invalid parameter information.
006	A date must be provided and the range cannot exceed three months.

Example

Error Response

<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</code> 
		<message>SUCCESS</message> 
	</error>
</data>