広告主向け Reporting API 1.0

Vincent Yao

2015年04月08日 06:54

概要

注意: Reporting API 1.0 は Vungle のレガシー API です。2017 年 7 月 5 日より前に発生したトランザクションのレポートに使用します。2017 年 7 月 5 日以降に発生したトランザクションについてはこちらに文書化されている Reporting API 2.0 を使用してください。

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

ホスト	リクエストヘッダー	API
`https://ssl.vungle.com`	`Content-Type: application/json`	セキュリティは、API キーをクエリパラメータとして渡すことによって処理されます。API キーは Vungle ダッシュボードで自動的に生成されます。 (キーを持っていない場合は、「Reporting API キーはどのように申請すればいいですか」を参照してください)。

広告主

リソース	パラメータ	説明
`GET /api/campaigns`	`key=[API Key] active=[true/false]`	所有しているキャンペーンのリストを返します。active が指定されている場合は、アクティブまたは非アクティブのキャンペーンのみが表示されるようフィルタリングされます。

レスポンスの例:

{
    "rate" : 0.01,
    "rateType" : "complete",
    "campaignId" : "51896da23436ae313c3939b9",
    "type" : "external",
    "name" : "Feed the Rat",
    "spent" : 2131
}

リソース	パラメータ	説明
`GET /api/campaigns/[Campaign ID]`	`key=[API Key] date=[YYYY-MM-DD]`	指定された日付の指定されたキャンペーンの統計を返します。

レスポンスの例:

{
    "clicks" : 1129,
    "completedViews" : 23080,
    "date" : "2012-08-19",
    "campaignId" : "51896da23436ae313c3939b9",
    "installs" : 590,
    "impressions" : 26722,
    "name" : "Feed the Rat",
    "views" : 26546,
    "dailySpend": 566
}

リソース	パラメータ	説明
`GET /api/campaigns/[Campaign ID]/installs`	`key=[API Key] start=[YYYY-MM-DD] end=[YYYY-MM-DD]`	指定された期間の指定されたキャンペーンに割り当てられたインストールのリストを返します。

レスポンスの例:

{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
},
{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
}

地理レベルのメトリック

リソース	パラメータ	説明
`GET /api/campaigns/[Campaign ID]/geo/[Country_Code]`	`key=[API Key] date=[YYYY-MM-DD] OR` `start=[YYYY-MM-DD] end=[YYYY-MM-DD]`	特定の国のキャンペーンの地理情報を返します。国は 2 文字の Country_Code (例: US) を使用して指定されます。'start' (開始日) と 'end' (終了日) パラメータ、または特定の 'date' (日付) どちらか (両方は不可) を使用して日付範囲を入力できます。

レスポンスの例:

{
 "date": "2015-07-08",
 "country": "US",
 "views": 34029,
 "completes": 32094,
 "clicks": 1822,
 "installs": 609,
 "spend": 582,
 "eRPM": 8.9
 }

リソース	パラメータ	説明
`GET /api/campaigns/[Campaign ID]/geo/all`	`key=[API Key] date=[YYYY-MM-DD] OR` `start=[YYYY-MM-DD] end=[YYYY-MM-DD]`	すべての国のキャンペーンの地理情報を返します。'start' (開始日) と 'end' (終了日) パラメータ、または特定の 'date' (日付) どちらか (両方は不可) を使用して日付範囲を入力できます。

レスポンスの例:

[
 {
 "date": "2015-07-08",
 "country": "US",
 "views": 34029,
 "completes": 32094,
 "clicks": 1822,
 "installs": 609,
 "spend": 582,
 "eRPM": 8.9
 },
 {
 "date": "2015-07-08",
 "country": "CA",
 "views": 34235,
 "completes": 3190,
 "clicks": 1509,
 "installs": 523,
 "spend": 498,
 "eRPM": 7.6
 }
]

クエリに使用できるデータがない場合は、空のレスポンスが 200 件返ってきます。これは、リクエストが正常に処理されたが、返すデータがないことを意味します。