Microsoft Store 分析 API の次のメソッドを使用して、特定の期間中のアプリケーションのプロモーション広告キャンペーンのパフォーマンス データとその他のオプションフィルターの集計概要を取得します。 このメソッドは、JSON 形式でデータを返します。
このメソッドは、パートナー センターの 広告キャンペーン レポート で提供されるデータと同じデータを返します。 広告キャンペーンの詳細については、「 アプリの広告キャンペーンを作成する」を参照してください。
広告キャンペーンの詳細を作成、更新、または取得するには、Microsoft Store プロモーション API で広告キャンペーンの管理方法を使用できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
特定のアプリの広告キャンペーンのパフォーマンス データを取得するには、 applicationId パラメーターを使用します。 開発者アカウントに関連付けられているすべてのアプリの広告パフォーマンス データを取得するには、applicationId パラメーターを省略します。
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | 広告キャンペーンのパフォーマンス データを取得するアプリの ストア ID 。 | いいえ |
開始日 | 日付 | 取得する広告キャンペーンのパフォーマンス データの日付範囲の開始日 (YYYY/MM/DD 形式)。 既定値は、現在の日付から 30 日を引いた値です。 | いいえ |
終了日 | 日付 | 取得する広告キャンペーンのパフォーマンス データの日付範囲の終了日 (YYYY/MM/DD 形式)。 既定値は、現在の日付から 1 日を引いた値です。 | いいえ |
ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 サポートされているフィルターは campaignId のみです。 各ステートメントは、eq または ne 演算子を使用できます。ステートメントは、、、、またはを使用して結合できます。
フィルター パラメーターの例を次に示します:filter=campaignId eq '100023' 。 |
いいえ |
集約レベル | ひも | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます: |
いいえ |
オーダーバイ (orderby) | ひも | 広告キャンペーンの成果データの結果データ値を順序付けるステートメント。 構文は orderby=field [order],field [order],...です。 フィールド パラメーターには、次のいずれかの文字列を指定できます。
order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。 既定値は asc こちらに orderby 文字列の例を示します: orderby=date,campaignId |
いいえ |
グループバイ | ひも | 指定したフィールドにのみデータ集計を適用するステートメント。 次のフィールドを指定できます。
groupby パラメーターは aggregationLevel パラメーターと共に使用できます。 例: &groupby=applicationId&aggregationLevel=week |
いいえ |
要求の例
次の例では、広告キャンペーンのパフォーマンス データを取得するためのいくつかの要求を示します。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>
[応答]
応答内容
価値 | タイプ | 説明 |
---|---|---|
価値 | 配列 | 広告キャンペーンの集計パフォーマンス データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、以下の キャンペーンパフォーマンスオブジェクト のセクションを参照してください。 |
@nextLink | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 5 に設定されているが、クエリのデータ項目が 5 個を超える場合、この値が返されます。 |
トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
キャンペーンパフォーマンスオブジェクト
Value 配列内の要素には、次の値が含まれています。
価値 | タイプ | 説明 |
---|---|---|
日付 | ひも | 広告キャンペーンの成果データにおける日付範囲の開始日。 要求で 1 日を指定した場合、この値はその日付になります。 要求で週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
アプリケーションID | ひも | 広告キャンペーンのパフォーマンス データを取得するアプリのストア ID。 |
キャンペーンID | ひも | 広告キャンペーンの ID。 |
lineId | ひも | このパフォーマンスデータを生成した広告キャンペーンID 配信ライン。 |
通貨コード | ひも | キャンペーン予算の通貨コード。 |
費やす | ひも | 広告キャンペーンに費やされた予算額。 |
感想 | 長い | キャンペーンの広告インプレッション数。 |
インストールする | 長い | キャンペーンに関連するアプリのインストール数。 |
クリック | 長い | キャンペーンの広告クリック数。 |
iapInstalls | 長い | キャンペーンに関連するアドオン (アプリ内購入または IAP とも呼ばれます) のインストール数。 |
アクティブユーザー | 長い | キャンペーンの一部である広告をクリックし、アプリに戻ったユーザーの数。 |
応答の例
次の例は、この要求の JSON 応答本文の例を示しています。
{
"Value": [
{
"date": "2015-04-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "4568",
"lineId": "0001",
"currencyCode": "USD",
"spend": 700.6,
"impressions": 200,
"installs": 30,
"clicks": 8,
"iapInstalls": 0,
"activeUsers": 0
},
{
"date": "2015-05-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "1234",
"lineId": "0002",
"currencyCode": "USD",
"spend": 325.3,
"impressions": 20,
"installs": 2,
"clicks": 5,
"iapInstalls": 0,
"activeUsers": 0
}
],
"@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
"TotalCount": 1917
}
関連トピック
- アプリの広告キャンペーンを作成する
- Microsoft Store サービスを使用して広告キャンペーンを実行する
- Microsoft Store サービス を使用して分析データにアクセスする