Report API for Agency

13 분 소요

Youngjin Lee

기본정보

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

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

전체 캠페인 목록

Request URL
URL Method
/S-Plus_api/getCampaignListAll.xml Get
/S-Plus_api/getCampaignListAll.json Get
Request Parameters
이름 타입 기본값 코드 예시 설명
USER String Y XXXXXX ID 암호화
Auth_Type String Y agy 권한
sDate Integer Y 20160101 캠페인 시작 일자
eDate Integer Y 20160131 캠페인 종료 일자
Respose Fields
이름 타입 코드 예시 설명
AllCam_Count Integer 100 반환되는 리스트 행 수
AllCampaigns.AllCampaign      
AllCam_No Integer 12345 캠페인ID
AllCam_Status String 진행 진행, 중지, 준비, 완료, 삭제
AllCam_Name String 메조_테스트캠페인 캠페인명
AllCam_sDate String 2016-01-01 00:00 캠페인 시작일
AllCam_eDate String 2016-01-01 00:00 캠페인 종료일
AllCam_Imp Integer 1000 노출
AllCam_ImpP Integer 1000 노출+
AllCam_Click Integer 1000 클릭
AllCam_CTR Integer 1000 노출 대비 클릭
AllCam_CTRP Integer 1000 노출+ 대비 클릭
AllCam_CV Integer 1000 전환 수
AllCam_CVR Integer 1000 클릭 대비 전환율(%)
Respose Sample
<?xml version="1.0" encoding="utf-8" ?>
<message>
     <error>
           <code>000</code>
           <message>성공</message>
     </error>
        <result>
                <AllCamCount>10</AllCamCount> 
                <AllCampaigns>
                        <AllCampain>
                                <AllCam_No>1234</AllCam_No>
                                <AllCam_Status>진행</AllCam_Status>
                                <AllCam_Name>메조_테스트캠페인</AllCam_Name>
                                <AllCam_sDate> 2016-01-01 00:00</AllCam_sDate>
                                <AllCam_eDate> 2016-01-01 00:00 </AllCam_eDate>
                                <AllCam_Imp> 1000 </AllCam_Imp>
                                <AllCam_ImpP> 1000 </AllCam_ImpP>
                                <AllCam_Click> 1000 </AllCam_Click>
                                <AllCam_CTR> 1000 </AllCam_CTR>
                                <AllCam_CTRP> 1000 </AllCam_CTRP>
                                <AllCam_CV> 1000 </AllCam_CV>
                                <AllCam_CVR> 1000 </AllCam_CVR>
                        </AllCampain>
                        <AllCampain>
                            ……
                        </AllCampain>
                </AllCampaigns>
        </result>
</message>

캠페인 목록

