クイックスタート

この API は非推奨となりました。この API へのアクセスは 2023年6月下旬に停止され、それ以降はレポート取得のためには新しい GraphQL API を使う必要があります。

1. 認証

リクエストはOAuth2の標準的な二層認可フローを使用します: パブリシャーレポートAPIキーを利用してaccess_tokenを要求し、取得したaccess_tokenを利用してその後のリクエストの認証として使用します。アクセストークンの有効期間は一時間で、更新はできません。トークンが無効になった場合には、パブリシャーレポートAPIキーを利用して新しいアクセストークンを取得して下さい。

パブリシャーレポートAPIキーは管理者アカウントでログインした際(つまり、ダッシュボードのすべてのデータにアクセスできる権限のあるユーザ)にダッシュボードから取得できます(設定 -> アプリ設定 -> アプリ情報 -> API Keys)。そうでないユーザでログインした場合の値を使用すると、データがサーバには存在しても空のレスポンスが返ります。

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はすべてのリクエストの Authorizationヘッダに"Bearer"タイプとして送られる必要があります。アクセストークンが無効であったり含まれない場合は、レスポンスは401 Unauthorized ステータスとなります。トークンの有効期限は1時間です。

リクエスト例

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

注: プレイスメント別のレポートを取得する場合、本APIは呼びだし時点でアクティブもしくはLTVダッシュボードに存在しているプレイスメントのデータのみを返します。プレイスメントを削除すると、プレイスメントの過去のデータも削除されます(コンテンツ種類別のレポート取得には残ります)。

クイックスタート
1. 認証
2. リクエスト送信