レビューに対する返信の送信Submit responses to reviews

アプリのレビューにプログラムで返信するには、Microsoft Store レビュー API の以下のメソッドを使います。Use this method in the Microsoft Store reviews API to programmatically respond to reviews of your app. このメソッドを呼び出すときは、返信するレビューの ID を指定する必要があります。When you call this method, you must specify the IDs of the reviews you want to respond to. レビュー 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.

顧客はレビューを送信するときに、レビューへの返信を受け取らないことを選択できます。When a customer submits a review, they can choose not to receive responses to their review. 顧客が返信を受け取らないように指定しているレビューに返信すると、このメソッドの返信の本文には、返信ができなかったことが示されます。If you try to respond to a review for which the customer chose not to receive responses, the response body of this method will indicate that the response attempt was unsuccessful. このメソッドを呼び出す前に、任意で、アプリのレビューへの返信情報の取得メソッドを使用して、特定のレビューへの返信が許可されているかどうかを確認できます。Before calling this method, you can optionally determine whether you are allowed to respond to a given review by using the get response info for app reviews method.

注意

に加えて、このメソッドを使用してプログラムでのレビューに応答する、またはに対応できるレビューパートナー センターを使用してします。In addition to using this method to programmatically respond to reviews, you can alternatively respond to reviews using Partner Center.

前提条件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 reviews 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 IDs of the reviews you want to respond to. レビュー 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
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/reviews/responses

要求ヘッダーRequest header

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

要求パラメーターRequest parameters

このメソッドには要求パラメーターはありません。This method has no request parameters.

要求本文Request body

要求本文には次の値が含まれます。The request body has the following values.

Value 種類Type 説明Description
ResponsesResponses arrayarray 提出する返信を含むオブジェクトの配列です。An array of objects that contain the response data you want to submit. 各オブジェクトのデータの詳細については、以下の表を参照してください。For more information about the data in each object, see the following table.

Responses 配列内の各オブジェクトには、次の値が保持されています。Each object in the Responses array contains the following values.

Value 種類Type 説明Description 必須Required
ApplicationIdApplicationId stringstring 返信対象のレビューがあるアプリのストア ID です。The Store ID of the app with the review you want to respond to. Store ID は、アプリ id のページパートナー センターの。The Store ID is available on the App identity page of 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. Yes
ResponseTextResponseText stringstring 提出する返信です。The response you want to submit. 返信は、こちらのガイドラインに従う必要があります。Your response must follow these guidelines. Yes
SupportEmailSupportEmail stringstring アプリのサポート メール アドレスです。顧客はこのアドレスを使用して、直接連絡できます。Your app's support email address, which the customer can use to contact you directly. したがって、有効なメール アドレスである必要があります。This must be a valid email address. Yes
IsPublicIsPublic ブール値Boolean 指定した場合true応答、アプリのストアの一覧から、顧客のレビューのすぐ下に表示され、は、すべてのお客様に表示されます。If you specify true, your response will be displayed in your app's Store listing, directly below the customer's review, and will be visible to all customers. 指定した場合falseと、ユーザーが電子メールの応答を受信しないことを選択、応答は、電子メールや顧客に送信され、アプリのストアの一覧で他のユーザーに表示されません。If you specify false and the user hasn't opted out of receiving email responses, your response will be sent to the customer via email, and it will not be visible to other customers in your app's Store listing. 指定した場合falseされ、ユーザーが電子メールの応答を受信しないことを選択、エラーが返されます。If you specify false and the user has opted out of receiving email responses, an error will be returned. Yes

要求の例Request example

次の例は、このメソッドを使用して、いくつかのレビューに返信を提出する方法を示しています。The following example demonstrates how to use this method to submit responses to several reviews.

POST https://manage.devcenter.microsoft.com/v1.0/my/reviews/responses HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
  "Responses": [
    {
      "ApplicationId": "9WZDNCRFJ3Q8",
      "ReviewId": "6be543ff-1c9c-4534-aced-af8b4fbe0316",
      "ResponseText": "Thank you for pointing out this bug. I fixed it and published an update, you should have the fix soon",
      "SupportEmail": "support@contoso.com",
      "IsPublic": "true"
    },
    {
      "ApplicationId": "9NBLGGH1RP08",
      "ReviewId": "80c9671a-96c2-4278-bcbc-be0ce5a32a7c",
      "ResponseText": "Thank you for submitting your review. Can you tell more about what you were doing in the app when it froze? Thanks very much for your help.",
      "SupportEmail": "support@contoso.com",
      "IsPublic": "false"
    }
  ]
}

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
結果Result arrayarray 提出した各返信についてのデータを保持するオブジェクトの配列です。An array of objects that contain data about each response you submitted. 各オブジェクトのデータの詳細については、以下の表を参照してください。For more information about the data in each object, see the following table.

Result 配列内の各オブジェクトには、次の値が保持されています。Each object in the Result array contains the following values.

ValueValue 種類Type 説明Description
ApplicationIdApplicationId stringstring 返信対象のレビューがあるアプリのストア ID です。The Store ID of the app with the review you responded to. ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。An example Store ID is 9WZDNCRFJ3Q8.
ReviewIdReviewId stringstring 返信するレビューの ID です。The ID of the review you responded to. これは GUID です。This is a GUID.
SuccessfulSuccessful stringstring 値が true の場合、返信が正常に送信されたことを示します。The value true indicates that your response was sent successfully. 値が false の場合、返信は提出できなかったことを示します。The value false indicates that your response was unsuccessful.
FailureReasonFailureReason stringstring Successfulfalse の場合、この値には失敗の理由が含まれます。If Successful is false, this value contains a reason for the failure. Successfultrue の場合、この値は空です。If Successful is true, this value is empty.

応答の例Response example

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

{
  "Result": [
    {
      "ApplicationId": "9WZDNCRFJ3Q8",
      "ReviewId": "6be543ff-1c9c-4534-aced-af8b4fbe0316",
      "Successful": "true",
      "FailureReason": ""
    },
    {
      "ApplicationId": "9NBLGGH1RP08",
      "ReviewId": "80c9671a-96c2-4278-bcbc-be0ce5a32a7c",
      "Successful": "false",
      "FailureReason": "No Permission"
    }
  ]
}