Request URL
URL Method
/S-Plus_api/getCampaignList.xml Get
/S-Plus_api/getCampaignList.json Get
Request Parameters
이름 타입 기본값 코드 예시 설명
USER String Y XXXXXX ID 암호화
Auth_Type String Y agy 권한
Cam_No Integer Y 12345 캠페인ID
sDate Integer Y 20160101 캠페인 시작 일자
eDate Integer Y 20160131 캠페인 종료 일자
Respose Fields
이름 타입 코드 예시 설명
Cam_Count Integer 100 반환되는 리스트 행 수
Cam_Name String 메조_테스트캠페인 캠페인명
CamInfo_Goal Integer 100 캠페인 목표량
CamInfo_sDate Integer 2016-01-01 0:00 캠페인 시작일
CamInfo_eDate String 2016-01-01 0:00 캠페인 종료일
CamInfo_Status String 진행 진행, 중지, 준비, 완료, 삭제
CamInfo_tBudjet Integer 10000000 캠페인 총 예산
CamInfo_Brand String 메조몰 캠페인 브랜드
CamInfo_Category String 유통/유통기타 캠페인 카테고리
CamInfo_Agency String 제일기획 캠페인 대행사
CamInfo_Agency2 String 이노션 캠페인 대대행사
CamInfo_Rep String 메조미디어 캠페인 렙사
Campaigns.Campaign      
Cam_Daily String 2016-01-01 일자
Cam_Imp Integer 1000 노출
Cam_Click Integer 1000 클릭
Cam_CTR Integer 1000 노출 대비 클릭
Cam_CPC Integer 1000 CPC 단가
Cam_CPM Integer 1000 CPM 단가
Cam_CPV Integer 1000 CPV 단가
Respose Sample
<?xml version="1.0" encoding="utf-8" ?>
<message>
     <error>
           <code>000</code>
           <message>성공</message>
     </error>
        <result>
                <Cam_Count>10</Cam_Count> 
                <Cam_Name>메조미디어 캠페인</Cam_Name> 
                <CamInfo_sDate>2016-06-01</CamInfo_sDate> 
                <CamInfo_eDate>2016-06-31</CamInfo_eDate> 
                <CamInfo_Status>진행</CamInfo_Status> 
                <CamInfo_tBudjet>10000</CamInfo_tBudjet> 
                <CamInfo_Brand>메조브랜드</CamInfo_Brand> 
                <CamInfo_Category>가정용품/주방용품</CamInfo_Category> 
                <CamInfo_Agency>제일기획</CamInfo_Agency> 
                <CamInfo_Agency2>이노션</CamInfo_Agency2> 
                <CamInfo_Rep>메조미디어</CamInfo_Rep> 
                <AllCampaigns>
                        <AllCampain>
                                <AllCam_No>1234</AllCam_No>
                                <AllCam_Status>진행</AllCam_Status>
                                <AllCam_Name>메조_테스트캠페인</AllCam_Name>
                                <AllCam_sDate> 2016-01-01 00:00</AllCam_sDate>
                                <AllCam_eDate> 2016-01-01 00:00 </AllCam_eDate>
                                <AllCam_Imp> 1000 </AllCam_Imp>
                                <AllCam_ImpP> 1000 </AllCam_ImpP>
                                <AllCam_Click> 1000 </AllCam_Click>
                                <AllCam_CTR> 1000 </AllCam_CTR>
                                <AllCam_CTRP> 1000 </AllCam_CTRP>
                                <AllCam_CV> 1000 </AllCam_CV>
                                <AllCam_CVR> 1000 </AllCam_CVR>
                        </AllCampain>
                        <AllCampain>
                            ……
                        </AllCampain>
                </AllCampaigns>
        </result>
</message>

애드그룹 목록

Request URL
URL Method
/S-Plus_api/getADGroupList.xml Get
/S-Plus_api/getADGroupList.json Get
Request Parameters
Main Request

캠페인 목록 API를 통해 반환된 Cam_No를 이용하여 해당 캠페인 하위에 포함되어 있는 애드그룹 목록을 요청합니다.

이름 타입 기본값 코드 예시 설명
USER String Y XXXXXX ID 암호화
Auth_Type String Y agy 권한
Cam_No Integer Y 12345 캠페인ID
sDate Integer Y 20160101 기간 조회 시작일
eDate String Y 20160130 기간 조회 종료일
AGP Integer N 00001 애드그룹 목록 수
Sub Request

Main Request를 통해 반환된 AG_No와 AG_Product_Type을 이용하여 해당 애드그룹의 상세 리포트를 요청합니다.

