パブリッシャー向け Reporting API 2.0

コンテンツ

概要

この Reporting API を使用すると、パブリッシャーはダッシュボード上に表示されているデータにプログラムでアクセスできます。Reporting API キーは全アプリケーションに共通です。各アプリケーションに一意の Reporting API ID があり、この ID はそれぞれのアプリケーション ページで確認できます。

ホスト

ホスト: https://report.api.vungle.com/ext/pub/reports/performance

認証

セキュリティはリクエスト ヘッダーで処理されます。API キーは、Vungle ダッシュボードの [Reports] ページで確認できます。API キーをまだお持ちでない場合は、tech-support@vungle.com に E メールを送ってリクエストしてください。

リクエスト ヘッダー

キー 説明
Authorization: Bearer [API Key] API キー
Vungle-Version: 1 API バージョン
Accept: text/csv or application/json Accepted data format for results.Default is text/csv.

 

結果

  • 形式: JSON 出力と CSV 出力がサポートされます。
  • 日付範囲: 最大 6 か月分の履歴情報が使用可能です。それよりも古いデータを取得するには、アカウント マネージャーに E メール (tech-support@vungle.com) で連絡してください。
  • データがない場合: クエリーに使用できるデータがない場合は、empty 200 レスポンスが Vungle から返されます。これは、リクエストが正常に処理されたが、返すデータがないことを意味します。

リソース: GET /reports/performance

フィルタ パラメータ

パフォーマンス データのサブセットに結果を制限するには、フィルタ パラメータを使用します。大半のフィルタはオプションです。オプション フィルタの場合は、そのフィルタのすべての結果が返されます。

パラメータ名 形式 アクション 使用不可の場合
start ISO8601 date この日付以降のパフォーマンス データに結果セットを制限します リクエストを却下します start=2017-01-01
end ISO8601 date この日付以前のパフォーマンス データに結果セットを制限します リクエストを却下します end=2017-01-02 
country  ISO 3166-1 Alpha-2 国コードのカンマ区切りリスト リスト内の国と一致するパフォーマンス データのみを返します すべての国を返します

country=US

country=US,CA

country=US,CA,AU
applicationId  返される Vungle アプリケーション ID のカンマ区切りリスト リスト内のアプリケーションのパフォーマンス データのみ返します すべてのアプリケーションを返します

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
incentivized ‘true’/’false’ or 1/0 インセンティブ トラフィックまたはインセンティブなしトラフィックのパフォーマンス データのみ返します インセンティブとインセンティブなしの両方を返します

incentivized=true

incentivized=false

ディメンション パラメータ

レポートの緻密度を調整するには、ディメンションを使用します。ディメンションは、dimensions パラメータのカンマ区切りリストとして送信します。ディメンションを明示的にリクエストしなかった場合、レポートはそのディメンションで細分化されません。

ディメンション パラメータの使用

パラメータ名 形式
dimensions 次の表に示す特定の文字列のカンマ区切りリスト

dimensions=platform

dimensions=application,date,country

 

使用可能なディメンション

ディメンション
戻り値 戻り値の例
platform プラットフォーム文字列でグループ化されます
platform
iOS
application Vungle アプリケーション ID および名前でグループ化されます
application id application name
58086457cdf5f9eb6d000060 Sonic Dash
placement 広告配置 ID および名前でグループ化されます
placement id placement name
12345678 Level 3
date  日付でグループ化されます 
date
2017-01-01
country 国でグループ化されます
country
US
incentivized インセンティブ トラフィックでグループ化されます
incentivized
true
false

名前ルックアップを必要とするディメンションでは (たとえば、アプリケーション名)、Vungle でルックアップを取得できない場合に、名前の代わりに「Unknown」という文字列が返されます。

集計パラメータ

どのパフォーマンス データに関心があるかを定義するには、集計を使用します。集計は、aggregates パラメータのカンマ区切りリストとして送信します。集計をリストに含めなかった場合は、その集計データを受信することを希望していないものとみなされます。

集計パラメータの使用

パラメータ名 形式
aggregates 次の表に示す特定の文字列のカンマ区切りリスト

aggregates=views

aggregates=views,installs,ecpm

 

使用可能な集計

ディメンション
戻り値
views 整数
completes 整数
clicks  整数
revenue  整数
ecpm (パブリッシャー収益 * 1000 / 閲覧回数) を浮動小数点数として表したもの

  

クエリとレスポンスの例

例 1: JSON Revenue

リクエスト


curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

レスポンス


[
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "US",
        "views": 1234,
        "revenue": 123.0,
        "ecpm": 99.67,
    },
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "CA",
        "view": 35,
        "revenue": 2.0,
        "ecpm": 57.14,
    },
    ...
]

例 2: CSV Revenue

リクエスト


curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

レスポンス


Platform,date,country,views,revenue
ios,2017-03-01,US,1234,123.0
ios,2017-03-01,CA,35,2.0
...

Example 3: Placement

リクエスト

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET
"https://report.api.vungle.com/ext/pub/reports/performance?dimensions=placement&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

レスポンス


[
    {
        "placement id" : "12345678",
        "placement name": "level 3",
        "views": 1234,
        "revenue": 123.0
    }
]
他にご質問がございましたら、リクエストを送信してください

コメント