ドキュメント

サポート

Unity Ads Monetization

Android developer monetization guide

iOS developer monetization guide

Privacy consent setup

Unity Ads Monetization

収益化の統計 API

Use the Monetization Stats API to programmatically access your ad performance data in CSV format for custom reporting and analysis.
読み終わるまでの所要時間 2 分
収益化の統計 API を使用すると, 収益化データを CSV 形式で直接取得できます。この API は, 開発者ダッシュボードに存在するものと同じ統計情報を取得しますが, これを使用することで独自の用途に合わせたプログラムでデータを取得できるようになります。

認証

ノート: 収益化の統計 API には組織 ID が必要です。この ID はプロジェクトを転送すると変更されます。 エンドポイントでは, Monetization (収益化) ダッシュボード にある API キーが使用されます。セカンダリナビゲーションメニューから Setup (設定) > API Access (API アクセス) を選択し, Monetization Stats API Access (収益化の統計 API のアクセス) セクションから API キーをコピーするか, 存在しない場合は Create Api Key (API キーを作成) を選択します。 API キーを 
"apikey=<token>"
クエリパラメーターとして, または認証ヘッダー 
"Authorization: Token <token>"
を使用して指定する必要があります。このリダイレクト URL はデータを取得します。これは, すべての HTTP クライアントでサポートされている標準的な HTTP の動作です。 認証に失敗した場合, 認証サーバーからは, HTTP/2 エラーコードとメッセージを含む本文で応答します。以下に例を示します。 
400 {"errors":[{"msg":"access token required"}]}

リクエストフォーマット

Unity Ads サービスから統計データを取得するには, 以下の GET リクエスト を使用します。ここで, 
<organizationId>
は Unity の組織の 組織コア ID です。 
GET
https://monetization.api.unity.com/stats/v1/operate/organizations/<organizationId>

クエリパラメーター

API ではさまざまな方法でデータを分割できます。一部はリクエストの成功のために必須です。

パラメーター

説明

必須?

apikey
ダッシュボードから取得した API 認証キー。いいえ (代わりに認証ヘッダーを利用します)
fields
以下の利用できるフィールドの列を定義するカンマ区切りのリスト。
  • adrequest_count
  • start_count
  • view_count
  • available_sum
  • revenue_sum
はい
groupBy
行を拡張し, 以下のフィールドでデータを分割するカンマ区切りのリスト。
  • placement
    (広告ユニット ID でデータを分割)
  • country
  • platform
  • game
    (ゲーム ID)
いいえ
scale
時間単位でデータを分割する値。1 日の区切りは 00:00 UTC となります。以下のオプションがサポートされます。
  • hour
    (時)
  • day
    (日)
  • week
    (週)
  • month
    (月)
  • year
    (年)
  • all
    (すべて)
はい
start
データセットの開始日時 (ISO 8601 形式)。
はい
end
データセットの終了日時 (ISO 8601 形式)。
はい
gameIds
結果のフィルターに使用するソースゲーム ID のカンマ区切りリスト。
いいえ
この API は CSV または JSON ファイルを返します。
"Accept"
ヘッダーで出力形式を以下のように指定します。
  • CSV の場合は 
    "Accept: text/csv"
    を使用します。
  • JSON の場合は 
    "Accept: application/json"
    を使用します。
以下に実際のパラメーター (組織コア ID と API キーのプレースホルダー以外) を使用したリクエスト例を示します。 
curl
https://monetization.api.unity.com/stats/v1/operate/organizations/:organizationId?groupBy=country,placement,platform,game&fields=adrequest_count,available_sum,revenue_sum,start_count,view_count&scale=hour&start=2020-05-01T00:00:00Z&end=2020-06-01T23:59:00Z&apikey=:apiKeyValue -H "Accept: text/csv" --output stats.csv

リクエストステータスコード

エンドポイントからリクエストの結果を示す以下のステータスコードが返されます。

コード

説明

200
リクエストが成功しました。
400
organizationId
, または別の必須のパラメーターがクエリから省略されていました。
401
API キーがリクエストにないか無効です。
404
組織が見つかりません。
408
リクエストがタイムアウトしました。
429
リクエストレート制限を超えました。
500
不明な理由でリクエストが失敗しました。
503
サービスを利用できません。
収益化の統計 API • Unity Grow • Unity Docs