이름 타입 기본값 코드 예시 설명
USER String Y XXXXXX ID 암호화
Auth_Type String Y agy 권한
sDate Integer Y 20160101 기간 조회 시작일
eDate String Y 20160130 기간 조회 종료일
Cam_No Integer Y 12345 캠페인ID
AG_No Integer Y 00001 애드그룹ID
AG_Product_Type String Y banner banner, movie, native
Respose Fields
Main Respose
이름 타입 코드 예시 설명
AG_Count Integer 100 반환되는 리스트 행 수
ADGroups.ADGroup      
AG_No Integer 00001 애드그룹ID
AG_Name String 메조_테스트_띠배너 애드그룹명
AG_Status String 진행 진행, 중지, 준비, 완료, 삭제
AG_Product_Type String Banner banner, movie, native
AG_Product String 배너_320X50 배너_320X50
      전면배너_1040X585
      전면배너_649X960
      배너_640X148
      배너_640X100
      네이버 배너_640_240
      띠배너_320X100
      띠배너_340X95
      띠배너_340X51
      종료_750X1200
      전면_750X1200
      전면배너_640X640
AG_Imp String 1000 노출
AG_ImpP String 1000 노출+
AG_Click String 1000 클릭
AG_CTR String 1000 노출 대비 클릭
AG_CTRP String 1000 노출+ 대비 클릭
AG_CV String 1000 전환 수
AG_CVR String 1000 클릭 대비 전환율(%)
Sub Response

AG_Product_Type 이 banner 일 경우

이름 타입 코드 예시 설명
AG_Sub_B_Count Integer 100 반환되는 리스트 행 수
ADGroups_Sub_B.ADGroup_Sub_B      
Cam_No Integer 12345 캠페인ID
AG_No Integer XXXXXXX 애드그룹ID
AG_Sub_Date String 2016-01-01 00:00 일자
AG_Sub_Imp String 1000 노출
AG_Sub_Click String 1000 클릭
AG_Sub_CTR String 1000 노출 대비 클릭
AG_Sub_CV String 1000 전환 수
AG_Sub_CVR String 1000 클릭 대비 전환율(%)

AG_Product_Type 이 movie 일 경우

이름 타입 코드 예시 설명
AG_Sub_M_Count Integer 100 반환되는 리스트 행 수
ADGroups_Sub_M.ADGroup_Sub_M      
Cam_No Integer 12345 캠페인ID
AG_No Integer XXXXXXX 애드그룹ID
AG_Sub_Date String 2016-01-01 00:00 일자
AG_Sub_Imp Integer 1000 노출
AG_Sub_ImpP Integer 1000 노출+
AG_Sub_View Integer 1000 시청
AG_Sub_Click Integer 1000 클릭
AG_Sub_CTR Integer 1000 노출 대비 클릭
AG_Sub_CTRP Integer 1000 노출+(15초) 대비 클릭
AG_Sub_VTR Integer 1000 노출당 시청 비율
AG_Sub_VTRP Integer 1000 노출+(15초)당 시청 비율
AG_Sub_CVTR Integer 1000 노출당 재생+클릭
AG_Sub_CVTRP Integer 1000 노출+(15초)당 재생+클릭
AG_Sub_Start Integer 1000 동영상 시작시 노출 수
AG_Sub_1Q Integer 1000 동영상 25% 재생시 노출 수
AG_Sub_2Q Integer 1000 동영상 50% 재생시 노출 수
AG_Sub_3Q Integer 1000 동영상 75% 재생시 노출 수
AG_Sub_Complete Integer 1000 동영상 재생 종료시 노출 수
Respose Sample
Main Response Sample
<?xml version="1.0" encoding="utf-8"?>
<message>
    <error>
        <code>000</code>
        <message>성공</message>
    </error>
    <result>
        <AG_Count>10</AG_Count>
        <ADGroups>
            <ADGroup>
                <AG_No>1234</AG_No>
                <AG_Name>메조_테스트_띠배너</AG_Name>
                <AG_Status>진행</AG_Status>
                <AG_Product_Type>banner</AG_Product_Type>
                <AG_Product>배너_320X50</AG_Product>
                <AG_Imp>1000</AG_Imp>
                <AG_ImpP>1000</AG_ImpP>
                <AG_Click>1000</AG_Click>
                <AG_CTR>1000</AG_CTR>
                <AG_CTRP>1000</AG_CTRP>
                <AG_CV>1000</AG_CV>
                <AG_CVR>1000</AG_CVR>
            </ADGroup>
            <ADGroup>
                ……
            </ADGroup>
        </ADGroups>
    </result>
