> For the complete documentation index, see [llms.txt](https://docs.targetpick.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.targetpick.io/for-ssp/report-api/banner.md).

# 배너 광고 리포트

{% hint style="info" %}
SSP :arrow\_right: DSP
{% endhint %}

본 문서는 TARGETPICK DSP(Demand Side Platform)와 연동한 SSP(Supply Side Platform) 파트너에게 리포트를 제공하기 위한 API 가이드 입니다. \
TARGETPICK 으로 DSP 리포트를 제공받기 위해서는 CJ 메조미디어 담당자에게 Token을 발급 받아야 사용이 가능합니다. API 사용을 위한 Token 발행은 지정 담당자에게 문의해주시기 바랍니다.

## **1. 리포트 데이터 요청**

| 기본 정보        | 설명                          |
| ------------ | --------------------------- |
| 서비스 API명     | SSP 제공 리포트 데이터              |
| API 호출 결과 타입 | XML or JSON                 |
| 인증 방법        | Token                       |
| 호출 방법        | HTTPS                       |
| API 설명       | SSP에 광고를 집행한 결과 리포트를 전달합니다. |

### **URL**

<table><thead><tr><th width="114">구분</th><th width="531">URL</th><th>Method</th></tr></thead><tbody><tr><td>테스트</td><td>http://211.62.152.212:9000/api/report</td><td>Get</td></tr><tr><td>상용</td><td>https://dsp-report.meba.kr:9000/api/report</td><td>Get</td></tr></tbody></table>

### **Parameters**

| Field      | 타입      | 필수 | 코드 예시         | 설명                                                                            |
| ---------- | ------- | -- | ------------- | ----------------------------------------------------------------------------- |
| sDate      | String  | Y  | 20160101      | 리포트 조회 시작일                                                                    |
| eDate      | String  | Y  | 20160131      | 리포트 조회 종료일                                                                    |
| PartnerID  | String  | Y  | userpartnerid | 메조미디어에서 발급한 파트너 고유 ID                                                         |
| Token      | String  | Y  | F379C8K9P0    | API 사용을 위한 파트너 고유 Token 값                                                     |
| ADType     | Integer | Y  | 1             | <ul><li>0: 전체</li><li>1: 배너</li></ul>                                         |
| ReportType | Integer | Y  | 1             | <ul><li>1: 일자별 리포트</li><li>2: 미디어별(PubID) 리포트</li><li>3: 광고 타입별 리포트</li></ul> |
| format     | String  | Y  | json          | json , xml                                                                    |

### **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. 리포트 데이터 응답**

기본 정보 - 리포트 API로 Request 시 아래의 양식으로 리포트 데이터가 반환됩니다.

| 이름             | 타입      | 전달 값 예시      | 설명                                                                                   |
| -------------- | ------- | ------------ | ------------------------------------------------------------------------------------ |
| ListCount      | Integer | 100          | 반환되는 리스트 행 수                                                                         |
| ReportType     | Integer | 1            | <p></p><ul><li>1: 일자별 리포트</li><li>2: 미디어별(PubID) 리포트</li><li>3: 광고 타입별 리포트</li></ul> |
| ADType         | Integer | banner       | banner: 배너                                                                           |
| Reports.Report | Array   |              |                                                                                      |
| Date           | String  | 20160101     | 리포팅 일자                                                                               |
| Imp            | Integer | 1000         | 노출 횟수                                                                                |
| Click          | Integer | 100          | 클릭 횟수                                                                                |
| CTR            | Double  | 10.00        | 노출 대비 클릭율                                                                            |
| PubID          | String  | publisher123 | <p>미디어를 식별할 수 있는 ID로 AppID 또는 SiteID<br>(난수 또는 암호화된 ID 가능)</p>                       |
| Revenue        | Double  | 100000       | 메조미디어에서 지급해야 할 인벤토리 구매 비용                                                            |

### 예제

{% tabs %}
{% tab title="일자별 리포트" %}
{% code lineNumbers="true" %}

```xml
<?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>
```

{% endcode %}
{% endtab %}

{% tab title="미디어별 리포트" %}
{% code lineNumbers="true" %}

```xml
<?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>
```

{% endcode %}
{% endtab %}

{% tab title="광고 타입별 리포트" %}
{% code lineNumbers="true" %}

```xml
<?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>
```

{% endcode %}
{% endtab %}
{% endtabs %}

## **3. Error Code**

<table><thead><tr><th width="155">Code</th><th>Descirption</th></tr></thead><tbody><tr><td>000</td><td>성공</td></tr><tr><td>001</td><td>시스템에 에러가 발생했습니다.</td></tr><tr><td>002</td><td>알 수 없는 오류가 발생했습니다.</td></tr><tr><td>003</td><td>조회 권한이 없습니다.</td></tr><tr><td>004</td><td>존재하지 않는 API 입니다.</td></tr><tr><td>005</td><td>Parameter 정보가 잘못되었습니다.</td></tr><tr><td>006</td><td>날짜는 반드시 입력해야 하며, 세 달을 초과 할 수 없습니다.</td></tr></tbody></table>

### 예제

{% tabs %}
{% tab title="에러 응답" %}
{% code lineNumbers="true" %}

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

{% endcode %}
{% endtab %}
{% endtabs %}