ゲームとアプリのアドオン入手データを取得する

  • [アーティクル]

Xbox 開発者ポータル (XDP) を通じて取り込まれ、XDP 分析パートナー センター ダッシュボードで利用できる UWP アプリと Xbox One ゲームに関する集計アドオン入手データを JSON 形式で取得するには、Microsoft Store 分析 API のこのメソッドを使います。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。

Note

この API では、2016 年 10 月 1 日より前の日次集計データは提供されません。

要求

要求の構文

認証方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions

要求ヘッダー

Header 型 説明
承認 string 必須。 Bearer<token> の形式の Azure AD アクセス トークン。

要求パラメーター

applicationId または addonProductId パラメーターが必要です。 アプリに登録されているすべてのアドオンの入手データを取得するには、applicationId パラメーターを指定します。 単一のアドオンの入手データを取得するには、addonProductId パラメーターを指定します。 両方を指定した場合、applicationId パラメーターは無視されます。

パラメーター Type 内容 必須
applicationId string 入手データを取得する Xbox One ゲームの productId。 ゲームの productId を取得するには、XDP 分析プログラムで目的のゲームに移動し、URL から productId を取得します。 または、パートナー センターの分析レポートから入手データをダウンロードした場合は、productId は .tsv ファイルに含まれています。 はい
addonProductId string 入手データを取得するアドオンの productId。 はい
startDate 日付 取得するアドオン入手データの期間の開始日。 既定値は現在の日付です。 いいえ
endDate 日付 取得するアドオン入手データの期間の終了日。 既定値は現在の日付です。 いいえ
filter string 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントでは応答本文のフィールド名と値が eq 演算子または ne 演算子で関連付けられ、ステートメントは and または or を使用して組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 たとえば、filter=market eq 'US' and gender eq 'm'。
応答本文から次のフィールドを指定できます。
  • acquisitionType
  • age
  • storeClient
  • gender
  • market
  • osVersion
  • deviceType
  • sandboxId
 いいえ
aggregationLevel string 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 指定しない場合、既定値は day です。 No
orderby string 各アドオン入手の結果データ値の順序を指定するステートメント。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
  • date
  • acquisitionType
  • age
  • storeClient
  • gender
  • market
  • osVersion
  • deviceType
  • orderName
order パラメーターはオプションであり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。
orderby 文字列の例: orderby=date,market		 No
groupby string 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。
  • date
  • applicationName
  • addonProductName
  • acquisitionType
  • age
  • storeClient
  • gender
  • market
  • osVersion
  • deviceType
  • paymentInstrumentType
  • sandboxId
  • xboxTitleIdHex
返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。
  • date
  • applicationId
  • addonProductId
  • acquisitionQuantity
groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。 例: &groupby=age,market&aggregationLevel=week		 いいえ

要求の例

アドオン入手データを取得するための要求の例を、いくつか次に示します。 addonProductId と applicationId の値を、アドオンまたはアプリの適切なストア ID に置き換えてください。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions?applicationId=9WZDNCRFJ314&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1 

Authorization: Bearer <your access token> 

 

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions?applicationId=9WZDNCRFJ314&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0&filter=market eq 'GB' and gender eq 'm' HTTP/1.1 

Authorization: Bearer <your access token>

回答

応答本文

値 種類 説明
値 配列 アドオン入手集計データが格納されているオブジェクトの配列。 各オブジェクト内のデータの詳細については、以下の「アドオン入手値」セクションを参照してください。
TotalCount int クエリの結果データ内の行の総数です。

アドオン入手値

Value 配列の要素には、次の値が含まれます。

値 種類 説明
date string 入手データの期間の最初の日付。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。
addonProductId string 入手データを取得するアドオンの productId。
addonProductName string アドオンの表示名 この値は、aggregationLevel パラメーターが day に設定されている場合にのみ応答データに表示されます (ただし、groupby パラメーターに addonProductName フィールドを指定していない場合)。
applicationId string アドオン入手データを取得するアプリの productId。
applicationName string ゲームの表示名です。
deviceType string 入手を完了したデバイスの種類を指定する、次のいずれかの文字列。
  • "PC"
  • "Phone"
  • "Console-Xbox One"
  • "Console-Xbox Series X"
  • "IoT"
  • "Server"
  • "Tablet"
  • "Holographic"
  • "Unknown"
