Partilhar via


Obter avaliações de app

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

Depois de recuperar as revisões, você pode usar os métodos obter informações de resposta para revisões de aplicativos e enviar respostas a revisões de aplicativos na API de revisões da Microsoft Store para responder programaticamente às revisões.

Pré-requisitos

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

  • Se você ainda não fez isso, conclua todos os pré-requisitos da 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 esse 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.

Solicitar

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

Cabeçalho Tipo Descrição
Autorização string Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.

Parâmetros da solicitação

Parâmetro Tipo Descrição Obrigatório
applicationId string A ID da Store do aplicativo cujos dados de revisão você deseja recuperar. Sim
startDate date A data de início no intervalo de datas dos dados de revisão a serem recuperados. O padrão é a data atual. Não
endDate date A data de término no intervalo de datas dos dados de revisã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 padrão, se não for especificado, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um proximo 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 esse parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recupera as primeiras 10.000 mil linhas de dados, top=10000 e skip=10000 recupera as próximas dez mil linhas de dados, e assim por diante. Não
filtro string Uma ou mais instruções que filtram as linhas na resposta. Para obter mais informações, consulte a seção sobre campos de filtro abaixo. 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
  • market
  • deviceType
  • isRevised
  • packageVersion
  • Modelo do dispositivo
  • família de produtos
  • resolução de tela do dispositivo
  • isTouchEnabled
  • nome do revisor
  • reviewTítulo
  • reviewTexto
  • helpfulCount
  • notHelpfulCount
  • data de resposta
  • respostaTexto
  • para dispositivoRAM
  • deviceStorageCapacity
  • classificação

O parâmetro order é opcional e pode ser asc ou desc para especificar ordem ascendente ou descendente para cada campo. O padrão é asc.

Este é um exemplo de sequência orderby: orderby=date,market

Não

Filtrar campos

O parâmetro filter da solicitação contém uma ou mais instruções que filtram as linhas na resposta. Cada instrução contém um campo e um valor associados aos operadores eq ou ne , e alguns campos também suportam os operadores contains, gt, lt, ge e le . As instruções podem ser combinadas usando e ou ou.

Aqui está um exemplo de string de filtro : filter=contains(reviewText,'great') e contains(reviewText,'ads') e deviceRAM lt 2048 e market eq 'US'

Para obter uma lista dos campos suportados e 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.

Fields Operadores suportados Descrição
market eq, ne Uma string que contém o código de país ISO 3166 do mercado de dispositivos.
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:
  • Computador
  • Telefone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holográfico
  • Desconhecido
isRevised eq, ne Especifique true para filtrar as revisões que foram revisadas; caso contrário , false.
packageVersion eq, ne A versão do pacote do aplicativo que foi revisada.
deviceModel eq, ne O tipo de dispositivo no qual o aplicativo foi revisado.
família de produtos eq, ne Uma das cadeias de caracteres a seguir:
  • Computador
  • Tablet
  • Telefone
  • Wearable
  • Servidor
  • Colaborativo
  • Outras
para dispositivoRAM eq, ne, gt, lt, ge, le A RAM física, em MB.
resolução de tela do dispositivo eq, ne A resolução da tela do dispositivo no formato "largura x altura".
deviceStorageCapacity eq, ne, gt, lt, ge, le A capacidade do disco de armazenamento primário, em GB.
isTouchEnabled eq, ne Especifique true para filtrar dispositivos habilitados para toque; caso contrário , false.
nome do revisor eq, ne O nome do revisor.
classificação eq, ne, gt, lt, ge, le A classificação do aplicativo, em estrelas.
reviewTítulo eq, ne, contém O título da revisão.
reviewTexto eq, ne, contém O conteúdo do texto da revisão.
helpfulCount eq, ne O número de vezes que a avaliação foi marcada como útil.
notHelpfulCount eq, ne O número de vezes que a avaliação foi marcada como não é útil.
data de resposta eq, ne A data em que a resposta foi enviada.
respostaTexto eq, ne, contém 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 obter dados de revisão. Substitua o valor applicationId pela ID da Store para seu aplicativo.

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 matriz Uma matriz de objetos que contêm dados de revisão. Para obter mais informações sobre os dados em cada objeto, consulte a seção de valores de revisão abaixo.
@nextLink string Se houver páginas adicionais de dados, essa sequência 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 10000, mas se existirem mais de 10000 linhas de dados de revisão para a consulta.
TotalCount int O número total de linhas no resultado de dados da consulta.

 

Revisar valores

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

Valor Type Descrição
date string A primeira data no intervalo de datas para os dados de revisão. Se a solicitação tiver especificado um único dia, esse valor será essa data. Se a solicitação tiver especificado uma semana, um mês ou outro intervalo de datas, esse valor será a primeira data nesse intervalo de datas.
applicationId string A ID da Loja do aplicativo para o qual você está recuperando dados de revisão.
applicationName string O nome de exibição do aplicativo.
market string O código ISO 3166 do mercado onde a avaliação foi enviada.
osVersion string A versão do sistema operacional na qual a revisão foi enviada. Para obter uma lista das sequências com suporte, consulte a seção campos de filtro acima.
deviceType string O tipo de dispositivo no qual a revisão foi enviada. Para obter uma lista das sequências com suporte, consulte a seção campos de filtro acima.
isRevised Booliano O valor true indica que a revisão foi revisada; caso contrário , false.
packageVersion string A versão do pacote do aplicativo que foi revisada.
deviceModel string O tipo de dispositivo no qual o aplicativo foi revisado.
família de produtos string O nome da família do dispositivo. Para obter uma lista das sequências com suporte, consulte a seção campos de filtro acima.
para dispositivoRAM número A RAM física, em MB.
resolução de tela do dispositivo string A resolução da tela do dispositivo no formato "largura x altura".
deviceStorageCapacity número A capacidade do disco de armazenamento primário, em GB.
isTouchEnabled Booliano O valor true indica que o toque está ativado; caso contrário , false.
nome do revisor string O nome do revisor.
classificação número A classificação do aplicativo, em estrelas.
reviewTítulo string O título da revisão.
reviewTexto string O conteúdo do texto da revisão.
helpfulCount número O número de vezes que a avaliação foi marcada como útil.
notHelpfulCount número O número de vezes que a avaliação foi marcada como não é útil.
data de resposta string A data em que uma resposta foi enviada.
respostaTexto 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 de obter informações de resposta para avaliações de aplicativos e enviar respostas para avaliações de aplicativos.

Exemplo de solicitação e resposta

Os snippets de código a seguir demonstram alguns exemplos de solicitações e o corpo da resposta JSON para estas 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>

Resposta de exemplo

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