アプリのレビューの取得Get app reviews

日付範囲やその他のオプション フィルターを指定して、レビュー データを JSON 形式で取得するには、Microsoft Store 分析 API の以下のメソッドを使います。Use this method in the Microsoft Store analytics API to get review data in JSON format for a given date range and other optional filters. この情報も記載されて、レポートをレビューパートナー センターでします。This information is also available in the Reviews report in Partner Center.

レビューを取得した後、Microsoft Store レビュー API のアプリのレビューへの返信情報の取得メソッドとアプリ レビューへの返信の提出のメソッドを使って、プログラムでレビューに返信できます。After you retrieve reviews, you can use the get response info for app reviews and submit responses to app reviews methods in the Microsoft Store reviews API to programmatically respond to reviews.

前提条件Prerequisites

このメソッドを使うには、最初に次の作業を行う必要があります。To use this method, you need to first do the following:

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for this method. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.

要求Request

要求の構文Request syntax

メソッドMethod 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

パラメーターParameter 種類Type 説明Description 必須Required
applicationIdapplicationId stringstring レビュー データを取得するアプリの Store ID です。The Store ID of the app for which you want to retrieve review data. Yes
startDatestartDate datedate 取得するレビュー データの日付範囲の開始日です。The start date in the date range of review data to retrieve. 既定値は現在の日付です。The default is the current date. XNo
endDateendDate datedate 取得するレビュー データの日付範囲の終了日です。The end date in the date range of review data to retrieve. 既定値は現在の日付です。The default is the current date. XNo
toptop intint 要求で返すデータの行数です。The number of rows of data to return in the request. 最大値および指定しない場合の既定値は 10000 です。The maximum value and the default value if not specified is 10000. クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. XNo
skipskip intint クエリでスキップする行数です。The number of rows to skip in the query. 大きなデータ セットを操作するには、このパラメーターを使用します。Use this parameter to page through large data sets. たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. XNo
filterfilter stringstring 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。One or more statements that filter the rows in the response. 詳しくは、次の「フィルター フィールド」セクションをご覧ください。For more information, see the filter fields section below. XNo
orderbyorderby stringstring 結果データ値の順序を指定するステートメントです。A statement that orders the result data values. 構文は orderby=field [order],field [order],... です。field パラメーターには、次のいずれかの文字列を指定できます。The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • osVersionosVersion
  • marketmarket
  • deviceTypedeviceType
  • isRevisedisRevised
  • packageVersionpackageVersion
  • DeviceModeldeviceModel
  • productFamilyproductFamily
  • deviceScreenResolutiondeviceScreenResolution
  • isTouchEnabledisTouchEnabled
  • reviewerNamereviewerName
  • reviewTitlereviewTitle
  • reviewTextreviewText
  • helpfulCounthelpfulCount
  • notHelpfulCountnotHelpfulCount
  • responseDateresponseDate
  • responseTextresponseText
  • deviceRAMdeviceRAM
  • deviceStorageCapacitydeviceStorageCapacity
  • 評価rating

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. 既定値は asc です。The default is asc.

orderby 文字列の例: orderby=date,marketHere is an example orderby string: orderby=date,market

XNo

フィルター フィールドFilter fields

要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。The filter parameter of the request contains one or more statements that filter the rows in the response. 各ステートメントには eq または ne 演算子と関連付けられるフィールドと値が含まれ、一部のフィールドでは containsgtltge、および le 演算子もサポートします。Each statement contains a field and value that are associated with the eq or ne operators, and some fields also support the contains, gt, lt, ge, and le operators. and または or を使ってステートメントを組み合わせることができます。Statements can be combined using and or or.

filter 文字列の例は次のとおりです。filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'Here is an example filter string: filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'

サポートされているフィールドと各フィールドでサポートされている演算子の一覧については、次の表をご覧ください。For a list of the supported fields and support operators for each field, see the following table. filter パラメーターでは、文字列値を単一引用符で囲む必要があります。String values must be surrounded by single quotes in the filter parameter.

