ゲームとアプリの入手データを取得する
Xbox 開発者ポータル (XDP) を通じて取り込まれ、XDP 分析ダッシュボードで利用できる UWP アプリと Xbox One ゲームに関する集計入手データを JSON 形式で取得するには、Microsoft Store 分析 API のこのメソッドを使います。
Note
この API では、2016 年 10 月 1 日より前の日次集計データは提供されません。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
要求
要求の構文
認証方法 | 要求 URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions |
要求ヘッダー
Header | 型 | 説明 |
---|---|---|
承認 | string | 必須。 Bearer <token> の形式の Azure AD アクセス トークンです。 |
要求パラメーター
パラメーター | 型 | 内容 | 必須 |
---|---|---|---|
applicationId | string | 入手データを取得する Xbox One ゲームの製品 ID。 ゲームの製品 ID を取得するには、XDP 分析プログラムで目的のゲームに移動し、URL から製品 ID を取得します。 または、パートナー センターの分析レポートから入手データをダウンロードした場合は、製品 ID は .tsv ファイルに含まれています。 | はい |
startDate | 日付 | 取得する入手データの期間の開始日。 既定値は現在の日付です。 | いいえ |
endDate | 日付 | 取得する入手データの期間の終了日。 既定値は現在の日付です。 | いいえ |
filter | string | 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントでは応答本文のフィールド名と値が eq 演算子または ne 演算子で関連付けられ、ステートメントは and または or を使用して組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 たとえば、filter=market eq 'US' and gender eq 'm'。 応答本文から次のフィールドを指定できます。
|
いいえ |
aggregationLevel | string | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 指定しない場合、既定値は day です。 | No |
orderby | string | 入手のそれぞれに対する結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
|
No |
groupby | string | 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。
|
いいえ |
要求の例
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>
回答
応答本文
値 | 種類 | 説明 |
---|---|---|
値 | 配列 | ゲームの集計入手データが格納されているオブジェクトの配列。 各オブジェクト内のデータの詳細については、以下の「入手の値」セクションを参照してください。 |
TotalCount | 整数 (integer) | クエリの結果データ内の行の総数です。 |
取得金額
Value 配列の要素には、次の値が含まれます。
値 | 種類 | 説明 |
---|---|---|
date | string | 入手データの期間の最初の日付。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
applicationId | string | 入手データを取得する Xbox One ゲームの製品 ID。 |
applicationName | string | ゲームの表示名です。 |
acquisitionType | string | 入手の種類を示す次のいずれかの文字列。
|
年齢 | string | 入手を行ったユーザーの年齢グループを示す次のいずれかの文字列。
|
deviceType | string | 入手を完了したデバイスの種類を指定する、次のいずれかの文字列。
|
性別 | string | 入手を行ったユーザーの性別を指定する次のいずれかの文字列。
|
market | string | 入手が行われた市場の ISO 3166 国コード。 |
osVersion | string | 入手が行われた OS バージョン。 このメソッドでは、この値は常に Windows 10 または Windows 11 のいずれかになります。 |
paymentInstrumentType | string | 入手に使用される支払指示を示す次のいずれかの文字列。
|
sandboxId | string | ゲーム用に作成されたサンドボックス ID。 これは値 RETAIL またはプライベート サンドボックス ID になります。 |
storeClient | string | 入手が行われた Microsoft Store のバージョンを示す次のいずれかの文字列。
|
xboxTitleId | string | Xbox Live 対応ゲーム用に Xbox 開発者ポータル (XDP) によって割り当てられた Xbox Live タイトル ID (16 進値で表されます)。 |
acquisitionQuantity | 数値 | 指定した集計レベルで発生した入手の数。 |
purchasePriceUSDAmount | 数値 | 毎月の為替レートを使用して USD に換算された、入手に対して顧客が支払った金額。 |
purchaseTaxUSDAmount | 数値 | 入手に適用された税額 (USD に換算)。 |
localCurrencyCode | string | パートナー センター アカウントの国に基づくローカル通貨コード。 |
xboxProductId | string | XDP からの製品の Xbox 製品 ID (該当する場合)。 |
availabilityId | string | XDP からの製品の可用性 ID (該当する場合)。 |
skuId | string | XDP からの製品の SKU ID (該当する場合)。 |
skuDisplayName | string | XDP からの製品の SKU 表示名 (該当する場合)。 |
xboxParentProductId | string | XDP からの製品の Xbox 親製品 ID (該当する場合)。 |
parentProductName | string | XDP からの製品の親製品名 (該当する場合)。 |
productTypeName | string | XDP からの製品の製品タイプ名 (該当する場合)。 |
purchaseTaxType | string | XDP からの製品の物品税の種類 (該当する場合)。 |
purchasePriceLocalAmount | 数値 | XDP からの製品の購入価格の現地金額 (該当する場合)。 |
purchaseTaxLocalAmount | 数値 | 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
}