광고주용 API 2.0 보고

목차

개요

보고 API는 광고주가 프로그래밍 방식을 대시보드에 있는 데이터에 액세스할 수 있게 해줍니다. 보고 API 키는 모든 앱에서 동일하게 사용됩니다. 앱마다 고유한 보고 API ID가 있으며, 이는 해당 애플리케이션 페이지에서 확인할 수 있습니다.

호스트

호스트: https://report.api.vungle.com/ext/adv/reports/spend

인증

보안은 요청 헤더에서 처리됩니다. Vungle 대시보드의 보고서 페이지에서 API 키를 찾습니다. API가 아직 없는 경우, tech-support@vungle.com로 이메일을 보내 새로 신청합니다.

요청 헤더

밸류 설명
Authorization: Bearer [API Key] API 키
Vungle-Version: 1 API 버전
Accept: text/csv 또는 application/json 결과에 대해 허용된 데이터 포멧. 기본값은 text/csv입니다.

 

결과

  • 포멧: 요청 헤더에서 지정한 JSON 및 CSV 출력이 지원됩니다.
  • 데이터 범위: 과거 정보는 최대 6개월 동안 이용할 수 있습니다. 이전 데이터를 검색하려면 tech-support@vungle.com으로 계정 관리자에게 이메일을 보내십시오.
  • 데이터가 없는 경우: 쿼리에 사용할 수 있는 데이터가 없으면 Vungle이 빈 200 응답을 반환합니다. 이는 요청은 성공했지만 반환할 수 있는 데이터가 없다는 의미입니다.

자료: GET /reports/spend

필터 매개 변수

필터 매개 변수를 사용하여 결과를 소비 데이터의 하위 집합으로 제한합니다. 대부분의 필터는 선택사항이며, 이 경우 Vungle은 해당 필터의 결과를 모두 반환합니다.

매개 변수 이름 포멧 액션 사용 불가능한 경우
start ISO8601 날짜 결과 집합을 해당 날짜 이후의 소비 데이터로 제한합니다. 요청 거부 start=2017-01-01
end ISO8601 날짜 결과 집합을 해당 날짜 이전의 소비 데이터로 제한합니다. 요청 거부 end=2017-01-02 
country  쉼표로 구분된 ISO 3166-1 Alpha-2 국가 코드 목록 표시된 국가와 일치하는 소비 데이터만 반환합니다. 모든 국가를 반환합니다.

country=US

country=US,CA

country=US,CA,AU
applicationId  쉼표로 구분된 반환할 Vungle 애플리케이션 ID 목록 표시된 애플리케이션에 대한 소비 데이터만 반환합니다. 모든 애플리케이션을 반환합니다.

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
campaignId  쉼표로 구분된 Vungle 캠페인 ID 목록 표시된 캠페인에 대한 소비 데이터만 반환합니다. 모든 캠페인을 반환합니다.

campaignId=586e201e242e3fd308000220

campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0

creativeId  쉼표로 구분된 Vungle 광고소재 ID 목록 표시된 광고소재에 대한 소비 데이터만 반환합니다. 모든 광고소재를 반환합니다.

creativeId=586e201e242e3fd308000220

creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0

siteID 쉼표로 구분된 게시자 앱 객체 ID 목록 표시된 애플리케이션에 대한 소비 데이터만 반환합니다. 모든 게시자를 반환합니다.

siteId=586e201e242e3fd308000220

siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0

측정 기준 매개 변수

측정 기준을 사용해 보고서를 세분화합니다. 측정 기준을 측정 기준 매개 변수에서 쉼표로 구분된 목록으로 보냅니다. 명시적으로 측정 기준을 요청하지 않으면 Vungle은 보고서를 해당 측정 기준별로 세분화하지 않습니다.

측정 기준 매개 변수 사용하기

매개 변수 이름 포멧
dimensions 쉼표로 구분된 특정 문자열 목록(아래 표 참조)

dimensions=platform

dimensions=campaign,creative,date

 

사용 가능한 측정 기준

측정 기준 
이름
반환 반환 예시
platform 플랫폼 문자열별로 그룹화
platform
iOS
campaign 캠페인 ID 및 캠페인 이름별로 그룹화
campaign id campaign name
58086457cdf5f9eb6d000060 Toy Blast iOS CA iPhone
date  날짜별로 그룹화
date
2017-01-01
country 국가별로 그룹화
country
US
creative 광고소재 ID 및 광고소재 이름별로 그룹화
creative id creative name
58086457cdf5f9eb6d000060 Toy Blast Landscape IEC
site 게시자 앱 객체 ID 및 게시자 앱 이름별로 그룹화
site id site name
58086457cdf5f9eb6d000060 Sonic Dash iOS

 

이름 검색이 필요한 측정 기준(예: 사이트 이름)에서는 Vungle에서 검색할 수 없는 경우 이름 대신 '알 수 없음'문자열을 반환합니다.

집합 매개 변수

집합을 사용하여 관심있는 실적 데이터를 정의합니다. 집합을 집합 매개 변수에서 쉼표로 구분된 목록으로 보냅니다. 집합이 목록에 없는 경우 Vungle은 귀하가 해당 데이터를 받지 않으려 한다고 가정합니다.

집합 매개 변수 사용하기

매개 변수 이름 포멧
aggregates 쉼표로 구분된 특정 문자열 목록(아래 표 참조)

aggregates=views

aggregates=views,installs,ecpm

 

사용 가능한 집합

측정 기준 
이름
반환
views integer
completes integer
clicks  integer 
installs  integer
spend  integer
ecpm (소비* 1000 / 시청) 플로트

 

쿼리 및 응답 샘플

예1: JSON 소비

요청

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?apiKey=987654321&dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

응답


[
    {
        "platform" : "iOS",
        "date": "2016-09-29",
        "country": "US",
        "views": 1234,
        "spend": 123.0       
    },
    {
        "platform" : "Android",
        "date": "2016-09-29",
        "country": "CA",
        "view": 35,
        "spend": 2.0
    },
    ...
]

예2: CSV 소비

요청

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

응답

Platform,date,country,views,spend
ios,2017-03-01,US,1234,123.0
ios,2017-03-01,CA,35,2.0

Example 3: ID/Name Expansion

요청

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=campaign&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

응답


[
    {
        "campaign id" : "12345678",
        "campaign name": "test campaign 1",
        "views": 1234,
        "spend": 123.0       
    }
]
또 다른 질문이 있으십니까? 문의 등록

댓글