フィールドFields サポートされている演算子Supported operators 説明Description
marketmarket eq、neeq, ne デバイス市場の ISO 3166 国コードを含む文字列です。A string that contains the ISO 3166 country code of the device market.
osVersionosVersion eq、neeq, ne 次のいずれかの文字列です。One of the following strings:
  • Windows Phone 7.5Windows Phone 7.5
  • Windows Phone 8Windows Phone 8
  • Windows Phone 8.1Windows Phone 8.1
  • Windows Phone 10Windows Phone 10
  • Windows 8Windows 8
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • UnknownUnknown
deviceTypedeviceType eq、neeq, ne 次のいずれかの文字列です。One of the following strings:
  • PCPC
  • PhonePhone
  • ConsoleConsole
  • IoTIoT
  • HolographicHolographic
  • UnknownUnknown
isRevisedisRevised eq、neeq, ne 更新されているレビューをフィルター処理するには true を指定します。それ以外の場合は false を指定します。Specify true to filter for reviews that have been revised; otherwise false.
packageVersionpackageVersion eq、neeq, ne レビューされたアプリ パッケージのバージョンです。The version of the app package that was reviewed.
deviceModeldeviceModel eq、neeq, ne アプリがレビューされたデバイスの種類です。The type of device on which the app was reviewed.
productFamilyproductFamily eq、neeq, ne 次のいずれかの文字列です。One of the following strings:
  • PCPC
  • タブレットTablet
  • PhonePhone
  • ウェアラブルWearable
  • [サーバー]Server
  • 共同作業Collaborative
  • その他Other
deviceRAMdeviceRAM eq、ne、gt、lt、ge、leeq, ne, gt, lt, ge, le 物理 RAM (MB 単位) です。The physical RAM, in MB.
deviceScreenResolutiondeviceScreenResolution eq、neeq, ne " x 高さ" 形式のデバイスの画面解像度です。The device screen resolution in the format "width x height".
deviceStorageCapacitydeviceStorageCapacity eq、ne、gt、lt、ge、leeq, ne, gt, lt, ge, le 主記憶域ディスクの容量 (GB 単位) です。The capacity of the primary storage disk, in GB.
isTouchEnabledisTouchEnabled eq、neeq, ne タッチ対応デバイスをフィルター処理するには true を指定します。それ以外の場合は false を指定します。Specify true to filter for touch-enabled devices; otherwise false.
reviewerNamereviewerName eq、neeq, ne レビュー担当者名です。The reviewer name.
ratingrating eq、ne、gt、lt、ge、leeq, ne, gt, lt, ge, le 星で表現したアプリの評価です。The app rating, in stars.
reviewTitlereviewTitle eq、ne、containseq, ne, contains レビューのタイトルです。The title of the review.
reviewTextreviewText eq、ne、containseq, ne, contains レビューのテキスト コンテンツです。The text contents of the review.
helpfulCounthelpfulCount eq、neeq, ne レビューが役に立つとマークされた回数です。The number of times the review was marked helpful.
notHelpfulCountnotHelpfulCount eq、neeq, ne レビューが役に立たないとマークされた回数です。The number of times the review was marked not helpful.
responseDateresponseDate eq、neeq, ne 応答が送信された日付です。The date that the response was submitted.
responseTextresponseText eq、ne、containseq, ne, contains 応答のテキスト コンテンツです。The text contents of the response.
idid eq、neeq, ne レビューの ID です (これは GUID です)。The ID of the review (this is a GUID).

要求の例Request example

レビュー データを取得するためのいくつかの要求の例を次に示します。The following examples demonstrate several requests for getting review data. applicationId 値を、目的のアプリのストア ID に置き換えてください。Replace the applicationId value with the Store ID for your app.

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>

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
ValueValue arrayarray レビュー データを含むオブジェクトの配列です。An array of objects that contain review data. 各オブジェクトのデータについて詳しくは、次の「レビュー値」セクションをご覧ください。For more information about the data in each object, see the review values section below.
@nextLink stringstring データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。If there are additional pages of data, this string contains a URI that you can use to request the next page of data. たとえば、要求の top パラメーターを 10000 に設定した場合、クエリに適合するレビュー データが 10,000 行を超えると、この値が返されます。For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of reviews data for the query.
TotalCountTotalCount intint クエリの結果データ内の行の総数です。The total number of rows in the data result for the query.

 

