Xbox 開発者ポータル (XDP) を通じて取り込まれ、XDP 分析ダッシュボードで利用できる UWP アプリと Xbox One ゲームに関する集計入手データを JSON 形式で取得するには、Microsoft Store 分析 API のこのメソッドを使います。
注
この API では、2016 年 10 月 1 日より前の日次集計データは提供されません。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使用する Azure AD アクセス トークンを取得します。 アクセス トークンを取得したら、期限が切れる 60 分が経過する前に使用します。 トークンの有効期限が切れたら新しいトークンを取得できます。
要求
要求の構文
| メソッド | 要求 URI |
|---|---|
| 取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions |
要求ヘッダー
| ヘッダ | タイプ | 説明 |
|---|---|---|
| 承認 | ひも | 必須。
Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
| パラメーター | タイプ | 説明 | 必須 |
|---|---|---|---|
| アプリケーションID | ひも | 入手データを取得する Xbox One ゲームの製品 ID。 ゲームの製品 ID を取得するには、XDP 分析プログラムで目的のゲームに移動し、URL から製品 ID を取得します。 または、パートナー センターの分析レポートから入手データをダウンロードした場合は、製品 ID は .tsv ファイルに含まれています。 | あり |
| 開始日 | 日付 | 取得する入手データの日付範囲の開始日。 既定値は、現在の日付です。 | いいえ |
| 終了日 | 日付 | 取得する入手データの日付範囲の終了日。 既定値は、現在の日付です。 | いいえ |
| フィルター | ひも | 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントには応答本文からのフィールド名、および eq または ne 演算子と関連付けられた値が含まれ、ステートメントは と 、または と を使用して結合することができます。 フィルター パラメーターの文字列値は、一重引用符で囲む必要があります。 例えば、filter=market eq 'US' and gender eq 'm' のように記述します。 以下の応答本文からのフィールドを指定することができます。
|
いいえ |
| 集約レベル | ひも | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 指定しない場合、既定値は day です。 | いいえ |
| オーダーバイ (orderby) | ひも | 各取得の結果データ値を並べ替えるステートメント。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
|
いいえ |
| グループバイ | ひも | 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。
|
いいえ |
要求の例
以下は、Xbox One ゲームの入手データを取得する要求の例です。 applicationId 値を、目的のゲームの製品 ID で置き換えてください。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions?applicationId=9WZDNCRFHXHT&startDate=1/1/2017&endDate=2/1/2019&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions?applicationId=9WZDNCRFHXHT&startDate=1/1/2017&endDate=2/1/2019&skip=0&filter=market eq 'US' and gender eq 'm' HTTP/1.1
Authorization: Bearer <your access token>
回答
応答本文
| [値] | タイプ | 説明 |
|---|---|---|
| [値] | 配列 | ゲームの入手データの集計を含むオブジェクトの配列。 各オブジェクトのデータの詳細については、以下の「入手値」セクションを参照してください。 |
| トータルカウント | 整数 (integer) | クエリの結果データ内の行の総数です。 |
入手値
Value 配列の要素には、次の値が含まれます。
| [値] | タイプ | 説明 |
|---|---|---|
| 日付 | ひも | 入手データの日付範囲の最初の日付。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
| アプリケーションID | ひも | 入手データを取得する Xbox One ゲームの製品 ID。 |
| アプリケーション名 | ひも | ゲームの表示名。 |
| 取得タイプ | ひも | 以下のいずれかの文字列で、入手タイプを示します。
|
| 年齢 | ひも | 以下のいずれかの文字列で、入手したユーザーの年齢層を示します。
|
| デバイスタイプ | ひも | 以下のいずれかの文字列で、入手が行われたデバイスのタイプを示します。
|
| ジェンダー | ひも | 以下のいずれかの文字列で、入手したユーザーの性別を示します。
|
| 市場 | ひも | 入手が発生したマーケットの ISO 3166 国コード。 |
| osVersion (英語) | ひも | 入手が発生した OS のバージョン。 このメソッドでは、Windows 10 または Windows 11 のいずれかになります。 |
| 支払手段タイプ | ひも | 以下のいずれかの文字列で、入手に使用された支払指示を示します。
|
| sandboxId | ひも | ゲーム用に作成されたサンドボックス ID。 これは値 RETAIL またはプライベート サンドボックス ID になります。 |
| ストアクライアント | ひも | 以下のいずれかの文字列で、入手が発生したストアのバージョンを示します。
|
| xboxTitleId | ひも | Xbox Live 対応ゲームに Xbox 開発者ポータル (XDP) によって割り当てられた Xbox Live タイトル ID (16 進数で表示)。 |
| 取得数量 | 数値 | 指定された集計レベルで発生した入手の数。 |
| 購入価格USD金額 | 数値 | ユーザーが入手で支払った金額 (各月の為替レートで米国ドルに変換)。 |
| 購入税USD額 | 数値 | 入手に適用された税額 (米国ドルに変換)。 |
| 現地通貨コード | ひも | パートナー センター アカウントの国/地域に基づく現地通貨コード。 |
| xbox製品ID | ひも | XDP からの製品の Xbox 製品 ID (該当する場合)。 |
| 可用性ID | ひも | XDP からの製品の可用性 ID (該当する場合)。 |
| スクイド | ひも | XDP からの製品の SKU ID (該当する場合)。 |
| skuDisplayName | ひも | XDP からの製品の SKU 表示名 (該当する場合)。 |
| Xbox親製品ID | ひも | XDP からの製品の Xbox 親製品 ID (該当する場合)。 |
| 親製品名 | ひも | XDP からの製品の親製品名 (該当する場合)。 |
| 製品タイプ名 | ひも | XDP からの製品の製品タイプ名 (該当する場合)。 |
| 購入税タイプ | ひも | XDP からの製品の物品税の種類 (該当する場合)。 |
| 購入価格現地通貨額 | 数値 | XDP からの製品の購入価格の現地金額 (該当する場合)。 |
| 購入税の現地金額 | 数値 | XDP からの製品の物品税の現地金額 (該当する場合)。 |
応答の例
この要求の JSON 返信の本文の例を次に示します。
{
"Value": [
{
"date": "2019-01-15T01:00:00.0000000Z",
"applicationId": "9WZDNCRFHXHT",
"applicationName": null,
"acquisitionType": "Paid",
"age": null,
"deviceType": "Phone",
"gender": null,
"market": "US",
"osVersion": "Windows 11",
"paymentInstrumentType": null,
"sandboxId": "RETAIL",
"storeClient": "Microsoft Store (client)",
"xboxTitleId": null,
"localCurrencyCode": "USD",
"xboxProductId": null,
"availabilityId": "B42LRTSZ2MCJ",
"skuId": "0010",
"skuDisplayName": null,
"xboxParentProductId": null,
"parentProductName": null,
"productTypeName": "Game",
"purchaseTaxType": "TaxesNotIncluded",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 3.08,
"purchasePriceLocalAmount": 3.08,
"purchaseTaxUSDAmount": 0.09,
"purchaseTaxLocalAmount": 0.09
}
],
"@nextLink": null,
"TotalCount": 12221
}