アプリのレビューの取得

Microsoft Store 分析 API のこのメソッドを使用して、特定の日付範囲やその他のオプション フィルターの JSON 形式のレビュー データを取得します。 この情報は、パートナー センターのレビュー レポートでも確認できます。

レビューを取得した後は、アプリ レビューの取得応答情報を使用し 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 つまたは複数のステートメントです。 詳しくは、次の「フィルター フィールド」セクションをご覧ください。 いいえ
orderby string 結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
  • date
  • osVersion
  • market
  • deviceType
  • isRevised
  • packageVersion
  • deviceModel
  • productFamily
  • deviceScreenResolution
  • isTouchEnabled
  • reviewerName
  • reviewTitle
  • reviewText
  • helpfulCount
  • notHelpfulCount
  • responseDate
  • responseText
  • deviceRAM
  • deviceStorageCapacity
  • rating

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。

orderby 文字列の例: orderby=date,market

いいえ

フィルター フィールド

要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。 各ステートメントには、 eq または ne 演算子に関連付けられたフィールドと値が含まれており、一部のフィールドでは、 containsgtltge、および 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 次の文字列のいずれかです。
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • 不明
deviceType eq、ne 次の文字列のいずれかです。
  • PC
  • 電話
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • 不明
isRevised eq、ne trueを指定して、改訂されたレビューをフィルター処理します。それ以外の場合はfalse
packageVersion eq、ne レビューされたアプリ パッケージのバージョン。
deviceModel eq、ne アプリがレビューされたデバイスの種類。
productFamily eq、ne 次の文字列のいずれかです。
  • PC
  • タブレット PC
  • 電話
  • ウェアラブル
  • [サーバー]
  • Collaborative
  • その他
deviceRAM eq、ne、gt、lt、ge、le 物理 RAM (MB 単位)。
deviceScreenResolution eq、ne "width x height" という形式のデバイスの画面解像度。
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>

[応答]

応答本文

種類 説明
配列 レビュー データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、以下の review 値 セクションを参照してください。
@nextLink string データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 10000 に設定されていた場合、クエリのレビュー データが 10000 行を超えると、この値が返されます。
TotalCount int クエリの結果データ内の行の総数です。

 

値を確認する

Value 配列の要素には、次の値が含まれます。

種類 説明
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 数値 物理 RAM (MB 単位)。
deviceScreenResolution string "width x height" という形式のデバイスの画面解像度。
deviceStorageCapacity 数値 プライマリ ストレージ ディスクの容量 (GB 単位)。
isTouchEnabled Boolean true タッチが有効になっていることを示します。それ以外の場合は false
reviewerName string 校閲者の名前。
rating 数値 アプリの評価 (星単位)。
reviewTitle string レビューのタイトル。
reviewText string レビューのテキストコンテンツ。
helpfulCount 数値 レビューが役に立つとマークされた回数。
notHelpfulCount 数値 レビューが役に立たないとマークされた回数。
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
}