KOR레거시 리포팅 API
이 API에 대한 지원은 중단되었습니다. 2023년 6월 말부터 이 API는 사용이 불가능하며, 이후 리포트 용도로 Tapjoy GraphQL API를 사용하셔야 합니다.
1. 살펴보기
레거시 엔드 포인트는 클릭, 설치, 전환 및 기타 이벤트와 같은 메트릭에 대한 실시간 리포팅 데이터를 XML 및 JSON 형식으로 제공합니다.
광고주의 경우 기본 API 응답에는 활성화된 모든 오퍼에 대한 데이터 (Tapjoy 승인 및 광고주 활성화)가 포함됩니다. 활성화되지 않은 오퍼에 대한 데이터를 가져오려면 'all_offers = 1' 매개 변수를 사용하십시오 (아래 매개 변수 참조).
퍼블리셔의 경우 기본 API 응답에는 Tapjoy 광고가 송출된 모든 앱 ID에 대한 데이터가 포함됩니다. 앱 ID는 기본 광고 오퍼 ID로 사용되며 캠페인이 비활성화된 경우에도 데이터가 리포트 됩니다.
2. 리포팅 API 키
이는 Insights Reporting API 키와 다른 키입니다.
Tapjoy 대시 보드에서 레거시 리포팅 API 키는 다음 페이지에서 찾을 수 있습니다.
- 설정> 앱 설정> API Keys> 광고 Reporting용 API Key
"V2" Tapjoy 대시보드 (dashboard.tapjoy.com)를 사용하는 경우 https://dashboard.tapjoy.com/reporting/api 페이지에서 "Legacy Reporting API Key" 키를 찾을 수 있습니다.
궁금한 사항이 있으시면 Tapjoy AM 또는 지원하기에 문의하세요.
3. 요청 및 응답 예제
요청 URL의 형식에 따라 데이터가 XML 또는 JSON으로 반환되도록 요청할 수 있습니다. 요청에 포함될 수 있는 필수 및 선택 URL 파라미터 목록은 아래의 요청 파라미터 섹션을 참조하세요.
XML 요청 및 응답
https://api.tapjoy.com/reporting_data.xml?email=sample%40example.com&api_key=your_api_key&date=YYYY-MM-DD&page_size=50&page=2&timezone=0
응답:
<!--?xml version="1.0" encoding="UTF-8"?-->
YYYY-MM-DD
NUM
NUM
NUM
NUM
NUM
App Name
00000000-0000-0000-0000-000000000000
http://offer-destination-url.com
App Platform
true
VideoOffer
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0
0
0
66d2dd3-1111-443a-1ac3-764111aaa88
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
0
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
...
JSON 요청 및 응답
https://api.tapjoy.com/reporting_data.json?email=sample%40example.com&api_key=your_api_key&date=YYYY-MM-DD&page_size=5&page=9&timezone=-5
응답:
{
"Date" : "YYYY-MM-DD",
"Timezone" : NUM,
"TotalOffers" : NUM,
"PageSize" : NUM,
"TotalPages" : NUM,
"CurrentPage" : NUM,
"Apps" : [
{
"Name" : "App Name",
"AppKey" : "00000000-0000-0000-0000-000000000000",
"url" : "http://offer-destination-url.com",
"Platform" : "App Platform",
"Rewarded" : true,
"OfferType" : "VideoOffer",
"PaidInstalls" : 0,
"PaidInstallsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"PaidClicks" : 0,
"PaidClicksHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"Spend" : 0,
"SpendHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"Sessions" : 0,
"SessionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"NewUsers" : 0,
"NewUsersHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"DailyActiveUsers" : 0,
"OfferwallRevenue" : 0,
"OfferwallRevenueHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"OfferwallImpressions" : 0,
"OfferwallImpressionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"OfferwallClicks" : 0,
"OfferwallClicksHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"OfferwallConversions" : 0,
"OfferwallConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"FeaturedOfferRevenue" : 0,
"FeaturedOfferRevenueHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"FeaturedOfferImpressions" : 0,
"FeaturedOfferImpressionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"FeaturedOfferClicks" : 0,
"FeaturedOfferClicksHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"FeaturedOfferConversions" : 0,
"FeaturedOfferConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"TJMOfferwallRevenue" : 0,
"TJMOfferwallRevenueHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"TJMOfferwallImpressions" : 0,
"TJMOfferwallImpressionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"TJMOfferwallClicks" : 0,
"TJMOfferwallClicksHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"TJMOfferwallConversions" : 0,
"TJMOfferwallConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"DirectPlayRevenue" : 0,
"DirectPlayRevenueHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"DirectPlayImpressions" : 0,
"DirectPlayImpressionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"DirectPlayClicks" : 0,
"DirectPlayClicksHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"DirectPlayConversions" : 0,
"DirectPlayConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"Ecpa" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"EcpaAggregate" : 0,
"EcpaGoal" : 0,
"SecondaryConversions" : 0,
"SecondaryConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"SecondaryOfferItemId" : "000000-0000-0000-0000-00000000000",
"Event_A_Revenue" : 0,
"Event_A_RevenueHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"Event_A_Impressions" : 0,
"Event_A_ImpressionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"Event_A_Clicks" : 0,
"Event_A_ClicksHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"Event_A_Conversions" : 0,
"Event_A_ConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
},
...
]
}
4. 요청 파라미터
| Name | Values | Description |
|---|---|---|
| sample%40example.com | 파트너 계정/API 키와 연결된 URL 인코딩된 이메일 — **required** | |
| api\_key | e.g. "1ceb9db808404321b2dbc1e88cbef9cf" | 파트너 API 키 — **required** |
| date | e.g. YYYY-MM-DD | 데이터 요청 날짜 — **required** |
| page | e.g. 3 | 응답 데이터에 응답 메타데이터에 표시된 여러 페이지가 포함된 경우 페이지 번호를 지정하여 특정 페이지를 요청할 수 있습니다. 오퍼 수가 page\_size보다 큰 경우 결과의 첫 페이지가 기본값입니다. |
| page\_size | e.g. 50 | 응답 데이터 페이지당 리턴될 오퍼 수입니다. 기본값은 50입니다. |
| all\_offers | 1 | 응답에는 모든 활성화 및 비활성화 된 캠페인이 포함됩니다. — **이 파라미터가 없으면 활성화 된 오퍼만 리턴됩니다.** |
| timezone | e.g. 0 | GMT로부터의 시간대 오프셋. 지정되지 않은 경우 기본값은 계정 시간대입니다. |
5. 추가적인 고려사항
A. 요청 제한
이 API에 대한 요청은 분당 최대 하나의 요청으로 제한해야합니다.
B. 시간대
요청 URL에 시간대가 지정되지 않은 경우 반환되는 데이터는 계정에 지정된 시간대를 기준으로 합니다. timezone 파라미터는 원하는 시간대의 UTC 오프셋을 시간 (예 : 태평양 표준시의 경우 'timezone = -8') 또는 초 (예 : 태평양 표준시의 경우 'timezone = -28800')로 지정하는 정수로 지정합니다. 각 응답에는 'timezone' 필드가 포함되어 있으므로 결과가 반환되는 시간대를 확인할 수 있습니다.
C. 페이지네이션
이 피드는 한 번에 최대 100 개의 오퍼에 대한 데이터를 반환합니다. 추가 오퍼에 대한 데이터를 보려면 요청에 페이지 매개 변수를 제공하십시오. 각 응답에는 "TotalOffers", "PageSize", "TotalPages"및 "CurrentPage"가 포함되므로 모든 관련 오퍼 데이터를 검색 할 수 있습니다.