Report API for Publisher

8 분 소요

Youngjin Lee

기본정보

도메인 및 API Key는 별도로 제공됩니다.

에러코드
코드 설명
000 성공
001 시스템에 에러가 발생했습니다.
002 알 수 없는 오류가 발생했습니다.
003 조회 권한이 없습니다.
004 존재하지 않는 API 입니다.
005 Parameter 정보가 잘못되었습니다.
006 날짜는 반드시 입력해야 하며, 세 달을 초과 할 수 없습니다.

배너 리포트

URL Method
/S-Plus_api/getBannerReport.xml Get
/S-Plus_api/getBannerReport.json Get
Filed Name 타입 필수 코드 예시 설명
USER String Y XXXXXX ID,PW 암호화
Auth_Type String Y pub 권한
sDate Integer Y 20160101 기간 조회 시작일
eDate String Y 20160130 기간 조회 종료일
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 미디어ID
B_Section Integer N 80002 섹션ID
B_Charge Integer N 1 1 : ALL
        2 : 과금
        3 : 비과금
cross_ad Integer N 1 0 : 교차상품 노출 안함
        1 : 교차상품 노출
group String N media,section media : media_code 기준 그룹화
        section : section_code 기준 그룹화
이름 타입 전달 값 예시 설명
B_Report_Count Integer 1000 반환되는 리스트 행 수
B_Reports.B_Report      
B_Day Integer 2016-01-01 일자
B_Request Integer 1000 광고 호출 수
B_Delivery Integer 1000 광고 전달 수
B_Imp Integer 1000 노출
B_Click Integer 1000 클릭
B_CTR String 1.27% 노출 대비 클릭
B_FillRate Float 98.11 광고 요청 대비 노출
B_ExpectedCost Integer 1372 예상 수익
B_Media Integer 30000 미디어 코드 ( group 파라미터에 media가 있을 경우 반환 )
B_Section Integer 800000 섹션 코드 ( group 파라미터에 section이 있을 경우 반환 )
B_Reports.B_Report.B_C_Lists.B_C_List     cross_ad 파라미터가 1일 경우 반환
B_C_Product_Name String 전면배너 교차상품 명칭
B_C_Delivery Integer 500 교차상품 광고 전달 수
B_C_Imp Integer 500 교차상품 노출
B_C_Click Integer 500 교차상품 클릭
B_C_CTR String 1.11% 교차상품 노출 대비 클릭
B_C_ExpectedCost Integer 772 교차상품 예상 수익
<?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>
                <!-- group 파라미터 값에 따라 반환 -->
                <B_Media>30000</B_Media>
                <!-- group 파라미터 값에 따라 반환 -->
                <B_Section>800000</B_Section>
            </Reports>
            <Reports>
                ……
            </Reports>
        </B_Reports>
    </result>
</message>
<?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>
                <!-- group 파라미터 값에 따라 반환 -->
                <B_Media>30000</B_Media>
                <!-- group 파라미터 값에 따라 반환 -->
                <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>

동영상 리포트

Request URL
URL Method
/S-Plus_api/getMovieReport.xml Get
/S-Plus_api/getMovieReport.json Get
Request Parameters
Filed Name 타입 필수 코드 예시 설명
USER String Y XXXXXX ID,PW 암호화
Auth_Type String Y pub 권한
sDate Integer Y 20160101 기간 조회 시작일
eDate String Y 20160130 기간 조회 종료일
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 미디어ID
M_Section Integer N 80002 섹션ID
M_Charge Integer Y 1 1 : ALL
        2 : 과금
        3 : 비과금
cross_ad Integer N 1 0 : 교차상품 노출 안함
        1 : 교차상품 노출
group String N media,section media : media_code 기준 그룹화
        section : section_code 기준 그룹화
