베이직 리포팅 API (Basic Reporting API)

이 Reporting API는 JSON이나 CSV 형식에서 캠페인 데이터를 수집하는 데 사용할 수 있습니다.

요청 형식(Request Format)

리포트 요청은 HTTP GET을 통해 아래의 기본 URL로 전송되어야 합니다.

https://r.applovin.com/report

필수 매개변수

• api_key : 리포팅을 위한 광고주의 API key(즉, Report Key). 이 Report Key는 Reporting API 인증에 사용되며 계정(Account) 페이지의 ‘Keys’ 탭에서 찾을 수 있습니다. 만약 이 값이 없다면, support@applovin.com으로 메일을 보내주시기 바랍니다. 메일에는 반드시 계정에 등록된 이메일 정보가 있어야 합니다.
• start : 리포트의 시작일. ‘YYYY-MM-DD’ 형식이나 Unix timestamp 형식을 받습니다. (예: 2012-10-05 또는 1336608000. 90일 이내의 날짜만을 허용합니다.
• end : 리포트의 종료일.  ‘YYYY-MM-DD’ 형식이나 Unix timestamp 형식을 받습니다. (예: 2012-10-05 또는 1336608000 또는 now)
• format : 리포트 형식. json이나 csv 형식을 받습니다. 자세한 사항은 아래의 요청 형식을 참고하시기 바랍니다.
• columns : 콤마로 분리해 놓은 리포트 열 목록. 아래의 허용 열 정보를 참고하기 바랍니다. (예 : ad_id,date,campaign_name)
• report_type : 이 매개변수는 API가 ‘퍼블리셔’ 또는 ‘광고주’의 데이터에 반응하게 합니다. 이 값이 생략되어 있다면, API는 report_type=publisher를 기본값으로 갖게 됩니다.

선택 매개변수

• limit : 이 매개변수는 반환되는 행의 숫자에 제한을 둘 수 있습니다. (예 : 500)
• offset : 이 매개변수는 행 인출이 시작되는 오프셋(offset)을 설정할 수 있습니다. (예 : 100)
• having : 숫자값의 복잡한 필터링 작업을 할 수 있습니다. 이 매개변수는 숫자열, 비교연산자, 논리연산자를 URL로 인코딩한 값을 받습니다. (예 : impressions%20%3E%200%20AND%20revenue%20%3E%200 ("impressions > 0 AND revenue > 0") ) 주의사항 : 이 매개변수를 사용하면 반응 속도가 저하되고 타임아웃 될 확률이 높아집니다.

사용 가능한 퍼블리셔 열

• day: 리포팅 날짜
• hour: 리포팅 날짜의 시간(최근 30일 동안만 가능)
• impression: 노출 횟수
• clicks: 클릭 횟수
• ctr: 클릭 횟수/노출 횟수
• revenue: 수익
• ecpm: 노출 1000회당 수익
• country: 2자 국가코드
• ad_type: GRAPHIC, PLAY, VIDEO, REWARD, 또는 MRAID
• size:  광고 사이즈 (INTER, BANNER, MREC, LEADER, 또는 NATIVE)
• device_type: 휴대전화, 태블릿, 기타 등등
• platform:  안드로이드, iOS, 파이어 OS, tvOS
• application: 앱 이름
• package_name: 앱 패키지 이름 또는 번들 ID
• placement: 광고 게재 영역(Placement) 이름
• application_is_hidden: 대시보드에서 앱이 감추어져 있음
• zone: Zone 이름 (본인 계정에서 사용 가능한 경우)
• zone_id: Zone ID (본인 계정에서 사용 가능한 경우). Zone 사용에 관심이 있다면 계정 관리자에게 연락 바랍니다.

사용 가능한 광고주 열

• day: 데이터를 리포팅 하는 날짜
• impressions: 노출 횟수
• clicks: 클릭 횟수
• ctr: 클릭 횟수/노출 횟수
• conversions: 컨버전(설치) 횟수
• conversions_rate: 컨버전 횟수/클릭 횟수
• average_cpa: 컨버전 1회당 평균 비용
• average_cpc: 클릭 1회당 평균 비용
• ad: 광고 이름
• country: 2자 국가코드
• campaign:  캠페인 이름
• app_id_external: 암호화된 앱 ID (흔히 ‘사이트 ID’라고 불림)
• traffic_source: ‘AppLovin’, 즉 중개업체의 이름
• ad_type: GRAPHIC, VIDEO, 또는 PLAY
• cost: 광고 경비
• sales: 판매량 (수익 포스트백 설정이 필요함)  
• size:  광고 사이즈 (INTER, BANNER, MREC, LEADER, 또는 NATIVE)
• device_type: 휴대전화, 태블릿, 기타 등등
• platform:  안드로이드, iOS, 파이어 OS, tvOS
• campaign_package_name: 홍보 중인 앱 패키지 이름 또는 번들 ID
• campaign_id_external: 캠페인 이름이 바뀌더라도 바뀌지 않는, 캠페인을 지칭하는 고유 ID.  {CAMPAIGN_ID} click marco와 같은 값.
• campaign_ad_type: 광고 유형이 유저획득(UA)인 경우 ‘ua’를 반환하고 리타게팅(retargeting)인 경우 ‘rt’를 반환함.

열 필터링 하기

AppLovin Reporting API를 이용하면 어떤 열로든 리포트를 필터링 할 수 있습니다. 그럼으로써 어떤 필터에든 매칭되는 데이터를 탐색할 수 있습니다.

열 필터링을 하기 위해서는 다음의 URL 매개변수를 추가하십시오

filter_columnname=onefilter,anotherfilter,thirdfilter

예를 들어, 광고주가 안드로이드 플랫폼에서의 데이터만을 보고 싶은 경우 URL 매개변수는 다음과 같이 설정되어야 합니다: filter_platform=Android

리포트는 모든 열로 필터링이 가능합니다. 열 리스트는 위의 자료를 참고하십시오.

열 정렬

리포트 정렬(sorting)은 필터링과 매우 흡사한 방식으로 작동합니다.

예를 들어 campaign_name으로 리포트를 정렬하기 위해서는 다음의 URL 매개변수를 추가하십시오.

sort_campaign_name=ASC

오름차순인 경우 ‘ASC’, 내림차순인 경우 ‘DESC’ 값을 받습니다. 모든 정렬은 사전식(lexicographical) 정렬입니다.

리포트 형식

리포트는 두 개의 형식, JSON이나 CSV 형식으로 반환이 가능합니다.

시간대

Reporting API의 모든 데이터는 UTC(협정세계시)를 따릅니다.

요청 예시

광고주 요청의 예는 다음과 같습니다.

https://r.applovin.com/report?api_key=YOUR_API_KEY&start=2015-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,conversions,conversion_rate,app_id_external,cost,sales&format=json&report_type=advertiser

퍼블리셔 요청의 예는 다음과 같습니다.  

https://r.applovin.com/report?api_key=YOUR_API_KEY&start=2016-07-01&end=2016-07-07&columns=day%2Cplatform%2Ccountry%2Capplication%2Cpackage_name%2Csize%2Cad_type%2Cimpressions%2Cclicks%2Crevenue,device_type&having=impressions%20%3E%200%20AND%20revenue%20%3E%200&format=csv