애드팝콘 SSP Report API

애드팝콘 SSP 매체의 리포트 정보를 조회 가능하도록 제공하는 API 입니다.

white ip 등록을 위해 연동 전 IP를 애드팝콘 SSP 사업팀에 전달해주세요.

해당 API는 2024년 말 지원 종료 예정입니다. 이후 리포트 API는 https://adpopcornssp.gitbook.io/ssp-sdk/api/publisher-api-report 를 사용해주세요.

URL

• http://dev.ssp-web-apis.adpopcorn.com/v3/analytics/data/{company_key}?fromDate={from_date}&toDate={to_date}

Method

• GET

Content-Type

• application/json

Parameter

Parameter	설명	필수	예시
companyKey	리포트 조회할 회사키	Y	1234567
fromDate	시작일	Y	since=2019-01-01 또는 since=20190101
endDate	종료일	Y	until=2019-01-01 또는 until=20190101
country	국가별 데이터 포함 여부	N	0, 1 (default: 0)

제한사항

• 조회 기간은 최대 7일입니다.

• 시작일, 종료일이 포함되지 않은 경우 기본 값은 전일 포함 7일 입니다.

Response parameter

Name	Type	설명
count	int	레포트 row 수
items	array (ReportModel)	레포트 데이터 리스트
media	array (MediaModel)	미디어 메타 정보 리스트

ReportModel

Name	Type	설명	예시
click	int	클릭 수	100
impression	int	노출 수	1000
media_key	string	미디어 키	"123456"
placement_id	string	placement ID	"abcdefg"
report_type	int	1: DSP, 2: 애드서버, 4: 미디에이션	1
request	int	요청수 (일부 미디에이션의 경우 미제공)	0
response	int	응답수 (일부 미디에이션의 경우 미제공)	0
revenue	double	수익(USD)	100
thirdparty_name	string	서드파티 이름	"appier"
ymd	string	날짜	"20201022"
country	string	국가코드 (국가별 데이터 포함 여부 파라미터 사용 시)

MediaModel

Name	Type	설명	예시
key	string	미디어키	"12333444"
name	string	미디어명	"test_media"
placements	array (PlacementModel)	지면 메타 정보 리스트

PlacementModel

Name	Type	설명	예시
id	string	지면 id	"abcdefghijk"
name	string	지면 이름	"테스트 지면"
type	int	1: 배너, 2: 전면, 3: 네이티브, 4: 동영상	1

200

json

// Response
{
  "count": 0,
  "items": [
    {
      "click": 0,
      "impression": 0,
      "media_key": "123456790",
      "placement_id": "abcdefghijklmno",
      "report_type": 1,
      "request": 0,
      "response": 0,
      "revenue": 0,
      "thirdparty_name": "appier",
      "ymd": "20200101"
    }
  ],
  "media": [
    {
      "key": "123456789",
      "name": "TEST MEDIA",
      "placements": [
        {
          "id": "abcdefghijklmno",
          "name": "TEST PLACEMENT",
          "type": 1
        }
      ],
      "type": 1
    }
  ]
}