次の方法で共有


アプリの入手数の取得

指定した期間やその他のオプション フィルターに該当するアプリケーションの集計入手データを JSON 形式で取得するには、Microsoft Store 分析 API でこのメソッドを使用します。 この情報は、パートナー センターの取得レポートでも確認できます。

前提条件

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

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

要求

要求の構文

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

要求ヘッダー

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

要求パラメーター

パラメーター 内容 必須
applicationId string 入手データを取得するアプリの Store ID はい
startDate 日付 取得する入手データの期間の開始日。 既定値は現在の日付です。 いいえ
endDate 日付 取得する入手データの期間の終了日。 既定値は現在の日付です。 いいえ
top int 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 いいえ
skip int クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。 No
filter string 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントでは応答本文のフィールド名と値が eq 演算子または ne 演算子で関連付けられ、ステートメントは and または or を使用して組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 たとえば、filter=market eq 'US' and gender eq 'm'

応答本文から次のフィールドを指定できます。

  • acquisitionType
  • ageGroup
  • storeClient
  • gender
  • market
  • osVersion
  • deviceType
  • orderName
いいえ
aggregationLevel string 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。dayweek、または month。 指定しない場合、既定値は day です。 No
orderby string 入手のそれぞれに対する結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
  • date
  • acquisitionType
  • ageGroup
  • storeClient
  • gender
  • market
  • osVersion
  • deviceType
  • orderName

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。

orderby 文字列の例: orderby=date,market

No
groupby string 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。
  • date
  • applicationName
  • acquisitionType
  • ageGroup
  • storeClient
  • gender
  • market
  • osVersion
  • deviceType
  • orderName

返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。

  • date
  • applicationId
  • acquisitionQuantity

groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。 例: &groupby=ageGroup,market&aggregationLevel=week

いいえ

要求の例

アプリ入手データを取得するための要求の例を、いくつか次に示します。 applicationId 値を、目的のアプリのストア ID に置き換えてください。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&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/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答本文

種類 説明
配列 アプリの集計入手データが格納されているオブジェクトの配列。 各オブジェクト内のデータの詳細については、以下の「入手の値」セクションを参照してください。
@nextLink string データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 10000 に設定されている場合にクエリに対する入手データが 10000 行を超えると、この値が返されます。
TotalCount int クエリの結果データ内の行の総数です。

取得金額

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

種類 説明
date string 入手データの期間の最初の日付。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。
applicationId string 入手データを取得するアプリの Store ID。
applicationName string アプリの表示名です。
deviceType string 入手が行われたデバイスの種類を指定する、以下のいずれかの文字列。
  • PC
  • 電話
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • 不明
orderName string トリガーの名前。
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
  • その他
osVersion string 入手が行われた OS バージョンを指定する次のいずれかの文字列。
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • 不明
market string 入手が行われた市場の ISO 3166 国コード。
性別 string 入手を行ったユーザーの性別を指定する次のいずれかの文字列。
  • m
  • f
  • 不明
ageGroup string 入手を行ったユーザーの年齢グループを指定する次のいずれかの文字列。
  • less than 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • greater than 55
  • 不明
acquisitionType string 入手の種類を示す次のいずれかの文字列。
  • Free
  • 試用版
  • 有料
  • Promotional code
  • Iap
  • Subscription Iap
  • Private Audience
  • Pre Order
  • Xbox Game Pass (または、2018 年 3 月 23 日より前のデータのクエリを実行する場合は Game Pass)
  • ディスク
  • Prepaid Code
acquisitionQuantity 数値 指定した集計レベルで発生した入手の数。

要求と応答の例

次のコード スニペットは、これらの要求についての要求と JSON 応答本文の例を示しています。

サンプル要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR  HTTP/1.1
Authorization: Bearer <your access token>

サンプル応答

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "date": "2022-07-29",
            "acquisitionQuantity": 7,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
  ],
  "TotalCount": 1,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
}

サンプル要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType  HTTP/1.1
Authorization: Bearer <your access token>

サンプル応答

	{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "f",
            "market": "TW",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "Unknown",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
      ],  
  "TotalCount": 2,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
 }