1. Vungle JP
  2. Advertising
  3. Performance

広告主用 Reporting API 2.0

Avatar
Vungle Agent
フォローする

概要

広告主はプログラム内でこの Reporting API を使用して、ダッシュボード上に表示されているデータにアクセスすることができます。Reporting API キーは、すべてのアプリケーションで同じです。各アプリケーションに一意の Reporting API ID が設定されています。この ID は、それぞれのアプリケーション ページで確認することができます。Reporting API キーは、こちらで確認することができます。

ホスト

spend エンドポイント
https://report.api.vungle.com/ext/adv/reports/spend
CPA エンドポイント
https://report.api.vungle.com/ext/adv/reports/CPA

認証

セキュリティは、リクエスト ヘッダー内で処理されます。API キーは、Vungle 広告主用ダッシュボードのアカウント ページに表示されます。API キーをお持ちでない場合は、電子メールで tech-support@vungle.com までお問い合わせください。認証エラーが発生する場合は、Vungle 広告主用ダッシュボードでキーを更新してください。

リクエスト ヘッダー

キー 値 説明
Authorization Bearer [API Key] API キー
Vungle-Version 1 API バージョン
Accept text/csv または application/json 結果として受け入れられるデータ形式。デフォルトのデータ形式は text/csv です。

結果

  • 形式: リクエスト ヘッダーで指定されている JSON および CSV 出力がサポートされます。
  • 日付の範囲: 最大 6 か月分の履歴情報を取得することができます。それよりも古いデータを取得する場合は、アカウント マネージャー (tech-support@vungle.com) に電子メールで問い合わせてください。
  • タイム ゾーン: デフォルトのタイム ゾーンは UTC です。現在変更できません。
  • 一致するデータがない場合: クエリーの条件に一致するデータがない場合は、応答として空の「200」レスポンス コードが Vungle から返されます。これは、リクエストは正常に処理されたが、返すデータがないことを表しています。

リソース: GET /reports/performance

フィルタ パラメータ

クエリーの結果を支出データのサブセットのみに制限するには、フィルタ パラメータを使用します。多くのフィルタはオプションです。省略されている場合は、そのフィルタに一致するすべての結果が返されます。

パラメータ名 形式 動作 使用不可の場合の動作 例
start ISO8601 date 結果セットを、この日付以降のデータのみに制限します リクエストを却下します start=2019-01-01
end ISO8601 date 結果セットを、この日付以前のデータのみに制限します リクエストを却下します end=2019-01-02
country ISO 3166-1 Alpha-2 国コードのカンマ区切りリスト リストアップされた国コードに一致する支出データのみを返します すべての国を返します すべての国のデータを返します
すべての国のデータを返します
country=US,CA,AU
applicationId 返される Vungle アプリケーション ID のカンマ区切りリスト リストアップされたアプリケーションに一致する支出データのみを返します すべてのアプリケーションを返します applicationId=586e201e242e3fd308000220
applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
campaignId Vungle キャンペーン ID のカンマ区切りリスト リストアップされたキャンペーンに一致するデータのみを返します すべてのキャンペーンのデータを返します campaignId=586e201e242e3fd308000220
campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0
creativeId Vungle クリエイティブ ID のカンマ区切りリスト リストアップされたクリエイティブに一致する支出データのみを返します すべてのクリエイティブのデータを返します creativeId=586e201e242e3fd308000220
creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0
siteID パブリッシャー サイト ID のカンマ区切りリスト リストアップされたサイトに一致する支出データのみを返します すべてのパブリッシャーのデータを返します siteId=586e201e242e3fd308000220
siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0
accountID パブリッシャー アカウント ID のカンマ区切りリスト リストアップされたアカウントに一致する支出データのみを返します すべてのアカウントのデータを返します account ID=58e71dd7294039844b0001c7
placementID パブリッシャー 配置 ID のカンマ区切りリスト リストアップされた広告配置に一致する支出データのみを返します すべての広告配置のデータを返します placementID=5bc9877224291f02aee8741c
eventModelType モデル タイプのカンマ区切りリスト リストアップされたタイプに一致する支出データのみを返します すべてのタイプのデータを返します eventModelType=ltv
eventModelType=CPA,ltv
adType 広告タイプのカンマ区切りリスト リストアップされた広告タイプに一致する支出データのみを返します すべての広告タイプのデータを返します adType=banner,mrec,video,fullscreen
adSize 広告サイズのカンマ区切りリスト リストアップされた広告サイズに一致する支出データのみを返します すべての広告サイズのデータを返します adsize=728x90,default,320x50,300x50

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

