Enviar respostas às críticas

Importante

A API de revisões da Microsoft Store, conforme documentado neste tópico, não está atualmente em um estado de funcionamento. Em vez de usar as APIs, você pode realizar a(s) mesma(s) tarefa(s) usando o Partner Center.

Use esse método na API de revisões da Microsoft Store para responder programaticamente às avaliações de seu aplicativo. Ao chamar esse método, você deve especificar os IDs das revisões às quais deseja responder. As IDs de revisão estão disponíveis nos dados de resposta do método get app reviews na API de análise da Microsoft Store e no download offline do relatório Reviews.

Quando um cliente envia uma avaliação, ele pode optar por não receber respostas à avaliação. Se você tentar responder a uma revisão para a qual o cliente optou por não receber respostas, o corpo da resposta desse método indicará que a tentativa de resposta não foi bem-sucedida. Antes de chamar esse método, você pode, opcionalmente, determinar se tem permissão para responder a uma determinada revisão usando o método get response info for app reviews .

Observação

Além de usar esse método para responder programaticamente a avaliações, você pode responder a avaliações usando o Partner Center.

Pré-requisitos

Para usar esse método, você precisa primeiro fazer o seguinte:

  • Se você ainda não tiver feito isso, preencha todos os pré-requisitos para a API de revisões da Microsoft Store.
  • Obtenha um token de acesso do Azure AD para usar no cabeçalho da solicitação para esse método. Depois de obter um token de acesso, você tem 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.
  • Obtenha os IDs das avaliações às quais você deseja responder. As IDs de revisão estão disponíveis nos dados de resposta do método get app reviews na API de análise da Microsoft Store e no download offline do relatório Reviews.

Solicitação

Sintaxe da solicitação

Método URI da solicitação
POST https://manage.devcenter.microsoft.com/v1.0/my/reviews/responses

Cabeçalho da solicitação

parâmetro Digite Descrição
Autorização string Obrigatórios. O token de acesso do Azure AD no formato Token> de<portador.

Parâmetros da solicitação

Esse método não tem parâmetros de solicitação.

Corpo da solicitação

O corpo da solicitação tem os seguintes valores.

Valor Type Descrição
Respostas array Uma matriz de objetos que contêm os dados de resposta que você deseja enviar. Para obter mais informações sobre os dados em cada objeto, consulte a tabela a seguir.

Cada objeto na matriz Responses contém os seguintes valores.

Valor Type Descrição Obrigatório
ApplicationId string A ID da Loja do aplicativo com a revisão à qual você deseja responder. A ID da Loja está disponível na página Identidade do aplicativo do Partner Center. Um exemplo de ID da Loja é 9WZDNCRFJ3Q8. Sim
ReviewId string A ID da revisão à qual você deseja responder (este é um GUID). As IDs de revisão estão disponíveis nos dados de resposta do método get app reviews na API de análise da Microsoft Store e no download offline do relatório Reviews. Sim
ResponseText string A resposta que você deseja enviar. Sua resposta deve seguir estas diretrizes. Sim
SuporteEmail string O endereço de e-mail de suporte do seu aplicativo, que o cliente pode usar para entrar em contato diretamente com você. Este deve ser um endereço de e-mail válido. Sim
Épúblico Booliano Se você especificar true, sua resposta será exibida na listagem da Loja do seu aplicativo, diretamente abaixo da avaliação do cliente, e ficará visível para todos os clientes. Se você especificar false e o usuário não tiver optado por não receber respostas por e-mail, sua resposta será enviada ao cliente por e-mail e não ficará visível para outros clientes na listagem da Loja do seu aplicativo. Se você especificar false e o usuário tiver optado por não receber respostas por e-mail, um erro será retornado. Sim

Exemplo de solicitação

O exemplo a seguir demonstra como usar esse método para enviar respostas a várias revisões.

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

Resposta

Corpo da resposta

Valor Type Descrição
Resultado array Uma matriz de objetos que contêm dados sobre cada resposta enviada. Para obter mais informações sobre os dados em cada objeto, consulte a tabela a seguir.

Cada objeto na matriz Result contém os seguintes valores.

Valor Type Descrição
ApplicationId string A ID da Loja do aplicativo com a avaliação à qual você respondeu. Um exemplo de ID da Loja é 9WZDNCRFJ3Q8.
ReviewId string O ID da revisão à qual você respondeu. Este é um GUID.
Bem-sucedido string O valor true indica que sua resposta foi enviada com êxito. O valor false indica que sua resposta não foi bem-sucedida.
Motivo da falha string Se Successful for false, esse valor conterá um motivo para a falha. Se Êxito for true, esse valor estará vazio.

Exemplo de resposta

O exemplo a seguir demonstra um exemplo de corpo de resposta JSON para essa solicitação.

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