レビュー値Review values

Value 配列の要素には、次の値が含まれます。Elements in the Value array contain the following values.

ValueValue 種類Type 説明Description
datedate stringstring レビュー データの日付範囲の最初の日付です。The first date in the date range for the review data. 要求に日付を指定した場合、この値はその日付になります。If the request specified a single day, this value is that date. 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId stringstring レビュー データを取得するアプリのストア ID です。The Store ID of the app for which you are retrieving review data.
applicationNameapplicationName stringstring アプリの表示名です。The display name of the app.
marketmarket stringstring レビューが送信された市場の ISO 3166 国コードです。The ISO 3166 country code of the market where the review was submitted.
osVersionosVersion stringstring レビューが送信された OS バージョンです。The OS version on which the review was submitted. サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。For a list of the supported strings, see the filter fields section above.
deviceTypedeviceType stringstring レビューが送信されたデバイスの種類です。The type of device on which the review was submitted. サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。For a list of the supported strings, see the filter fields section above.
isRevisedisRevised ブール値Boolean true は、レビューが更新済みであることを示します。それ以外の場合は false です。The value true indicates that the review was revised; otherwise false.
packageVersionpackageVersion stringstring レビューされたアプリ パッケージのバージョンです。The version of the app package that was reviewed.
deviceModeldeviceModel stringstring アプリがレビューされたデバイスの種類です。The type of device on which the app was reviewed.
productFamilyproductFamily stringstring デバイス ファミリの名前です。The device family name. サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。For a list of the supported strings, see the filter fields section above.
deviceRAMdeviceRAM numbernumber 物理 RAM (MB 単位) です。The physical RAM, in MB.
deviceScreenResolutiondeviceScreenResolution stringstring " x 高さ" 形式のデバイスの画面解像度です。The device screen resolution in the format "width x height".
deviceStorageCapacitydeviceStorageCapacity numbernumber 主記憶域ディスクの容量 (GB 単位) です。The capacity of the primary storage disk, in GB.
isTouchEnabledisTouchEnabled ブール値Boolean true は、タッチ対応であることを示します。それ以外の場合は false です。The value true indicates that touch is enabled; otherwise false.
reviewerNamereviewerName stringstring レビュー担当者名です。The reviewer name.
ratingrating numbernumber 星で表現したアプリの評価です。The app rating, in stars.
reviewTitlereviewTitle stringstring レビューのタイトルです。The title of the review.
reviewTextreviewText stringstring レビューのテキスト コンテンツです。The text contents of the review.
helpfulCounthelpfulCount numbernumber レビューが役に立つとマークされた回数です。The number of times the review was marked helpful.
notHelpfulCountnotHelpfulCount numbernumber レビューが役に立たないとマークされた回数です。The number of times the review was marked not helpful.
responseDateresponseDate stringstring 応答が送信された日付です。The date a response was submitted.
responseTextresponseText stringstring 応答のテキスト コンテンツです。The text contents of the response.
idid stringstring レビューの ID です (これは GUID です)。The ID of the review (this is a GUID). この ID は、アプリのレビューへの返信情報の取得アプリ レビューへの返信の提出メソッドで使用できます。You can use this ID in the get response info for app reviews and submit responses to app reviews methods.

応答の例Response example

この要求の JSON 返信の本文の例を次に示します。The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2015-07-29",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso demo",
      "market": "US",
      "osVersion": "10.0.10240.16410",
      "deviceType": "PC",
      "isRevised": true,
      "packageVersion": "",
      "deviceModel": "Microsoft Corporation-Virtual Machine",
      "productFamily": "PC",
      "deviceRAM": -1,
      "deviceScreenResolution": "1024 x 768",
      "deviceStorageCapacity": 51200,
      "isTouchEnabled": false,
      "reviewerName": "ALeksandra",
      "rating": 5,
      "reviewTitle": "Love it",
      "reviewText": "Great app for demos and great dev response.",
      "helpfulCount": 0,
      "notHelpfulCount": 0,
      "responseDate": "2015-08-07T01:50:22.9874488Z",
      "responseText": "1",
      "id": "6be543ff-1c9c-4534-aced-af8b4fbe0316"
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}