レポートの詳細度を設定するには、ディメンション パラメータを使用します。ディメンション パラメータは、dimensions パラメータのカンマ区切りリストとして指定します。ディメンション パラメータを明示的に指定しないと、レポートは細分化されません。

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

パラメータ名 形式 例
dimensions 以下の表に示す特定の文字列のカンマ区切りリストとして指定します dimensions=platform
dimensions=campaign,creative,date

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

ディメンション名 戻り値 サンプル戻り値 エンドポイント
platform プラットフォーム文字列でグループ化されます platform
iOS 		spend
application アプリケーション ID とアプリケーション名でグループ化されます application ID
58086457cdf5f9eb6d000060
application name
Toy Blast iOS 		spend
campaign キャンペーン ID とキャンペーン名でグループ化されます campaign ID
58086457cdf5f9eb6d000060
campaign name
Toy Blast iOS CA iPhone 		spend、CPA
date 日付でグループ化されます date
2019-01-01 		spend、CPA
country 国でグループ化されます country
US 		spend
creative クリエイティブ ID とクリエイティブ名でグループ化されます creative ID
58086457cdf5f9eb6d000060
creative name
Toy Blast Landscape IEC 		spend
site パブリッシャー アプリ オブジェクト ID とパブリッシャー名でグループ化されます site ID
58086457cdf5f9eb6d000060
site name
Sonic Dash iOS 		spend
eventModelType モデル タイプでグループ化されます ltv、cpa CPA
placement placementでグループ化されます placement_id 599306279c57ddf458005ee2 spend
adType adTypeでグループ化されます banner spend
adSize adSizeでグループ化されます 728x90 spend
eventNames eventNamesでグループ化されます Purchase,
first_purchase=22.000000		 CPA
eventHorizon eventHorizonでグループ化されます 3 CPA
modelTrainingWindow modelTrainingWindowでグループ化されます 21 CPA
campaignRateMax campaignRateMaxでグループ化されます 4.099999 CPA
campaignRateMin campaignRateMinでグループ化されます 2.399999 CPA
eventModelTarget eventModelTargetでグループ化されます 0.05 CPA
campaignRateStart campaignRateStartでグループ化されます 3.2 CPA

サイト名など、特定の名前を検索する必要があるディメンションでは、Vungle で名前の検索に失敗した場合に、名前の代わりに「Unknown」という文字列が返されます。

集計パラメータ

特定のパフォーマンス データを集計して表示するには、集計パラメータを使用します。集計パラメータは、aggregates パラメータのカンマ区切りリストとして指定します。リスト内に集計パラメータがない場合は、そのデータは送信されません。

集計パラメータの使用方法

パラメータ名 形式 例
aggregates 以下の表に示す特定の文字列のカンマ区切りリストとして指定します aggregates=views
aggregates=views,installs,ecpm

使用可能な集計

ディメンション名 戻り値 エンドポイント
views 整数 spend
completes 整数 spend
clicks 整数 spend
installs 整数 spend、CPA
spend 整数 spend、CPA
ecpm (支出 x 1000 / 閲覧回数) を浮動小数点数として表した値 spend
cpaActions 整数 CPA
ltvValue 浮動小数点数 CPA
ltvTarget 浮動小数点数 CPA
cpaTarget 浮動小数点数 CPA
d1rev 浮動小数点数 CPA
d3rev 浮動小数点数 spend
d7rev 浮動小数点数 spend
d14rev 浮動小数点数 spend
d15rev 浮動小数点数 spend
d30rev 浮動小数点数 spend
d1au 整数 spend
d3au 整数 spend
d7au 整数 spend
d14au 整数 spend
d15au 整数 spend
d30au 整数 spend
d1payers 整数 spend
d3payers 整数 spend
d7payers 整数 spend
d14payers 整数 spend
d15payers 整数 spend
d30payers 整数 spend

例 1: JSON Spend

リクエスト

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

応答

[ 
 { 
  "platform" : "iOS", 
  "date": "2019-01-01", 
  "country": "US", 
  "views": 1234, 
  "spend": 123.0 
 }, 
 { 
  "platform" : "Android", 
  "date": "2019-01-01", 
  "country": "CA", 
  "view": 35, 
  "spend": 2.0 
 }, ... 
]

例 2: CSV Spend

リクエスト

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

応答

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

例 3: ID/名前の拡張

リクエスト

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=campaign&aggregates=views,spend&start=2019-01-01&end=2019-01-01"

応答

[
 {
  "campaign id" : "12345678",
  "campaign name": "test campaign 1",
  "views": 1234,
  "spend": 123.0       
 }
]

Questions?

Need further assistance, feel free to reach out to us, we’re here to help!

リクエストを送信
この記事は役に立ちましたか？