Microsoft Store 分析 API のこのメソッドを使用して、特定の日付範囲とその他の省略可能なフィルターの集計評価データを JSON 形式で取得します。 この情報は、パートナー センターの レビュー レポート でも使用できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | 評価データを取得したいアプリのストアID 。 | イエス |
開始日 | 日付 | 取得する評価データの日付範囲の開始日。 既定値は現在の日付です。 | いいえ |
終了日 | 日付 | 取得する評価データの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 詳細については、以下の「フィルター フィールド セクション」を参照してください。 | いいえ |
集約レベル | ひも | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます: |
いいえ |
オーダーバイ (orderby) | ひも | 各評価の結果データ値を並べ替えるステートメント。 構文は orderby=field [order],field [order],...です。 フィールド パラメーターには、次のいずれかの文字列を指定できます。
order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。 既定値は asc 例として次のような orderby 文字列があります: orderby=date、market |
いいえ |
グループバイ | ひも | 指定したフィールドにのみデータ集計を適用するステートメント。 次のフィールドを指定できます。
返されるデータ行には、 groupby パラメーターで指定されたフィールドと、次のものが含まれます。
groupby パラメーターは aggregationLevel パラメーターと共に使用できます。 例: &groupby=osVersion,market&aggregationLevel=week |
いいえ |
フィールドをフィルターする
要求の フィルター パラメーターには、応答内の行をフィルター処理する 1 つ以上のステートメントが含まれています。 各ステートメントには、eq または ne 演算子に関連付けられているフィールドと値が含まれており、ステートメントは、、、、またはを使用して結合できます。
次に、フィルター 文字列
サポートされているフィールドの一覧については、次の表を参照してください。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。
田畑 | 説明 |
---|---|
市場 | アプリが評価された市場の ISO 3166 国コードを含む文字列。 |
osVersion (英語) | 次のいずれかの文字列:
|
デバイスタイプ | 次のいずれかの文字列:
|
改訂済み | 評価が変更されたものをフィルターする場合は、true を指定してください。そうでない場合は、false を指定します。 |
要求の例
次の例では、評価データを取得するためのいくつかの要求を示します。 applicationId の値をアプリのストア ID に置き換えます。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?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/ratings?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' HTTP/1.1
Authorization: Bearer <your access token>
[応答]
応答内容
価値 | タイプ | 説明 |
---|---|---|
価値 | 配列 | 集計評価データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、以下の 「評価値 」セクションを参照してください。 |
@nextLink | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の 最上位 パラメーターが 10000 に設定されているが、クエリの評価データが 1,0000 行を超える場合、この値が返されます。 |
トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
評価値
Value 配列内の要素には、次の値が含まれています。
価値 | タイプ | 説明 |
---|---|---|
日付 | ひも | 評価データの日付範囲の最初の日付。 要求で 1 日を指定した場合、この値はその日付になります。 要求で週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
アプリケーションID | ひも | 評価データを取得するアプリのストア ID。 |
アプリケーション名 | ひも | アプリの表示名。 |
市場 | ひも | レーティングが提出された市場の ISO 3166 国コード。 |
osVersion (英語) | ひも | 評価が送信された OS バージョン。 サポートされている文字列の一覧については、上記の フィルター フィールド セクションを参照してください。 |
デバイスタイプ | ひも | 評価が送信されたデバイスの種類。 サポートされている文字列の一覧については、上記の フィルター フィールド セクションを参照してください。 |
改訂済み | ボーリアン | true 値は、評価が変更されたことを示します。それ以外の場合は、false 。 |
ワンスター | 数 | 1 つ星評価の数。 |
ツースターズ | 数 | 2 つ星評価の数。 |
スリースターズ | 数 | 3 つ星評価の数。 |
フォースターズ | 数 | 4 つ星評価の数。 |
ファイブスターズ | 数 | 5 つ星評価の数。 |
要求と応答の例
次のコード スニペットは、これらの要求の要求と JSON 応答本文の例を示しています。
サンプル依頼
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
応答の例
{
"Value": [
{
"date": "2012-09-01",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"oneStar": 1,
"twoStars": 0,
"threeStars": 0,
"fourStars": 1,
"fiveStars": 3
},
{
"date": "2012-09-02",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"oneStar": 3,
"twoStars": 0,
"threeStars": 1,
"fourStars": 2,
"fiveStars": 17
},
{
"date": "2012-09-03",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"oneStar": 1,
"twoStars": 1,
"threeStars": 1,
"fourStars": 5,
"fiveStars": 17
},
],
"TotalCount": 3
}
サンプル依頼
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=date,applicationName,market,osVersion,deviceType,isRevised
HTTP/1.1
Authorization: Bearer <your access token>
応答の例
{
"Value": [
{
"date": "2022-06-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "CL",
"osVersion": "Windows 11",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-06-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "TR",
"osVersion": "Windows 11",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-06-29",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "FR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 1,
"fiveStars": 0
},
{
"date": "2022-07-01",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-04",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "ES",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-06",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "ES",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-07",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "AE",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "true",
"oneStar": 1,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 0
},
{
"date": "2022-07-10",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "true",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-13",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "EG",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-14",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "true",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 1,
"fiveStars": 0
}
],
"TotalCount": 10
}
関連トピック
- 評価レポート
- Microsoft Store サービス を使用して分析データにアクセスする
- アプリの買収
- アドオンを取得する
- エラー報告データを取得する
- アプリ レビューを取得する