レビューへの返信情報の取得Get response info for reviews

アプリのユーザー レビューにプログラムで返信する場合は、Microsoft Store レビュー API の以下のメソッドを使って、まずレビューに返信する権限があるかどうかを確認します。If you want to programmatically respond to a customer review of your app, you can use this method in the Microsoft Store reviews API to first determine whether you have permission to respond to the review. レビューの返信を受け取らないことを選択している顧客が送信したレビューに返信することはできません。You cannot respond to reviews submitted by customers who have chosen not to receive review responses. レビューに返信できることを確認した後、アプリのレビューに返信を送信するメソッドを使って、プログラムでレビューに返信します。After you confirm that you can respond to the review, you can then use the submit responses to app reviews method to programmatically respond to it.

前提条件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.
  • 返信できるかどうかを確認するために、対象となるレビューの ID を取得します。Get the ID of the review you want to check to determine whether you can respond to it. レビュー ID は、Microsoft Store 分析 API のアプリのレビューの取得メソッドの応答データ、およびレビュー レポートオフライン ダウンロードで取得できます。Review IDs are available in the response data of the get app reviews method in the Microsoft Store analytics API and in the offline download of the Reviews report.

要求Request

要求の構文Request syntax

メソッドMethod 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/reviews/{reviewId}/apps/{applicationId}/responses/info

要求ヘッダー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 返信できるかどうかを確認するレビューを含むアプリのストア ID です。The Store ID of the app that contains the review for which you want to determine whether you can respond to. Store ID は、アプリ id のページパートナー センターでします。The Store ID is available on the App identity page in Partner Center. ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。An example Store ID is 9WZDNCRFJ3Q8. Yes
reviewIdreviewId stringstring 返信するレビューの ID です (これは GUID です)。The ID of the review you want to respond to (this is a GUID). レビュー ID は、Microsoft Store 分析 API のアプリのレビューの取得メソッドの応答データ、およびレビュー レポートオフライン ダウンロードで取得できます。Review IDs are available in the response data of the get app reviews method in the Microsoft Store analytics API and in the offline download of the Reviews report.
このパラメーターを省略すると、このメソッドの応答の本文は、指定されたアプリの任意のレビューに返信する権限があるかどうかを示します。If you omit this parameter, the response body for this method will indicate whether you have permissions to respond to any reviews for the specified app.
XNo

要求の例Request example

次の例では、このメソッドを使って、特定のレビューに返信できるかどうかを判断する方法を示します。The following examples how to use this method to determine whether you can respond to a given review.

GET https://manage.devcenter.microsoft.com/v1.0/my/reviews/6be543ff-1c9c-4534-aced-af8b4fbe0316/apps/9WZDNCRFJ3Q8/responses/info HTTP/1.1
Authorization: Bearer <your access token>

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
CanRespondCanRespond ブール値Boolean 値が true の場合は、指定されたレビューに返信できること、または指定されたアプリのすべてのレビューに返信する権限があることを示します。The value true indicates that you can respond to the specified review, or that you have permissions to respond to any review for the specified app. それ以外の場合、この値は false です。Otherwise, this value is false.
DefaultSupportEmailDefaultSupportEmail stringstring アプリのストア登録情報で指定されているアプリのサポート メール アドレスです。Your app's support email address as specified in your app's Store listing. サポート メール アドレスを指定しなかった場合、このフィールドは空です。If you did not specify a support email address, this field is empty.

 

応答の例Response example

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

{
  "CanRespond": true,
  "DefaultSupportEmail": "support@contoso.com"
}