storeClient string 入手が行われた Microsoft Store のバージョンを示す次のいずれかの文字列。
  • "Windows Phone Store (client)"
  • "Microsoft Store (client)" (または、2018 年 3 月 23 日より前のデータを照会した場合は "Windows Store (client)")
  • "Microsoft Store (web)" (または、2018 年 3 月 23 日より前のデータを照会した場合は "Windows Store (web)")
  • "Volume purchase by organizations"
  • "Other"
osVersion string 入手が行われた OS バージョン。 このメソッドでは、この値は常に Windows 10 または Windows 11 のいずれかになります。
market string 入手が行われた市場の ISO 3166 国コード。
性別 string 入手を行ったユーザーの性別を指定する次のいずれかの文字列。
  • "m"
  • "f"
  • "Unknown"
年齢 string 入手を行ったユーザーの年齢グループを示す次のいずれかの文字列。
  • "less than 13"
  • "13-17"
  • "18-24"
  • "25-34"
  • "35-44"
  • "44-55"
  • "greater than 55"
  • "Unknown"
acquisitionType string 入手の種類を示す次のいずれかの文字列。
  • "Free"
  • "Trial"
  • "Paid"
  • "Promotional code"
  • "Iap"
  • "Subscription Iap"
  • "Private Audience"
  • "Pre Order"
  • "Xbox Game Pass" (または、2018 年 3 月 23 日より前のデータを照会した場合は "Game Pass")
  • "Disk"
  • "Prepaid Code"
  • "Charged Pre Order"
  • "Cancelled Pre Order"
  • "Failed Pre Order"
acquisitionQuantity integer 発生した入手の数。
inAppProductId string このアドオンが使用されている製品の製品 ID。
inAppProductName string このアドオンが使用されている製品の製品名。
paymentInstrumentType string 入手に使用された支払い方法の種類。
sandboxId string ゲーム用に作成されたサンドボックス ID。 これは値 RETAIL またはプライベート サンドボックス ID になります。
xboxTitleId string XDP からの製品の Xbox タイトル ID (該当する場合)。
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 からの製品の物品税の種類 (該当する場合)。
purchasePriceUSDAmount 数値 アドオンに対して顧客が支払った金額 (USD に換算)。
purchasePriceLocalAmount 数値 アドオンに対して顧客が支払った金額 (地域の通貨で)。
purchaseTaxUSDAmount 数値 アドオンに適用された税額 (USD に換算)。
purchaseTaxLocalAmount 数値 XDP からの製品の物品税の現地金額 (該当する場合)。

応答の例

この要求の JSON 返信の本文の例を次に示します。

{ 
  "Value": [ 
    { 
            "inAppProductId": "9NBLGGH1864K", 
            "inAppProductName": "866879", 
            "addonProductId": "9NBLGGH1864K", 
            "addonProductName": "866879", 
            "date": "2017-11-05", 
            "applicationId": "9WZDNCRFJ314", 
            "applicationName": "Tetris Blitz", 
            "acquisitionType": "Iap", 
            "age": "35-49", 
            "deviceType": "Phone", 
            "gender": "m", 
            "market": "US", 
            "osVersion": "Windows Phone 8.1", 
            "paymentInstrumentType": "Credit Card", 
            "sandboxId": "RETAIL", 
            "storeClient": "Windows Phone Store (client)", 
            "xboxTitleId": "", 
            "localCurrencyCode": "USD", 
            "xboxProductId": "00000000-0000-0000-0000-000000000000", 
            "availabilityId": "", 
            "skuId": "", 
            "skuDisplayName": "Full", 
            "xboxParentProductId": "", 
            "parentProductName": "Tetris Blitz", 
            "productTypeName": "Add-On", 
            "purchaseTaxType": "", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 1.08, 
            "purchasePriceLocalAmount": 0.09, 
            "purchaseTaxUSDAmount": 1.08, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

    "@nextLink": null, 
    
    "TotalCount": 7601 
}