Report API for Publisher
9 minute read
Chansup Yang
Basic info
Domain and API keys are provided separately.
Error code
| Code |
Description |
| 000 |
success |
| 001 |
system error |
| 002 |
unknown error |
| 003 |
no permissions |
| 004 |
non-exist API |
| 005 |
incorrect Parameter |
| 006 |
Date must be entered and cannot exceed 3 months |
Banner report
Request URL
| URL |
Method |
| /S-Plus_api/getBannerReport.xml |
Get |
| /S-Plus_api/getBannerReport.json |
Get |
Request Parameters
| Field |
Type |
Required |
Example |
Description |
| USER |
String |
Y |
XXXXXX |
encoded ID |
| Auth_Type |
String |
Y |
pub |
authority |
| sDate |
Integer |
Y |
20160101 |
report query start date |
| eDate |
String |
Y |
20160130 |
report query end date |
| B_ServiceType |
Integer |
N |
1 |
0 : ALL |
| |
|
|
|
1 : Mobile_web |
| |
|
|
|
2 : App_android |
| |
|
|
|
3 : App_ios |
| |
|
|
|
4 : App_ETC |
| |
|
|
|
5 : PC_web |
| B_Media |
Integer |
N |
10001 |
media ID |
| B_Section |
Integer |
N |
80002 |
section ID |
| B_Charge |
Integer |
N |
1 |
1 : ALL |
| |
|
|
|
2 : charged |
| |
|
|
|
3 : non-charged |
| cross_ad |
Integer |
N |
1 |
0 : cross ad exposed - No |
| |
|
|
|
1 : cross ad exposed - Yes |
| group |
String |
N |
media,section |
media : group by media_code |
| |
|
|
|
section : group by section_code |
Respose Fields
| Field |
Type |
Example |
Description |
| B_Report_Count |
Integer |
1000 |
returned row count |
| B_Reports.B_Report |
|
|
|
| B_Day |
Integer |
2016-01-01 |
date |
| B_Request |
Integer |
1000 |
ad request count |
| B_Delivery |
Integer |
1000 |
ad delivey count |
| B_Imp |
Integer |
1000 |
impression count |
| B_Click |
Integer |
1000 |
click count |
| B_CTR |
String |
1.27% |
click through ratio |
| B_FillRate |
Float |
98.11 |
impression ratio based on request |
| B_ExpectedCost |
Integer |
1372 |
expected cost |
| B_Media |
Integer |
30000 |
media_code ( Returns if the media is in the group parameter. ) |
| B_Section |
Integer |
800000 |
section_code ( Returns if the section is in the group parameter. ) |
| B_Reports.B_Report.B_C_Lists.B_C_List |
|
|
return if cross_ad parameter is 1 |
| B_C_Product_Name |
String |
전면배너 |
cross ad product name |
| B_C_Delivery |
Integer |
500 |
cross ad delivey count |
| B_C_Imp |
Integer |
500 |
cross ad impression count |
| B_C_Click |
Integer |
500 |
cross ad click count |
| B_C_CTR |
String |
1.11% |
cross ad click through ratio |
| B_C_ExpectedCost |
Integer |
772 |
cross ad expected cost |
Respose Sample (base)
<?xml version="1.0" encoding="utf-8"?>
<message>
<error>
<code>000</code>
<message>성공</message>
</error>
<result>
<B_Report_Count>10</B_Report_Count>
<B_Reports>
<Reports>
<B_Day>2016-01-01 00:00</B_Day>
<B_Request>1000</B_Request>
<B_Delivery>1000</B_Delivery>
<B_Imp>1000</B_Imp>
<B_Click>1000</B_Click>
<B_CTR>1.27%</B_CTR>
<B_FillRate>65.5</B_FillRate>
<B_ExpectedCost>1372</B_ExpectedCost>
<!-- Return based on group parameter value -->
<B_Media>30000</B_Media>
<!-- Return based on group parameter value -->
<B_Section>800000</B_Section>
</Reports>
<Reports>
……
</Reports>
</B_Reports>
</result>
</message>
Respose Sample (cross ad)
<?xml version="1.0" encoding="utf-8"?>
<message>
<error>
<code>000</code>
<message>성공</message>
</error>
<result>
<B_Report_Count>10</B_Report_Count>
<B_Reports>
<Reports>
<B_Day>2016-01-01 00:00</B_Day>
<B_Request>1000</B_Request>
<B_Delivery>1000</B_Delivery>
<B_Imp>1000</B_Imp>
<B_Click>1000</B_Click>
<B_CTR>1.27%</B_CTR>
<B_FillRate>65.5</B_FillRate>
<B_ExpectedCost>1372</B_ExpectedCost>
<!-- Return based on group parameter value -->
<B_Media>30000</B_Media>
<!-- Return based on group parameter value -->
<B_Section>800000</B_Section>
<B_C_Lists>
<B_C_List>
<B_C_ProductName>전면배너</B_C_ProductName>
<B_C_Delivery>500</B_C_Delivery>
<B_C_Imp>500</B_C_Imp>
<B_C_Click>500</B_C_Click>
<B_C_CTR>0.97%</B_C_CTR>
<B_C_ExpectedCost>772</B_C_ExpectedCost>
</B_C_List>
<B_C_List>
<B_C_ProductName>전면동영상</B_C_ProductName>
<B_C_Delivery>500</B_C_Delivery>
<B_C_Imp>500</B_C_Imp>
<B_C_Click>500</B_C_Click>
<B_C_CTR>2.53%</B_C_CTR>
<B_C_ExpectedCost>600</B_C_ExpectedCost>
</B_C_List>
</B_C_Lists>
</Reports>
<Reports>
……
</Reports>
</B_Reports>
</result>
</message>
Movie report
Request URL
| URL |
Method |
| /S-Plus_api/getMovieReport.xml |
Get |
| /S-Plus_api/getMovieReport.json |
Get |
Request Parameters
| Field |
Type |
Required |
Example |
Description |
| USER |
String |
Y |
XXXXXX |
encoded ID |
| Auth_Type |
String |
Y |
pub |
authority |
| sDate |
Integer |
Y |
20160101 |
report query start date |
| eDate |
String |
Y |
20160130 |
report query end date |
| M_ServiceType |
Integer |
Y |
1 |
0 : ALL |
| |
|
|
|
1 : Mobile_web |
| |
|
|
|
2 : App_android |
| |
|
|
|
3 : App_ios |
| |
|
|
|
4 : App_ETC |
| |
|
|
|
5 : PC_web |
| M_Media |
Integer |
N |
10001 |
media code |
| M_Section |
Integer |
N |
80002 |
section code |
| M_Charge |
Integer |
Y |
1 |
1 : ALL |
| |
|
|
|
2 : charge |
| |
|
|
|
3 : non-charge |
| cross_ad |
Integer |
N |
1 |
0 : cross ad exposed - No |
| |
|
|
|
1 : cross ad exposed - Yes |
| group |
String |
N |
media,section |
media : group by media_code |
| |
|
|
|
section : group by section_code |
Respose Fields
| Field |
Type |
Example |
Description |
| M_Report_Count |
Integer |
1000 |
returned row count |
| M_Reports.M_Report |
|
|
|
| M_Day |
String |
2016-01-01 |
date |
| M_Request |
Integer |
1000 |
ad request count |
| M_Delivery |
Integer |
1000 |
ad delivery count |
| M_Imp |
Integer |
1000 |
impression count |
| M_ImpP |
Integer |
1000 |
impression+ count |
| M_View |
Integer |
1000 |
view count |
| M_Click |
Integer |
1000 |
click count |
| M_CTR |
String |
1.11% |
click through ratio |
| M_CTRP |
String |
1.11% |
click through ratio based on impression+ |
| M_VTR |
String |
90.45% |
view through ratio based on impression |
| M_VTRP |
String |
90.45% |
view through ratio based on impression+ |
| M_FillRate |
String |
23.87% |
impression through ratio based on request |
| M_FillRateP |
String |
23.87% |
impression+ through ratio based on request |
| M_Sub_1Q |
Integer |
1000 |
movie start count |
| M_Sub_2Q |
Integer |
1000 |
movie 25% played count |
| M_Sub_3Q |
Integer |
1000 |
movie 50% played count |
| M_Sub_4Q |
Integer |
1000 |
movie 75% played count |
| M_Sub_5Q |
Integer |
1000 |
movie 100% played count |
| M_ExpectedCost |
Integer |
1372 |
expected cost |
| M_Media |
Integer |
30000 |
media_code ( Returns if the media is in the group parameter. ) |
| M_Section |
Integer |
800000 |
section_code ( Returns if the section is in the group parameter. ) |
| M_Reports.M_Report.M_C_Lists.M_C_List |
|
|
return if cross_ad parameter is 1 |
| M_C_Product_Name |
String |
전면배너 |
cross ad product name |
| M_C_Delivery |
Integer |
1000 |
cross ad delivery count |
| M_C_Imp |
Integer |
1000 |
cross ad impression count |
| M_C_ImpP |
Integer |
1000 |
cross ad impression+ count |
| M_C_View |
Integer |
1000 |
cross ad view count |
| M_C_Click |
Integer |
1000 |
cross ad click count |
| M_C_CTR |
String |
1.11% |
cross ad click through ratio |
| M_C_CTRP |
String |
1.11% |
cross ad click through ratio based on impression+ |
| M_C_VTR |
String |
90.45% |
cross ad view through ratio based on impression |
| M_C_VTRP |
String |
90.45% |
cross ad view through ratio based on impression+ |
| M_C_FillRate |
String |
23.87% |
cross ad impression through ratio based on request |
| M_C_FillRateP |
String |
23.87% |
cross ad impression+ through ratio based on request |
| M_C_Sub_1Q |
Integer |
1000 |
cross ad movie start count |
| M_C_Sub_2Q |
Integer |
1000 |
cross ad movie 25% played count |
| M_C_Sub_3Q |
Integer |
1000 |
cross ad movie 50% played count |
| M_C_Sub_4Q |
Integer |
1000 |
cross ad movie 75% played count |
| M_C_Sub_5Q |
Integer |
1000 |
cross ad movie 100% played count |
| M_C_ExpectedCost |
Integer |
1372 |
cross ad expected cost |
Respose Sample (일반)
<?xml version="1.0" encoding="utf-8"?>
<message>
<error>
<code>000</code>
<message>성공</message>
</error>
<result>
<M_Report_Count>10</M_Report_Count>
<M_Reports>
<M_Report>
<M_Day>2016-01-01 00:00</M_Day>
<M_Request>1000</M_Request>
<M_Delivery>1000</M_Delivery>
<M_Imp>1000</M_Imp>
<M_ImpP>1000</M_ImpP>
<M_View>1000</M_View>
<M_Click>1000</M_Click>
<M_CTR>1.11%</M_CTR>
<M_CTRP>1.11%</M_CTRP>
<M_VTR>1000</M_VTR>
<M_VTRP>1000</M_VTRP>
<M_FillRate>65.5%</M_FillRate>
<M_FillRateP>65.5%</M_FillRateP>
<M_Sub_1Q>1000</M_Sub_1Q>
<M_Sub_2Q>1000</M_Sub_2Q>
<M_Sub_3Q>1000</M_Sub_3Q>
<M_Sub_4Q>1000</M_Sub_4Q>
<M_Sub_5Q>1000</M_Sub_5Q>
<M_ExpectedCost>1372</M_ExpectedCost>
<!-- Return based on group parameter value -->
<B_Media>30000</B_Media>
<!-- Return based on group parameter value -->
<B_Section>800000</B_Section>
</M_Report>
<M_Report>
……
</M_Report>
</M_Reports>
</result>
</message>
Respose Sample (교차상품)
<?xml version="1.0" encoding="utf-8"?>
<message>
<error>
<code>000</code>
<message>성공</message>
</error>
<result>
<M_Report_Count>10</M_Report_Count>
<M_Reports>
<M_Report>
<M_Day>2016-01-01</M_Day>
<M_Request>1000</M_Request>
<M_Delivery>1000</M_Delivery>
<M_Imp>1000</M_Imp>
<M_ImpP>1000</M_ImpP>
<M_View>1000</M_View>
<M_Click>1000</M_Click>
<M_CTR>1.11%</M_CTR>
<M_CTRP>1.11%</M_CTRP>
<M_VTR>80.38%</M_VTR>
<M_VTRP>80.38%</M_VTRP>
<M_FillRate>65.5%</M_FillRate>
<M_FillRateP>65.5%</M_FillRateP>
<M_Sub_1Q>1000</M_Sub_1Q>
<M_Sub_2Q>1000</M_Sub_2Q>
<M_Sub_3Q>1000</M_Sub_3Q>
<M_Sub_4Q>1000</M_Sub_4Q>
<M_Sub_5Q>1000</M_Sub_5Q>
<M_ExpectedCost>1372</M_ExpectedCost>
<!-- Return based on group parameter value -->
<B_Media>30000</B_Media>
<!-- Return based on group parameter value -->
<B_Section>800000</B_Section>
<M_C_Lists>
<M_C_List>
<M_C_ProductName>범퍼동영상</M_C_ProductName>
<M_C_Delivery>1000</M_C_Delivery>
<M_C_Imp>1000</M_C_Imp>
<M_C_ImpP>1000</M_C_ImpP>
<M_C_View>1000</M_C_View>
<M_C_Click>1000</M_C_Click>
<M_C_CTR>1.11%</M_C_CTR>
<M_C_CTRP>1.11%</M_C_CTRP>
<M_C_VTR>80.38%</M_C_VTR>
<M_C_VTRP>80.38%</M_C_VTRP>
<M_C_FillRate>65.5%</M_C_FillRate>
<M_C_FillRateP>65.5%</M_C_FillRateP>
<M_C_Sub_1Q>1000</M_C_Sub_1Q>
<M_C_Sub_2Q>1000</M_C_Sub_2Q>
<M_C_Sub_3Q>1000</M_C_Sub_3Q>
<M_C_Sub_4Q>1000</M_C_Sub_4Q>
<M_C_Sub_5Q>1000</M_C_Sub_5Q>
<M_C_ExpectedCost>322</M_C_ExpectedCost>
</M_C_List>
<M_C_List>
<M_C_ProductName>동영상</M_C_ProductName>
<M_C_Delivery>1000</M_C_Delivery>
<M_C_Imp>1000</M_C_Imp>
<M_C_ImpP>1000</M_C_ImpP>
<M_C_View>1000</M_C_View>
<M_C_Click>1000</M_C_Click>
<M_C_CTR>1.11%</M_C_CTR>
<M_C_CTRP>1.11%</M_C_CTRP>
<M_C_VTR>80.38%</M_C_VTR>
<M_C_VTRP>80.38%</M_C_VTRP>
<M_C_FillRate>65.5%</M_C_FillRate>
<M_C_FillRateP>65.5%</M_C_FillRateP>
<M_C_Sub_1Q>1000</M_C_Sub_1Q>
<M_C_Sub_2Q>1000</M_C_Sub_2Q>
<M_C_Sub_3Q>1000</M_C_Sub_3Q>
<M_C_Sub_4Q>1000</M_C_Sub_4Q>
<M_C_Sub_5Q>1000</M_C_Sub_5Q>
<M_C_ExpectedCost>322</M_C_ExpectedCost>
</M_C_List>
</M_C_Lists>
</M_Report>
<M_Report>
……
</M_Report>
</M_Reports>
</result>
</message>
Finance report
Request URL
| URL |
Method |
| /S-Plus_api/getCalReport.xml |
Get |
| /S-Plus_api/getCalReport.json |
Get |
Request Parameters
| Field |
Type |
Required |
Example |
Description |
| USER |
String |
Y |
XXXXXX |
encoded ID |
| Auth_Type |
String |
Y |
pub |
authority |
| C_Year |
Integer |
Y |
2016 |
year |
Respose Fields
| Field |
Type |
Example |
Description |
| C_CalReport_Count |
Integer |
10 |
returned row count |
| C_CalReports.B_CalReport |
|
|
|
| C_YearMonth |
Integer |
201601 |
settlement year & month |
| C_CalType |
String |
Net |
settlement method (e.g net, gross) |
| C_CalEstimate |
Integer |
1000 |
estimate amount |
| C_CalAdjustment |
Integer |
1000 |
adjustment amount |
| C_AdjCause |
Varchar |
re-adjustment |
reason for adjustment |
| C_sMonthRev |
Integer |
1000 |
renevue for the month |
| C_CarryOverRev |
Integer |
1000 |
carry-over revenue |
| C_CalPossible |
Integer |
1000 |
month revenue + carry-over revenue |
| C_CalFinal |
Integer |
1000 |
final amount |
Respose Sample
<?xml version="1.0" encoding="utf-8"?>
<message>
<result>
<C_CalReport_Count>12</C_CalReport_Count>
<C_CalReports>
<C_CalReport>
<C_YearMonth>2015-01</C_YearMonth>
<C_CalType>Net</C_CalType>
<C_CalEstimate>1000</C_CalEstimate>
<C_CalAdjustment>1000</C_CalAdjustment>
<C_AdjCause>re-adjustment</C_AdjCause>
<C_sMonthRev>1000</C_sMonthRev>
<C_CarryOverRev>1000</C_CarryOverRev>
<C_CalPossible>1000</C_CalPossible>
<C_CalFinal>1000</C_CalFinal>
</C_CalReport>
<C_CalReport>
……
</C_CalReport>
</C_CalReports>
</result>
</message>