Respose Fields
이름 타입 전달 값 예시 설명
M_Report_Count Integer 1000 반환되는 리스트 행 수
M_Reports.M_Report      
M_Day String 2016-01-01 일자
M_Request Integer 1000 광고 호출 수
M_Delivery Integer 1000 광고 전달 수
M_Imp Integer 1000 노출
M_ImpP Integer 1000 노출+
M_View Integer 1000 시청
M_Click Integer 1000 클릭
M_CTR String 1.11% 노출 대비 클릭
M_CTRP String 1.11% 노출+ 대비 클릭
M_VTR String 90.45% 노출당 시청 비율
M_VTRP String 90.45% 노출+ 당 시청 비율
M_FillRate String 23.87% 광고 요청 대비 노출
M_FillRateP String 23.87% 광고 요청 대비 노출+
M_Sub_1Q Integer 1000 동영상 시작시 노출 수
M_Sub_2Q Integer 1000 동영상 25% 재생시 노출 수
M_Sub_3Q Integer 1000 동영상 50% 재생시 노출 수
M_Sub_4Q Integer 1000 동영상 75% 재생시 노출 수
M_Sub_5Q Integer 1000 동영상 재생 종료시 노출 수
M_ExpectedCost Integer 1372 예상 수익
M_Media Integer 30000 미디어 코드 ( group 파라미터에 media가 있을 경우 반환 )
M_Section Integer 800000 섹션 코드 ( group 파라미터에 section이 있을 경우 반환 )
M_Reports.M_Report.M_C_Lists.M_C_List     cross_ad 파라미터가 1일 경우 반환
M_C_Product_Name String 전면배너 교차상품 명칭
M_C_Delivery Integer 1000 교차상품 광고 전달 수
M_C_Imp Integer 1000 교차상품 노출
M_C_ImpP Integer 1000 교차상품 노출+
M_C_View Integer 1000 교차상품 시청
M_C_Click Integer 1000 교차상품 클릭
M_C_CTR String 1.11% 교차상품 노출 대비 클릭
M_C_CTRP String 1.11% 교차상품 노출+ 대비 클릭
M_C_VTR String 90.45% 교차상품 노출당 시청 비율
M_C_VTRP String 90.45% 교차상품 노출+ 당 시청 비율
M_C_FillRate String 23.87% 교차상품 광고 요청 대비 노출
M_C_FillRateP String 23.87% 교차상품 광고 요청 대비 노출+
M_C_Sub_1Q Integer 1000 교차상품 동영상 시작시 노출 수
M_C_Sub_2Q Integer 1000 교차상품 동영상 25% 재생시 노출 수
M_C_Sub_3Q Integer 1000 교차상품 동영상 50% 재생시 노출 수
M_C_Sub_4Q Integer 1000 교차상품 동영상 75% 재생시 노출 수
M_C_Sub_5Q Integer 1000 교차상품 동영상 재생 종료시 노출 수
M_C_ExpectedCost Integer 1372 교차상품 예상 수익
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>
                <!-- group 파라미터 값에 따라 반환 -->
                <M_Media>30000</M_Media>
                <!-- group 파라미터 값에 따라 반환 -->
                <M_Section>800000</M_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>
                <!-- group 파라미터 값에 따라 반환 -->
                <M_Media>30000</M_Media>
                <!-- group 파라미터 값에 따라 반환 -->
                <M_Section>800000</M_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>

정산 리포트

Request URL
URL Method
/S-Plus_api/getCalReport.xml Get
/S-Plus_api/getCalReport.json Get
Request Parameters
Filed Name 타입 필수 코드 예시 설명
USER String Y XXXXXX ID,PW 암호화
Auth_Type String Y pub 권한
C_Year Integer Y 2016 조회 연도
Respose Fields
이름 타입 전달 값 예시 설명
C_CalReport_Count Integer 10 반환되는 리스트 행 수
C_CalReports.B_CalReport      
C_YearMonth Integer 201601 정산년월
C_CalType String Net 매체 정산 방식
C_CalEstimate Integer 1000 산정 금액
C_CalAdjustment Integer 1000 조정 금액
C_AdjCause Varchar 금액 재 조정 조정 사유
C_sMonthRev Integer 1000 당월 수익
C_CarryOverRev Integer 1000 이월 수익
C_CalPossible Integer 1000 정산 가능 금액
C_CalFinal Integer 1000 최종 정산 금액
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>금액 재 조정</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>

업데이트: