レビューに対する返信の送信

  • [アーティクル]

重要

このトピックに記載されているように、Microsoft Store レビュー API は現在動作状態ではありません。 API を使用する代わりに、パートナー センターを使用して同じタスクを実行できます。

アプリのレビューにプログラムで返信するには、Microsoft Store レビュー API の以下のメソッドを使います。 このメソッドを呼び出すときは、返信するレビューの ID を指定する必要があります。 レビュー ID は、Microsoft Store 分析 API のアプリのレビューの取得メソッドの応答データ、およびレビュー レポートのオフライン ダウンロードで取得できます。

顧客はレビューを送信するときに、レビューへの返信を受け取らないことを選択できます。 顧客が返信を受け取らないように指定しているレビューに返信すると、このメソッドの返信の本文には、返信ができなかったことが示されます。 このメソッドを呼び出す前に、任意で、アプリのレビューへの返信情報の取得メソッドを使用して、特定のレビューへの返信が許可されているかどうかを確認できます。

注意

このメソッドを使ってプログラムでレビューに返信する以外に、パートナー センターを使ってレビューに返信することもできます。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store レビュー API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
  • 返信するレビューの ID を取得します。 レビュー ID は、Microsoft Store 分析 API のアプリのレビューの取得メソッドの応答データ、およびレビュー レポートのオフライン ダウンロードで取得できます。

要求

要求の構文

認証方法 要求 URI
POST https://manage.devcenter.microsoft.com/v1.0/my/reviews/responses

要求ヘッダー

Header Type 説明
承認 string 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。

要求パラメーター

このメソッドには要求パラメーターはありません。

要求本文

要求本文には次の値が含まれます。

値 Type [説明]
Responses array 提出する返信を含むオブジェクトの配列です。 各オブジェクトのデータの詳細については、以下の表を参照してください。

Responses 配列内の各オブジェクトには、次の値が保持されています。

値 Type 説明 必須
ApplicationId string 返信対象のレビューがあるアプリのストア ID です。 ストア ID は、パートナー センターのアプリ ID ページで確認できます。 ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。 はい
ReviewId string 返信するレビューの ID です (これは GUID です)。 レビュー ID は、Microsoft Store 分析 API のアプリのレビューの取得メソッドの応答データ、およびレビュー レポートのオフライン ダウンロードで取得できます。 はい
ResponseText string 提出する返信です。 返信は、こちらのガイドラインに従う必要があります。 はい
SupportEmail string アプリのサポート メール アドレスです。顧客はこのアドレスを使用して、直接連絡できます。 したがって、有効なメール アドレスである必要があります。 はい
IsPublic ブール値 true を指定する場合、返信は、アプリのストア登録情報で、顧客のレビューのすぐ下に表示され、すべての顧客が見ることができます。 false を指定し、かつユーザーがメール返信の受信をオプトアウトしていない場合、返信は、メールで顧客に送信され、アプリのストア登録情報で他の顧客が見ることはできません。 false を指定し、かつユーザーがメールの返信の受信をオプトアウトしている場合、エラーが返されます。 はい

要求の例

次の例は、このメソッドを使用して、いくつかのレビューに返信を提出する方法を示しています。

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
    }
  ]
}

[応答]

応答本文

値 Type 説明
結果 array 提出した各返信についてのデータを保持するオブジェクトの配列です。 各オブジェクトのデータの詳細については、以下の表を参照してください。

Result 配列内の各オブジェクトには、次の値が保持されています。

値 Type 説明
ApplicationId string 返信対象のレビューがあるアプリのストア ID です。 ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。
ReviewId string 返信するレビューの ID です。 これは GUID です。
成功 string 値が true の場合、返信が正常に送信されたことを示します。 値が false の場合、返信は提出できなかったことを示します。
FailureReason string Successful が false の場合、この値には失敗の理由が含まれます。 Successful が true の場合、この値は空です。

応答の例

この要求の JSON 返信の本文の例を次に示します。

{
  "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"
    }
  ]
}