Obter avaliações de app

Use este método na API de análise da Microsoft Store para obter dados de opinião em formato JSON para um determinado intervalo de datas e outros filtros opcionais. Essas informações também estão disponíveis no relatório Revisões no Partner Center.

Depois que você recuperar críticas, você pode usar os métodos obter as informações de resposta para avaliações de app e enviar respostas às críticas do app na API de análises da Microsoft Store para responder às análises de forma programática.

Pré-requisitos

Para usar este método, primeiro você precisa do seguinte:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de análise da Microsoft Store.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.

Solicitação

Sintaxe da solicitação

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

Cabeçalho da solicitação

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< de formulário.

Parâmetros da solicitação

Parâmetro Type Descrição Obrigatório
applicationId string A ID da Store do app para o qual você deseja recuperar dados de opinião. Sim
startDate date A data de início no intervalo de datas dos dados de opinião a serem recuperados. O padrão é a data atual. Não
endDate date A data final no intervalo de datas de dados de opinião a serem recuperados. O padrão é a data atual. Não
top INT O número de linhas de dados a serem retornadas na solicitação. O valor máximo e o valor padrão; se não forem especificados, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um link que você poderá usar para solicitar a próxima página de dados. Não
skip INT O número de linhas a serem ignoradas na consulta. Use este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recuperam as primeiras 10.000 linhas de dados, top=10000 e skip=10000 recuperam as próximas 10.000 linhas de dados e assim por diante. Não
filter string Uma ou mais instruções que filtram as linhas na resposta. Para saber mais, consulte a seção campos de filtro a seguir. Não
orderby string Uma instrução que ordena os valores dos dados de resultado. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser uma das seguintes sequências:
  • date
  • Osversion
  • Mercado
  • Devicetype
  • isRevised
  • packageVersion
  • deviceModel
  • productFamily
  • deviceScreenResolution
  • isTouchEnabled
  • reviewerName
  • reviewTitle
  • reviewText
  • helpfulCount
  • notHelpfulCount
  • responseDate
  • responseText
  • deviceRAM
  • deviceStorageCapacity
  • Classificação

O parâmetro order é opcional e pode ser asc ou desc para especificar a ordem crescente ou decrescente de cada campo. O padrão é asc.

Aqui está um exemplo de cadeia de caracteres orderby : orderby=date,market

Não

Campos de filtro

O parâmetro filter da solicitação contém uma ou mais instruções que filtram as linhas da resposta. Cada instrução contém um campo e um valor que estão associados a operadores eq ou ne e alguns campos também dão suporte a operadores contains, gt, lt, ge e le. Instruções podem ser combinadas usando-se and ou or.

Este é um exemplo de cadeia de caracteres filtro: filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'

Para obter uma lista dos campos com suporte e os operadores de suporte para cada campo, consulte a tabela a seguir. Os valores de sequência devem estar entre aspas simples no parâmetro filter.

Campos Operadores com suporte Descrição
market eq, ne Uma cadeia de caracteres que contém o código do país ISO 3166 do mercado do dispositivo.
osVersion eq, ne Uma das cadeias de caracteres a seguir:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Desconhecido
deviceType eq, ne Uma das cadeias de caracteres a seguir:
  • PC
  • Telefone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • Desconhecido
isRevised eq, ne Especifique true para filtrar por análises que foram revisadas; caso contrário, false.
packageVersion eq, ne A versão do pacote do aplicativo que foi revisado.
deviceModel eq, ne O tipo de dispositivo no qual o aplicativo foi avaliado.
productFamily eq, ne Uma das cadeias de caracteres a seguir:
  • PC
  • Tablet
  • Telefone
  • Wearable
  • Servidor
  • Collaborative
  • Outras
deviceRAM eq, ne, gt, lt, ge, le A RAM física, em MB.
deviceScreenResolution eq, ne A resolução de tela do dispositivo no formato "largura x altura".
deviceStorageCapacity eq, ne, gt, lt, ge, le A capacidade do disco do armazenamento principal, em GB.
isTouchEnabled eq, ne Especifique true para filtrar por dispositivos habilitados para toque; caso contrário, false.
reviewerName eq, ne O nome do revisor.
classificação eq, ne, gt, lt, ge, le A classificação do app, em estrelas.
reviewTitle eq, ne, contains O título da análise.
reviewText eq, ne, contains O conteúdo de texto da análise.
helpfulCount eq, ne O número de vezes que a análise foi marcada como útil.
notHelpfulCount eq, ne O número de vezes que a análise foi marcada como não útil.
responseDate eq, ne A data em que a resposta foi enviada.
responseText eq, ne, contains O conteúdo de texto da resposta.
id eq, ne A ID da revisão (este é um GUID).