</message>
Sub Response Sample

AG_Product_Type 이 banner 일 경우

<?xml version="1.0" encoding="utf-8"?>
<message>
    <error>
        <code>000</code>
        <message>성공</message>
    </error>
    <result>
        <AG_Sub_B_Count>10</AG_Sub_B_Count>
        <ADGroups_Sub_B>
            <ADGroup_Sub_B>
                <Cam_No>1234 </Cam_No>
                <AG_No>12345</AG_No>
                <AG_Sub_Date>2016-01-01 00:00</AG_Sub_Date>
                <AG_Sub_Imp>1000</AG_Sub_Imp>
                <AG_Sub_Click>1000</AG_Sub_Click>
                <AG_Sub_CTR>1000</AG_Sub_CTR>
                <AG_Sub_CV>1000</AG_Sub_CV>
                <AG_Sub_CVR>1000</AG_Sub_CVR>
            </ADGroup_Sub_B>
            <ADGroup_Sub_B>
                ……
            </ADGroup_Sub_B>
        </ADGroups_Sub_B>
    </result>
</message>

AG_Product_Type 이 movie 일 경우

<?xml version="1.0" encoding="utf-8"?>
<message>
    <error>
        <code>000</code>
        <message>성공</message>
    </error>
    <result>
        <AG_Sub_M_Count>10</AG_Sub_M_Count>
        <ADGroups_Sub_M>
            <ADGroup_Sub_M>
                <Cam_No>1234</Cam_No>
                <AG_No>12345</AG_No>
                <AG_Sub_Date>2016-01-01 00:00</AG_Sub_Date>
                <AG_Sub_Imp>1000</AG_Sub_Imp>
                <AG_Sub_ImpP>1000</AG_Sub_ImpP>
                <AG_Sub_View>1000</AG_Sub_View>
                <AG_Sub_Click>1000</AG_Sub_Click>
                <AG_Sub_CTR>1000</AG_Sub_CTR>
                <AG_Sub_CTRP>1000</AG_Sub_CTRP>
                <AG_Sub_VTR>1000</AG_Sub_VTR>
                <AG_Sub_VTRP>1000</AG_Sub_VTRP>
                <AG_Sub_CVR>1000</AG_Sub_CVR>
                <AG_Sub_CVTR>1000</AG_Sub_CVTR>
                <AG_Sub_CVTRP>1000</AG_Sub_CVTRP>
                <AG_Sub_Start>1000</AG_Sub_Start>
                <AG_Sub_1Q>1000</AG_Sub_1Q>
                <AG_Sub_2Q>1000</AG_Sub_2Q>
                <AG_Sub_3Q>1000</AG_Sub_3Q>
                <AG_Sub_Complete>1000</AG_Sub_Complete>
            </ADGroup_Sub_M>
            <ADGroup_Sub_M>
                ……
            </ADGroup_Sub_M>
        </ADGroups_Sub_M>
    </result>
</message>

애드 목록

Request URL
URL Method
/S-Plus_api/getADList.xml Get
/S-Plus_api/getADList.json Get
Request Parameters
Main Request

캠페인 목록 API를 통해 반환된 Cam_No를 이용하여 해당 캠페인 하위에 포함되어 있는 애드 목록을 요청합니다.

이름 타입 기본값 코드 예시 설명
USER String Y XXXXXX ID 암호화
Auth_Type String Y agy 권한
Cam_No Integer Y 12345 캠페인ID
sDate Integer Y 20160101 기간 조회 시작일
eDate String Y 20160130 기간 조회 종료일
ADP Integer N 00001 애드 목록 수
Sub Request

