시작하기

이 API에 대한 지원은 중단되었습니다. 2023년 6월 말부터 이 API는 사용이 불가능하며, 이후 리포트 용도로 Tapjoy GraphQL API를 사용하셔야 합니다.

1. 인증

요청은 표준 two-legged OAuth2 방식을 사용하여 인증됩니다. access_token은 Publisher Reporting API Key를 사용하여 요청되고 결과 access_token은 향후 요청을 인증할 때 사용됩니다. 액세스 토큰의 수명은 1시간이며 새로 고침할 수 없습니다. 토큰이 만료되면 API 키로 새 토큰을 요청하면됩니다.

Publisher Reporting API Key는 관리자 계정 (즉, 모든 대시 보드 데이터에 대한 전체 액세스 권한이있는 계정)으로 로그인 한 상태에서 "대시 보드> 설정> 앱 설정"을 통해 찾을 수 있습니다.

image_title

A. 요청 예시

POST /v1/oauth2/token
Host: api.tapjoy.com
Authorization: Basic [base_64(Publisher Reporting API Key)]
Accept: application/json; */*

B. 성공 응답

status 200
{
  "access_token": "token_string",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": null
}

C. 잘못된 자격 증명 응답

status 401
{
  "error": "Bad or missing authentication token"
}

2. 요청하기

access_token이 있으면 나머지 API를 요청할 수 있습니다. access_token은 "Bearer"유형으로 Authorization 헤더에 추가하여 모든 요청과 함께 전송되어야합니다. access_token이 만료되었거나 존재하지 않는 경우 응답은 401 Unauthorized 상태가 됩니다. 토큰은 일반적으로 1시간 동안 지속됩니다.

요청 예시

GET /v2/publisher/reports?
Host: api.tapjoy.com
Authorization: Bearer [Access token]
Accept: application/json; */*

참고: 플레이스먼트별 데이타 요청 시, API는 현재 활성화 상태이거나 LTV 대시보드 상에서 표시되고 있는 플레이스먼트의 데이타만 리턴합니다. 만일 플레이스먼트를 삭제했다면, 해당 플레이스먼트 관련 히스토리도 모두 삭제됩니다.(하지만 content_type 쿼리에는 계속 존재합니다)