Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲やその他のオプション フィルター中にアプリケーションの集計取得データを JSON 形式で取得します。 この情報は、パートナー センターの 取得レポート でも使用できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
| メソッド | URI リクエスト |
|---|---|
| 取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions |
リクエストヘッダー
| ヘッダ | タイプ | 説明 |
|---|---|---|
| 認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
| パラメーター | タイプ | 説明 | 必須 |
|---|---|---|---|
| アプリケーションID | ひも | 取得データを抽出するためのアプリの ストア ID。 | イエス |
| 開始日 | 日付 | 取得データの日付範囲の開始日。 既定値は現在の日付です。 | いいえ |
| 終了日 | 日付 | 取得するデータの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
| ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
| スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
| フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 各ステートメントには、応答本文のフィールド名と、eq または ne 演算子に関連付けられている値が含まれており、ステートメントは、、、、またはを使用して結合できます。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。 たとえば、filter=market eq 'US' および gender eq 'm'。
応答本文から次のフィールドを指定できます:
|
いいえ |
| 集約レベル | ひも | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます: |
いいえ |
| オーダーバイ (orderby) | ひも | 取得ごとに結果データ値を並べ替えるステートメント。 構文は orderby=field [order],field [order],...です。 フィールド パラメーターには、次のいずれかの文字列を指定できます。
order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。 既定値は asc 例として次のような orderby 文字列があります: orderby=date、market |
いいえ |
| グループバイ | ひも | 指定したフィールドにのみデータ集計を適用するステートメント。 次のフィールドを指定できます。
返されるデータ行には、 groupby パラメーターで指定されたフィールドと、次のものが含まれます。
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 | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 10000 に設定されているが、クエリの取得データが 1,0000 行を超える場合、この値が返されます。 |
| トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
取得価値
Value 配列内の要素には、次の値が含まれています。
| 価値 | タイプ | 説明 |
|---|---|---|
| 日付 | ひも | 取得データの日付範囲の最初の日付。 要求で 1 日を指定した場合、この値はその日付になります。 要求で週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
| アプリケーションID | ひも | 取得データを取得するアプリのストア ID。 |
| アプリケーション名 | ひも | アプリの表示名。 |
| デバイスタイプ | ひも | 取得が発生したデバイスの種類を指定する次のいずれかの文字列。
|
| 注文名 | ひも | 注文の名前。 |
| ストアクライアント | ひも | 取得が行われたストアのバージョンを示す次のいずれかの文字列。
|
| osVersion (英語) | ひも | 取得が行われた OS バージョンを指定する次のいずれかの文字列。
|
| 市場 | ひも | 取得が行われた市場の ISO 3166 国コード。 |
| ジェンダー | ひも | 取得を行ったユーザーの性別を指定する次のいずれかの文字列。
|
| 年齢層 | ひも | 取得を行ったユーザーの年齢グループを指定する次のいずれかの文字列。
|
| 取得タイプ | ひも | 取得の種類を示す次のいずれかの文字列。
|
| 取得数量 | 数 | 指定した集計レベルで発生した取得の数。 |
要求と応答の例
次のコード スニペットは、これらの要求の要求と 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"
}
関連トピック
- 買収報告書
- Microsoft Store サービス を使用して分析データにアクセスする
- アプリ取得ファネルデータの取得
- チャネル別でアプリのコンバージョンを把握する
- アドオンを取得する