Main Request를 통해 반환된 AD_No와 AD_Product_Type을 이용하여 해당 애드의 상세 리포트를 요청합니다.

이름 타입 기본값 코드 예시 설명
USER String Y XXXXXX ID 암호화
Auth_Type String Y XXXXXXX 권한
sDate Integer Y 20160101 기간 조회 시작일
eDate String Y 20160130 기간 조회 종료일
Cam_No Integer Y 12345 캠페인ID
AD_No Integer Y 00001 애드그룹ID
AD_Product_Type String Y banner banner, movie, native
Respose Fields
Main Respose
이름 타입 코드 예시 설명
AD_Count Integer 100 반환되는 리스트 행 수
ADs.AD      
AD_No Integer 1 애드ID
AD_Name String 메조_테스트_띠배너 애드명
AD_Status String 진행 진행, 중지, 준비, 완료, 삭제
AD_Product_Type String Banner banner, movie, native
AD_Product String 배너_320X50 배너_320X50
      전면배너_1040X585
      전면배너_649X960
      배너_640X148
      배너_640X100
      네이버 배너_640_240
      띠배너_320X100
      띠배너_340X95
      띠배너_340X51
      종료_750X1200
      전면_750X1200
      전면배너_640X640
AD_imgURL String http://www.a.com/image.jpg 이미지 배너 소재 경로
AD_movieURL String http://www.a.com/movie.mp4 동영상 소재 경로
AD_Imp String 1000 노출
AD_ImpP String 1000 노출+
AD_Click String 1000 클릭
AD_CTR String 1000 노출 대비 클릭
AD_CTRP String 1000 노출+ 대비 클릭
AD_CV String 1000 전환 수
AD_CVR String 1000 클릭 대비 전환율(%)
Sub Response

AD_Product_Type 이 banner 일 경우

이름 타입 코드 예시 설명
AD_Sub_B_Count Integer 100 반환되는 리스트 행 수
ADs_Sub_B.AD_Sub_B      
Cam_No Integer 12345 캠페인ID
AD_No Integer XXXXXXX 애드ID
AD_Sub_Date String 2016-01-01 00:00 일자
AD_Sub_Imp String 1000 노출
AD_Sub_Click String 1000 클릭
AD_Sub_CTR String 1000 노출 대비 클릭
AD_Sub_CV String 1000 전환 수
AD_Sub_CVR String 1000 클릭 대비 전환율(%)

AD_Product_Type 이 movie 일 경우

이름 타입 코드 예시 설명
AD_Sub_M_Count Integer 100 반환되는 리스트 행 수
ADs_Sub_M.AD_Sub_M      
Cam_No Integer 12345 캠페인ID
AD_No Integer XXXXXXX 애드ID
AD_Sub_Date String 2016-01-01 00:00 일자
AD_Sub_Imp Integer 1000 노출
AD_Sub_ImpP Integer 1000 노출+
AD_Sub_View Integer 1000 시청
AD_Sub_Click Integer 1000 클릭
AD_Sub_CTR Integer 1000 노출 대비 클릭
AD_Sub_CTRP Integer 1000 노출+(15초) 대비 클릭
AD_Sub_VTR Integer 1000 노출당 시청 비율
AD_Sub_VTRP Integer 1000 노출+(15초)당 시청 비율
AD_Sub_CVTR Integer 1000 노출당 재생+클릭
AD_Sub_CVTRP Integer 1000 노출+(15초)당 재생+클릭
AD_Sub_Start Integer 1000 동영상 시작시 노출 수
AD_Sub_1Q Integer 1000 동영상 25% 재생시 노출 수
AD_Sub_2Q Integer 1000 동영상 50% 재생시 노출 수
AD_Sub_3Q Integer 1000 동영상 75% 재생시 노출 수
AD_Sub_Complete Integer 1000 동영상 재생 종료시 노출 수
Respose Sample
Main Response Sample
<?xml version="1.0" encoding="utf-8"?>
<message>
    <error>
        <code>000</code>
        <message>성공</message>
    </error>
    <result>
        <AD_Count>10</AD_Count>
        <ADs>
            <AD>
                <AD_No>1234</AD_No>
                <AD_Name>메조_테스트_띠배너</AD_Name>
                <AD_Status>진행</AD_Status>
                <AD_Product_Type>banner</AD_Product_Type>
                <AD_Product>배너_320X50</AD_Product>
                <AD_imgURL>http://www.a.com/image.jpg</AD_imgURL>
                <AD_MovieURL>http://www.a.com/movie.mp4</AD_MovieURL>
                <AD_Imp>1000</AD_Imp>
                <AD_ImpP>1000</AD_ImpP>
                <AD_Click>1000</AD_Click>
                <AD_CTR>1000</AD_CTR>
                <AD_CTRP>1000</AD_CTRP>
                <AD_CV>1000</AD_CV>
                <AD_CVR>1000</AD_CVR>
            </AD>
            <AD>
                ……
            </AD>
        </ADs>
    </result>