Exemplo de solicitação

Os exemplos a seguir demonstram várias solicitações para a obtenção de dados de análise. Substitua o valor de applicationId pela ID da Store de seu 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>

Resposta

Corpo da resposta

Valor Type Descrição
Valor array Uma matriz de objetos que contêm dados de opinião. Para saber mais sobre os dados em cada objeto, consulte a seção de valores de opinião a seguir.
@nextLink string Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um URI que você poderá usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro top da solicitação estiver definido como 10.000, mas houver mais de 10.000 linhas de dados de análise para a consulta.
TotalCount INT O número total de linhas no resultado dos dados da consulta.

 

Valores de opinião

Os elementos na matriz Value contêm os valores a seguir.

Valor Type Descrição
date string A primeira data no intervalo de datas dos dados de análise. Se a solicitação tiver especificado um único dia, o valor será essa data. Se a solicitação especificou uma semana, um mês ou outro intervalo de datas, o valor será a primeira data nesse intervalo de datas.
applicationId string A ID da Loja do app para o qual você está recuperando dados de análise.
applicationName string O nome de exibição do app.
market string O código do país ISO 3166 do mercado em que a análise foi enviada.
osVersion string A versão do sistema operacional no qual a análise foi enviada. Para obter uma lista das cadeias de caracteres com suporte, consulte a seção campos de filtro acima.
deviceType string O tipo de dispositivo no qual a análise foi enviada. Para obter uma lista das cadeias de caracteres com suporte, consulte a seção campos de filtro acima.
isRevised Boolean O valor true indica que a opinião foi revisada; caso contrário, false.
packageVersion string A versão do pacote do aplicativo que foi revisado.
deviceModel string O tipo de dispositivo no qual o aplicativo foi avaliado.
productFamily string O nome da família de dispositivos. Para obter uma lista das cadeias de caracteres com suporte, consulte a seção campos de filtro acima.
deviceRAM número A RAM física, em MB.
deviceScreenResolution string A resolução de tela do dispositivo no formato "largura x altura".
deviceStorageCapacity número A capacidade do disco do armazenamento principal, em GB.
isTouchEnabled Boolean O valor true indica que é habilitado para toque; caso contrário, false.
reviewerName string O nome do revisor.
classificação número A classificação do app, em estrelas.
reviewTitle string O título da análise.
reviewText string O conteúdo de texto da análise.
helpfulCount número O número de vezes que a análise foi marcada como útil.
notHelpfulCount número O número de vezes que a análise foi marcada como não útil.
responseDate string A data em que uma resposta foi enviada.
responseText string O conteúdo de texto da resposta.
id string A ID da revisão (este é um GUID). Você pode usar essa ID nos métodos obter as informações de resposta para avaliações de aplicativo e enviar respostas às críticas do aplicativo.

Exemplo de solicitação e resposta

Os snippets de código a seguir demonstram alguns exemplos de solicitação e corpo de resposta JSON para essas solicitações.

Solicitação de Exemplo

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?applicationId=9WZDNCRFJB4P&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Exemplo de Resposta

{
    "Value": [
        {
            "date": "3/5/2021 12:48:33 PM",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": false,
            "packageVersion": "2.5.2.34894",
            "reviewerName": "Jose Antonio",
            "rating": 5,
            "reviewTitle": "Contoso Demo",
            "reviewText": "Un juego fantastico",
            "helpfulCount": 3,
            "notHelpfulCount": 0,
            "id": "b5e27de9-2334-4849-d17d-4eae3e1e7aa9"
        },
        {
            "date": "1/6/2021 8:41:42 AM",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "TR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": false,
            "packageVersion": "2.5.2.34894",
            "reviewerName": "fef",
            "rating": 5,
            "helpfulCount": 0,
            "notHelpfulCount": 0,
            "id": "f5d2510a-9796-45ee-01e5-6d5cc4550b09"
        }
    ],
    "TotalCount": 2
}