アプリのレビューの取得
日付範囲やその他のオプション フィルターを指定して、レビュー データを JSON 形式で取得するには、Microsoft Store 分析 API の以下のメソッドを使います。 この情報は、パートナー センターのレビュー レポートでも確認できます。
レビューを取得した後、Microsoft Store レビュー API のアプリのレビューへの返信情報の取得メソッドとアプリ レビューへの返信の提出のメソッドを使って、プログラムでレビューに返信できます。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews |
要求ヘッダー
| 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 つまたは複数のステートメントです。 詳しくは、次の「フィルター フィールド」セクションをご覧ください。 | No |
| orderby | string | 結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。 orderby 文字列の例: orderby=date,market |
No |
フィルター フィールド
要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。 各ステートメントには eq または ne 演算子と関連付けられるフィールドと値が含まれ、一部のフィールドでは contains、gt、lt、ge、および le 演算子もサポートします。 and または or を使ってステートメントを組み合わせることができます。
filter 文字列の例は次のとおりです。filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'
サポートされているフィールドと各フィールドでサポートされている演算子の一覧については、次の表をご覧ください。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。
| フィールド | サポートされている演算子 | 説明 |
|---|---|---|
| market | eq、ne | デバイス市場の ISO 3166 国コードを含む文字列です。 |
| osVersion | eq、ne | 次の文字列のいずれかです。
|
| deviceType | eq、ne | 次の文字列のいずれかです。
|
| isRevised | eq、ne | 更新されているレビューをフィルター処理するには true を指定します。それ以外の場合は false を指定します。 |
| packageVersion | eq、ne | レビューされたアプリ パッケージのバージョンです。 |
| deviceModel | eq、ne | アプリがレビューされたデバイスの種類です。 |
| productFamily | eq、ne | 次の文字列のいずれかです。
|
| deviceRAM | eq、ne、gt、lt、ge、le | 物理 RAM (MB 単位) です。 |
| deviceScreenResolution | eq、ne | "幅 x 高さ" 形式のデバイスの画面解像度です。 |
| deviceStorageCapacity | eq、ne、gt、lt、ge、le | 主記憶域ディスクの容量 (GB 単位) です。 |
| isTouchEnabled | eq、ne | タッチ対応デバイスをフィルター処理するには true を指定します。それ以外の場合は false を指定します。 |
| reviewerName | eq、ne | レビュー担当者名です。 |
| 評価 | eq、ne、gt、lt、ge、le | 星で表現したアプリの評価です。 |
| reviewTitle | eq、ne、contains | レビューのタイトルです。 |
| reviewText | eq、ne、contains | レビューのテキスト コンテンツです。 |
| helpfulCount | eq、ne | レビューが役に立つとマークされた回数です。 |
| notHelpfulCount | eq、ne | レビューが役に立たないとマークされた回数です。 |
| responseDate | eq、ne | 応答が送信された日付です。 |
| responseText | eq、ne、contains | 応答のテキスト コンテンツです。 |
| ID | 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>
[応答]
応答本文
| 値 | Type | 説明 |
|---|---|---|
| 値 | array | レビュー データを含むオブジェクトの配列です。 各オブジェクトのデータについて詳しくは、次の「レビュー値」セクションをご覧ください。 |
| @nextLink | string | データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターを 10000 に設定した場合、クエリに適合するレビュー データが 10,000 行を超えると、この値が返されます。 |
| TotalCount | int | クエリの結果データ内の行の総数です。 |
レビュー値
Value 配列の要素には、次の値が含まれます。
| 値 | Type | 説明 |
|---|---|---|
| date | string | レビュー データの日付範囲の最初の日付です。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
| applicationId | string | レビュー データを取得するアプリのストア ID です。 |
| applicationName | string | アプリの表示名です。 |
| market | string | レビューが送信された市場の ISO 3166 国コードです。 |
| osVersion | string | レビューが送信された OS バージョンです。 サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。 |
| deviceType | string | レビューが送信されたデバイスの種類です。 サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。 |
| isRevised | Boolean | 値 true は、レビューが更新済みであることを示します。それ以外の場合は false です。 |
| packageVersion | string | レビューされたアプリ パッケージのバージョンです。 |
| deviceModel | string | アプリがレビューされたデバイスの種類です。 |
| productFamily | string | デバイス ファミリの名前です。 サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。 |
| deviceRAM | number | 物理 RAM (MB 単位) です。 |
| deviceScreenResolution | string | "幅 x 高さ" 形式のデバイスの画面解像度です。 |
| deviceStorageCapacity | number | 主記憶域ディスクの容量 (GB 単位) です。 |
| isTouchEnabled | ブール値 | 値 true は、タッチ対応であることを示します。それ以外の場合は false です。 |
| reviewerName | string | レビュー担当者名です。 |
| 評価 | number | 星で表現したアプリの評価です。 |
| reviewTitle | string | レビューのタイトルです。 |
| reviewText | string | レビューのテキスト コンテンツです。 |
| helpfulCount | number | レビューが役に立つとマークされた回数です。 |
| notHelpfulCount | number | レビューが役に立たないとマークされた回数です。 |
| responseDate | string | 応答が送信された日付です。 |
| responseText | string | 応答のテキスト コンテンツです。 |
| id | string | レビューの 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
}
関連トピック
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示