Compartilhar via

Obter avaliações de aplicativo

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 Revisões no Partner Center.

Depois de recuperar as revisões, você pode usar o obter informações de resposta para revisões de aplicativo e enviar respostas a revisões de aplicativo métodos na API de revisões da Microsoft Store para responder a revisões de forma programática.

Pré-requisitos

Para usar esse 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. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.

Solicitação

Sintaxe da solicitação

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

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização corda Obrigatório O token de acesso do Azure AD no formato Bearer<token>.

Parâmetros de solicitação

Parâmetro Tipo Descrição Obrigatório
ID do aplicativo corda A ID da Store do aplicativo para o qual você deseja recuperar dados de revisão. Sim
Data de Início data 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
data de término data A data final do intervalo de datas dos dados de revisão a serem recuperados. O padrão é a data atual. Não
Início int O número de linhas de dados a serem retornados na solicitação. O valor máximo e o valor padrão se não especificado for 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um próximo link que você pode usar para solicitar a próxima página de dados. Não
pular 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 10000 linhas de dados, top=10000 e skip=10000 recupera as próximas 10000 linhas de dados e assim por diante. Não
filtro corda Uma ou mais declarações que filtram as linhas da resposta. Para obter mais informações, consulte a seção de campos de filtro abaixo. Não
orderby corda Uma instrução que ordena os valores dos dados resultantes. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser uma das seguintes strings:
  • data
  • OSVersion
  • mercado
  • tipoDeDispositivo
  • foi revisado
  • Versão do pacote
  • deviceModel
  • Família de Produtos
  • resolução da tela do dispositivo
  • telaSensívelAoToqueHabilitada
  • reviewerName
  • reviewTitle
  • texto da resenha
  • contagemÚtil
  • contagemDeNãoÚteis
  • responseDate
  • textoDeResposta
  • RAM do dispositivo
  • capacidadeDeArmazenamentoDoDispositivo
  • 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.

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

 Não

Filtrar campos

O parâmetro de filtro 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 contém, gt, lt, gee le. Declarações podem ser combinadas usando e ou ou.

Veja um exemplo filtrar cadeia de caracteres: filter=contains(reviewText,'great') e contains(reviewText,'ads') e deviceRAM lt 2048 e market eq 'US'

Para obter uma lista dos campos com suporte e operadores de suporte para cada campo, consulte a tabela a seguir. Os valores de cadeia de caracteres devem ser cercados por aspas simples no parâmetro de filtro .

Campos Operadores suportados Descrição
mercado eq, ne Uma cadeia de caracteres que contém o código de país ISO 3166 do mercado de dispositivos.
osVersion eq, ne Uma das seguintes cadeias de caracteres:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Desconhecido
tipo de dispositivo eq, ne Uma das seguintes cadeias de caracteres:
  • Computador
  • Telefone
  • Console-Xbox Um
  • SérieConsole-Xbox X
  • IoT
  • Holográfico
  • Desconhecido
éRevisado eq, ne Especifique verdadeiro para filtrar as revisões que foram alteradas; caso contrário, falso.
versão do pacote eq, ne A versão do pacote do aplicativo que foi revisado.
modelo do dispositivo eq, ne O tipo de dispositivo no qual o aplicativo foi revisado.
família de produtos eq, ne Uma das seguintes cadeias de caracteres:
  • Computador
  • Tabuleta
  • Telefone
  • Vestível
  • Servidor
  • Colaborativo
  • Outras
RAM do dispositivo eq, ne, gt, lt, ge, le A RAM física, em MB.
resoluçãoDeTelaDoDispositivo eq, ne A resolução da tela do dispositivo no formato "largura x altura".
capacidadeDeArmazenamentoDoDispositivo eq, ne, gt, lt, ge, le A capacidade do disco de armazenamento primário, em GB.
toqueHabilitado eq, ne Especifique verdadeiro para filtrar dispositivos habilitados para toque; caso contrário, falso.
reviewerName eq, ne O nome do revisor.
classificação eq, ne, gt, lt, ge, le A classificação do aplicativo, em estrelas.
Título da Análise eq, ne, contém O título da revisão.
textoDeRevisão eq, ne, contém O conteúdo do texto da revisão.
helpfulCount eq, ne O número de vezes que a revisão foi marcada como útil.
contagemDeNãoÚtil eq, ne O número de vezes que a revisão foi marcada como não útil.
data de resposta eq, ne A data em que a resposta foi enviada.
textoDeResposta eq, ne, contém O conteúdo do texto da resposta.
id eq, ne O ID da resenha (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 pelo Store ID do 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 Tipo Descrição
Valor conjunto 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 corda Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um URI que você pode usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro superior da solicitação for definido como 10000, mas houver mais de 10.000 linhas de dados de revisões para a consulta.
ContagemTotal int O número total de linhas no resultado dos dados da consulta.

 

Examinar valores

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

Valor Tipo Descrição
data corda 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 especificou uma semana, um mês ou outro intervalo de datas, este valor é a primeira data nesse intervalo.
ID do aplicativo corda O ID da Loja do aplicativo para o qual você está recuperando dados de avaliação.
Nome do aplicativo corda O nome de exibição do aplicativo.
mercado corda O código do país ISO 3166 do mercado em que a revisão foi enviada.
osVersion corda A versão do sistema operacional na qual a revisão foi enviada. Para obter uma lista das strings com suporte, consulte a seção de campos de filtro acima.
tipo de dispositivo corda O tipo de dispositivo no qual a revisão foi enviada. Para obter uma lista das strings com suporte, consulte a seção de campos de filtro acima.
éRevisado Booliano O valor verdadeiro indica que a revisão ocorreu; caso contrário, falso.
versão do pacote corda A versão do pacote do aplicativo que foi revisado.
modelo do dispositivo corda O tipo de dispositivo no qual o aplicativo foi revisado.
família de produtos corda O nome da família de dispositivos. Para obter uma lista das strings com suporte, consulte a seção de campos de filtro acima.
RAM do dispositivo número A RAM física, em MB.
resoluçãoDeTelaDoDispositivo corda A resolução da tela do dispositivo no formato "largura x altura".
capacidadeDeArmazenamentoDoDispositivo número A capacidade do disco de armazenamento primário, em GB.
toqueHabilitado Booliano O valor verdadeiro indica que o toque está habilitado; caso contrário, falso .
reviewerName corda O nome do revisor.
classificação número A classificação do aplicativo, em estrelas.
Título da Análise corda O título da revisão.
textoDeRevisão corda O conteúdo do texto da revisão.
Contagem útil número O número de vezes que a revisão foi marcada como útil.
contagemDeNãoÚtil número O número de vezes que a revisão foi marcada como não útil.
data de resposta corda A data em que uma resposta foi enviada.
textoDeResposta corda O conteúdo do texto da resposta.
id corda O ID da resenha (este é um GUID). Você pode usar este ID para obter informações de respostas para revisões de aplicativo e enviar respostas a revisões de aplicativo nas métodos e .

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>

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
}
  • Last updated on