KOR퍼블리셔 용 리포트 API
마지막 업데이트: 12/11/2024
개요
퍼블리셔는 리포트 API를 통해 오퍼월 관련 리포트 데이터를 가져올 수 있습니다.
시작하기 전에: API 인증 절차에 따라 인증을 진행해야 합니다. API 인증.
- 리포트 API를 통해 콘텐츠 관리를 하고자 할 경우 콘텐츠 관리.
- 에러 관리 및 리포트 API 관련 정보를 확인하고자 하는 경우 리포트 API 사용 예시.
퍼블리셔 리포트 항목
리포트 API는 오퍼월 콘텐츠의 클릭, 전환, 총 수익과 같은 퍼포먼스 데이터를 가져올 수 있습니다. 퍼블리셔 리포트 API에서 사용하는 항목은 아래 표를 통해 확인하실 수 있습니다.
시작으로 아래의 예시 쿼리를 기준으로 퍼포먼스 데이터를 가져오는 것을 권장합니다.
{
publisher {
placements(appId: "00000000-0000-0000-0000-000000000000") {
id
name
insights(
timeRange: {from: "YYYY-MM-DDT00:00:00Z", until: "YYYY-MM-DDT00:00:00Z"}
) {
timestamps
reports {
dailyUniqueViewers
earnings
}
}
}
}
}
| 항목 | 설명 | 국가 | 앱 그룹 | 퍼블리셔 앱 | 플레이스먼트 |
|---|---|---|---|---|---|
| averageDuc | 일별 유니크 사용자의 앱별, 플레이스먼트별, 오퍼월 카드별 광고 전환 퍙균값(하루를 기준 사용자 유니크 값 카운트) | x | x | x | x |
| arpdau | DAU 기준 일별 평균 수익 (총 수익 나누기 DAU) | x | x | x | |
| arpduv | 하루 유니크 오펴월 방문자 기준 일별 평균 수익 (총 수익 나누기 오퍼월 방문자 유니크 수(하루를 기준 방문자 유니크 값 카운트)) | x | x | x | |
| averageDau | DAU 기준 일별 평균 유저 수 | x | x | x | |
| averageDuv | 하루 유니크 오퍼월 방문자 기준 일별 평균 유저 수 | x | x | x | |
| clicks | 플레이스먼트 기준 클릭 수 | x | x | ||
| conversions | 플레이스먼트 기준 광고 전환 수 | x | x | ||
| dailyActiveUsers | DAU 수 | x | x | x | |
| dailyUniqueConversions | 일별 광고 전환 유니크 사용자 수 (현재는 오퍼월만 사용할 수 있습니다.) | x | x | ||
| dailyUniqueOfferwallEngagements | 일별 오퍼월 광고 전환 유니크 사용자 수 | x | x | x | |
| dailyUniqueOfferwallViewers | 일별 오퍼월 방문 유니크 사용자 수 | x | x | x | |
| dailyUniqueViewers | 일별 플레이스먼트, 콘텐츠 카드 유니크 방문자 수 (현재 오퍼월만 사용할 수 있습니다.) | x | x | ||
| ducduv | 일별 플레이스먼트, 콘텐츠 카드 유니크 광고 전환 사용자 수 (현재 오퍼월만 사용할 수 있습니다.) | x | x | x | x |
| duvDau | 일별 오퍼월 유니크 방문 횟수 | x | x | x | |
| earnings | 총 수익 | x | x | ||
| impressions | 플레이스먼트 기준 노출 수 | x | x | ||
| newUsers | 신규 사용자 수 | x | x | x | |
| offerwallViews | 오퍼월 노출 수Total number of offerwall open | x | x | x | |
| sessions | 앱 오픈 횟수 | x | x | x | |
| totalRevenue | 총 퍼블리셔 수익 | x | x | x |
추가적인 퍼블리셔 리포트 항목은 대시보드에서 확인할 수 있습니다.:
- Impressions/Views
- 전환율 (CVR)
- eCPM
세그멘트 항목
세그멘트 항목을 쿼리에 추가함으로써 API를 통해 앱별, 국가별, 플레이스먼트별 데이터를 확인하실 수 있습니다.
리포트 API는 아래의 세그멘트를 지원합니다.
- 국가
- id (앱 그룹 ID)
- id (퍼블리셔 앱 ID)
- 플레이스먼트
예시
국가별 분류
{
publisher {
placements(appId: "00000000-0000-0000-0000-000000000000") {
id
insights(timePreset: TODAY) {
timestamps
reports {
country
dailyUniqueViewers
}
}
}
}
}
앱 그룹별 분류
{
publisher {
apps(first: 3) {
nodes {
appGroupId
insights(timePreset: TODAY) {
reports {
dailyActiveUsers
}
}
}
}
}
}
엡 별 분류
query {
publisher {
apps(first:3) {
edges {
node {
name
insights(timePreset:TODAY) {
reports {
dailyActiveUsers
}
}
}
}
}
}
}
플레이스먼트 별 분류
{
publisher{
placements(appId: "00000000-0000-0000-0000-000000000000") {
id
name
insights(timePreset: TODAY) {
reports {
impressions
}
timestamps
}
}
}
}
필터링
쿼리에 필터를 추가하면 API는 해당 필터를 기준으로 한 리포트를 제공합니다. 필터는 아래를 기준으로 적용됩니다.
- appId (하나의 앱)
- apps (여러 앱)
- content
- timePreset
- timeRange
필터링 예시
앱을 기준으로 필터
{
publisher{
app(id: "<app ID>") {
id
name
insights(timePreset: TODAY) {
reports {
arpdau
}
timestamps
}
}
}
}
여러 앱을 기준으로 필터
{
publisher {
apps(first: 3) {
nodes {
id
platform
insights {
reports {
arpdau
totalRevenue
}
}
}
}
}
}
콘텐츠 카드 기준으로 필터
{
publisher {
placements(appId: "<app ID>") {
id
name
content(id: "<content ID>") {
id
type
insights(timePreset: TODAY) {
timestamps
reports {
earnings
}
}
}
}
}
}
타임셋 기준 필터
사전에 지정된 타임셋을 기준으로 필터링을 합니다. 해당 타임셋은 상대적 시간으로 쿼리를 입력한 시간을 기준으로 리포트를 제공합니다.
Options: LAST_30D, LAST_WEEK, TODAY, YESTERDAY.
Note: 데이터 분류를 위해서는 timeIncrement 을 추가합니다. 이는 DAILY, HOURLY, MONTHLY 옵션을 가집니다.
{
publisher {
placements(appId: “<app ID>”) {
content(id: “<content card ID>") {
insights(timePreset:LAST_30D, timeIncrement: DAILY) {
timestamps
reports {
dailyUniqueViewers
}
}
}
}
}
}
절대 시간 기준 필터
This limits results to the absolute time range specified.
최대 3개월치의 데이터를 가져올 수 있으며 최대 2년전의 데이터까지 가져올 수 있습니다.
Note: 데이터 분류를 위해서는 timeIncrement 을 추가합니다. 이는 DAILY, HOURLY, MONTHLY 옵션을 가집니다.
{
publisher {
placements(appId: “<app ID>”) {
content(id: “<content card ID>") {
insights(timeRange: {from: "2024-11-15T00:00:00Z", until: "2024-11-17T00:00:00Z"}, timeIncrement: DAILY) {
timestamps
reports {
dailyUniqueViewers
}
}
}
}
}
}