Microsoft Store 分析 API のこのメソッドを使用して、特定の日付範囲およびその他のオプションフィルター中にアプリケーションの JSON 形式の集計インストール データを取得します。 この情報は、パートナー センターの 取得レポート でも使用できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークンを取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | インストール データを取得するアプリの ストア ID 。 | イエス |
開始日 | 日付 | 取得するインストール データの日付範囲の開始日。 既定値は現在の日付です。 | いいえ |
終了日 | 日付 | 取得するインストール データの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 各ステートメントには、eq 演算子または ne 演算子に関連付けられている応答本文と値のフィールド名が含まれており、ステートメントは or またはを使用して結合できます。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。 応答本文から次のフィールドを指定できます:
|
いいえ |
集約レベル | ひも | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます: |
いいえ |
オーダーバイ (orderby) | ひも | 各インストールの結果データ値を並べ替えるステートメント。 構文は orderby=field [order],field [order],...です。 field パラメーターには、応答本文から次のいずれかのフィールドを指定できます。
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/installs?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/installs?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>
[応答]
応答内容
価値 | タイプ | 説明 |
---|---|---|
価値 | 配列 | 集計インストール データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、次の表を参照してください。 |
@nextLink | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の 最上位 パラメーターが 10000 に設定されているが、クエリのインストール データが 1,0000 行を超える場合、この値が返されます。 |
トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
Value 配列内の要素には、次の値が含まれています。
価値 | タイプ | 説明 |
---|---|---|
日付 | ひも | インストール データの日付範囲の最初の日付。 要求で 1 日を指定した場合、この値はその日付になります。 要求で週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
アプリケーションID | ひも | インストール データを取得するアプリのストア ID。 |
アプリケーション名 | ひも | アプリの表示名。 |
デバイスタイプ | ひも | インストールを完了したデバイスの種類を指定する次のいずれかの文字列:
|
パッケージバージョン | ひも | インストールされたパッケージのバージョン。 |
osVersion (英語) | ひも | インストールが発生した OS バージョンを指定する次のいずれかの文字列:
|
市場 | ひも | インストールが発生した市場の ISO 3166 国コード。 |
インストール成功回数 | 数 | 指定した集計レベルで発生した正常なインストールの数。 |
要求と応答の例
次のコード スニペットは、これらの要求の要求と JSON 応答本文の例を示しています。
サンプル依頼
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9WZDNCRFJB4P
HTTP/1.1
Authorization: Bearer <your access token>
応答の例
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"successfulInstallCount": 100053
}
],
"TotalCount": 1
}
サンプル依頼
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=06/19/2022&endDate=07/21/2022&top=10&skip=0&groupby=applicationName,date,deviceType,market,osVersion,packageVersion&orderby=date desc
HTTP/1.1
Authorization: Bearer <your access token>
応答の例
{
"Value": [
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "AR",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "AU",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BD",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BG",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BO",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BR",
"osVersion": "Windows 10",
"successfulInstallCount": 6
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BR",
"osVersion": "Windows 11",
"successfulInstallCount": 3
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "CA",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "CN",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "MX",
"osVersion": "Windows 10",
"successfulInstallCount": 1
}
],
"TotalCount": 10
}
関連トピック
- インストール レポート
- Microsoft Store サービス を使用して分析データにアクセスする