</message>
Sub Response Sample

AG_Product_Type 이 banner 일 경우

<?xml version="1.0" encoding="utf-8"?>
<message>
    <error>
        <code>000</code>
        <message>성공</message>
    </error>
    <result>
        <AD_Sub_B_Count>10</AD_Sub_B_Count>
        <ADs_Sub_B>
            <AD_Sub_B>
                <Cam_No>1234 </Cam_No>
                <AD_No>12345</AD_No>
                <AD_Sub_Date>2016-01-01 00:00</AD_Sub_Date>
                <AD_Sub_Imp>1000</AD_Sub_Imp>
                <AD_Sub_Click>1000</AD_Sub_Click>
                <AD_Sub_CTR>1000</AD_Sub_CTR>
                <AD_Sub_CV>1000</AD_Sub_CV>
                <AD_Sub_CVR>1000</AD_Sub_CVR>
            </AD_Sub_B>
            <AD_Sub_B>
                ……
            </AD_Sub_B>
        </ADs_Sub_B>
    </result>
</message>

AG_Product_Type 이 movie 일 경우

<?xml version="1.0" encoding="utf-8"?>
<message>
    <error>
        <code>000</code>
        <message>성공</message>
    </error>
    <result>
        <AD_Sub_M_Count>10</AD_Sub_M_Count>
        <ADs_Sub_M>
            <AD_Sub_M>
                <Cam_No>1234</Cam_No>
                <AD_No>12345</AD_No>
                <AD_Sub_Date>2016-01-01 00:00</AD_Sub_Date>
                <AD_Sub_Imp>1000</AD_Sub_Imp>
                <AD_Sub_ImpP>1000</AD_Sub_ImpP>
                <AD_Sub_View>1000</AD_Sub_View>
                <AD_Sub_Click>1000</AD_Sub_Click>
                <AD_Sub_CTR>1000</AD_Sub_CTR>
                <AD_Sub_CTRP>1000</AD_Sub_CTRP>
                <AD_Sub_VTR>1000</AD_Sub_VTR>
                <AD_Sub_VTRP>1000</AD_Sub_VTRP>
                <AD_Sub_CVR>1000</AD_Sub_CVR>
                <AD_Sub_CVTR>1000</AD_Sub_CVTR>
                <AD_Sub_CVTRP>1000</AD_Sub_CVTRP>
                <AD_Sub_Start>1000</AD_Sub_Start>
                <AD_Sub_1Q>1000</AD_Sub_1Q>
                <AD_Sub_2Q>1000</AD_Sub_2Q>
                <AD_Sub_3Q>1000</AD_Sub_3Q>
                <AD_Sub_Complete>1000</AD_Sub_Complete>
            </AD_Sub_M>
            <AD_Sub_M>
                ……
            </AD_Sub_M>
        </ADs_Sub_M>
    </result>
</message>

업데이트: