Microsoft Store 分析 API のこのメソッドを使用して、特定の日付範囲やその他のオプション フィルターの JSON 形式のレビュー データを取得します。 この情報は、パートナー センターの レビュー レポート でも使用できます。
レビューを取得した後、Microsoft Store レビュー API でアプリ レビューの応答情報を取得するには 、 メソッドを使用し、アプリ レビューへの応答を送信するには 、 メソッドを使用してプログラムによってレビューに応答できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
| メソッド | URI リクエスト |
|---|---|
| 取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews |
リクエストヘッダー
| ヘッダ | タイプ | 説明 |
|---|---|---|
| 認証 | ひも | 必須。 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 |
いいえ |
フィールドをフィルターする
要求の フィルター パラメーターには、応答内の行をフィルター処理する 1 つ以上のステートメントが含まれています。 各ステートメントには、
これはフィルター 文字列 の例です。filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'
各フィールドでサポートされているフィールドとサポート演算子の一覧については、次の表を参照してください。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。
| 田畑 | サポートされている演算子 | 説明 |
|---|---|---|
| 市場 | eq、ne | デバイス市場の ISO 3166 国コードを含む文字列。 |
| osVersion (英語) | eq、ne | 次のいずれかの文字列:
|
| デバイスタイプ | eq、ne | 次のいずれかの文字列:
|
| 改訂済み | eq、ne | 変更されたレビューをフィルターするには、true を指定します。それ以外の場合は、falseを指定します。 |
| パッケージバージョン | eq、ne | レビューされたアプリ パッケージのバージョン。 |
| デバイスモデル | eq、ne | アプリがレビューされたデバイスの種類。 |
| 製品ファミリー | eq、ne | 次のいずれかの文字列:
|
| デバイスRAM | eq、ne、gt、lt、ge、le | 物理 RAM (MB 単位)。 |
| デバイス画面解像度 | eq、ne | "幅 x 高さ" という形式のデバイスの画面解像度。 |
| デバイスストレージ容量 | eq、ne、gt、lt、ge、le | プライマリ ストレージ ディスクの容量 (GB 単位)。 |
| タッチ機能が有効 | eq、ne | タッチ対応デバイスをフィルターするには true を指定します。それ以外の場合は falseを指定します。 |
| レビュアー名 | eq、ne | 校閲者の名前。 |
| 格付け | eq、ne、gt、lt、ge、le | アプリの評価 (星単位)。 |
| レビュータイトル | eq、ne、含む | レビューのタイトル。 |
| レビュー本文 | eq、ne、含む | レビューのテキストコンテンツ。 |
| 役に立った数 | eq、ne | レビューが役に立つとマークされた回数。 |
| 役に立たないカウント | eq、ne | レビューが役に立たないとマークされた回数。 |
| 応答日 | eq、ne | 応答が送信された日付。 |
| 応答テキスト | eq、ne、含む | 応答のテキストの内容。 |
| 身分証明書 | eq、ne | レビューの ID (これは GUID です)。 |
要求の例
次の例では、レビュー データを取得するためのいくつかの要求を示します。 applicationId の値をアプリのストア ID に置き換えます。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?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/reviews?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US' HTTP/1.1
Authorization: Bearer <your access token>
[応答]
応答内容
| 価値 | タイプ | 説明 |
|---|---|---|
| 価値 | 配列 | レビュー データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、以下のセクション |
| @nextLink | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 10000 に設定されていても、クエリのレビュー データが 1,0000 行を超える場合、この値が返されます。 |
| トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
値を確認する
Value 配列内の要素には、次の値が含まれています。
| 価値 | タイプ | 説明 |
|---|---|---|
| 日付 | ひも | レビュー データの日付範囲の最初の日付。 要求で 1 日を指定した場合、この値はその日付になります。 要求で週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
| アプリケーションID | ひも | レビュー データを取得するアプリのストア ID。 |
| アプリケーション名 | ひも | アプリの表示名。 |
| 市場 | ひも | レビューが提出された市場の ISO 3166 国コード。 |
| osVersion (英語) | ひも | レビューが送信された OS バージョン。 サポートされている文字列の一覧については、上記の フィルター フィールド セクションを参照してください。 |
| デバイスタイプ | ひも | レビューが送信されたデバイスの種類。 サポートされている文字列の一覧については、上記の フィルター フィールド セクションを参照してください。 |
| 改訂済み | ボーリアン | true が値である場合、レビューが改訂されたことを示します。それ以外の場合は、false 。 |
| パッケージバージョン | ひも | レビューされたアプリ パッケージのバージョン。 |
| デバイスモデル | ひも | アプリがレビューされたデバイスの種類。 |
| 製品ファミリー | ひも | デバイス ファミリ名。 サポートされている文字列の一覧については、上記の フィルター フィールド セクションを参照してください。 |
| デバイスRAM | 数 | 物理 RAM (MB 単位)。 |
| デバイス画面解像度 | ひも | "幅 x 高さ" という形式のデバイスの画面解像度。 |
| デバイスストレージ容量 | 数 | プライマリ ストレージ ディスクの容量 (GB 単位)。 |
| タッチ機能が有効 | ボーリアン | true 値 は、タッチが有効になっていることを示します。それ以外は、false 。 |
| レビュアー名 | ひも | 校閲者の名前。 |
| 格付け | 数 | アプリの評価 (星単位)。 |
| レビュータイトル | ひも | レビューのタイトル。 |
| レビュー本文 | ひも | レビューのテキストコンテンツ。 |
| 役に立った数 | 数 | レビューが役に立つとマークされた回数。 |
| 役に立たないカウント | 数 | レビューが役に立たないとマークされた回数。 |
| 応答日 | ひも | 応答が送信された日付。 |
| 応答テキスト | ひも | 応答のテキストの内容。 |
| 身分証明書 | ひも | レビューの ID (これは GUID です)。 この ID は、アプリ レビュー の応答情報を取得 |
要求と応答の例
次のコード スニペットは、これらの要求の要求と JSON 応答本文の例を示しています。
サンプル依頼
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?applicationId=9WZDNCRFJB4P&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>
応答の例
{
"Value": [
{
"date": "3/5/2021 12:48:33 PM",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "ES",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": false,
"packageVersion": "2.5.2.34894",
"reviewerName": "Jose Antonio",
"rating": 5,
"reviewTitle": "Contoso Demo",
"reviewText": "Un juego fantastico",
"helpfulCount": 3,
"notHelpfulCount": 0,
"id": "b5e27de9-2334-4849-d17d-4eae3e1e7aa9"
},
{
"date": "1/6/2021 8:41:42 AM",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "TR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": false,
"packageVersion": "2.5.2.34894",
"reviewerName": "fef",
"rating": 5,
"helpfulCount": 0,
"notHelpfulCount": 0,
"id": "f5d2510a-9796-45ee-01e5-6d5cc4550b09"
}
],
"TotalCount": 2
}
関連トピック
- レビュー レポート
- Microsoft Store サービス を使用して分析データにアクセスする
- アプリ レビューの応答情報を取得する
- アプリ レビューに返信を送信する
- アプリの買収
- アドオンを取得する
- エラー報告データを取得する
- アプリの評価 を取得する