Compartir a través de


Obtener las valoraciones de la aplicación

Usa este método en la API de análisis de Microsoft Store para obtener los datos agregados de calificaciones en formato JSON correspondientes a un intervalo de fechas determinado y otros filtros opcionales. Esta información también está disponible en el informe Revisiones del Centro de partners.

Requisitos previos

Para usar este método, primero debes hacer lo siguiente:

  • Si aún no lo has hecho, completa todos los requisitos previos de la API de análisis de Microsoft Store.
  • Consigue un token de acceso a Azure AD para utilizarlo en el encabezado de solicitud de este método. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede obtener uno nuevo.

Solicitar

Sintaxis de la solicitud

Método URI de solicitud
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings

Encabezado de solicitud

Encabezado Tipo Descripción
Autorización string Necesario. Token de acceso de Azure AD con el formato Token<de portador>.

Parámetros de solicitud

Parámetro Tipo Descripción Obligatorio
applicationId string El Id. de Store de la aplicación de la que quieres recuperar los datos de calificaciones.
startDate date Fecha de inicio del intervalo de fechas de los datos de calificaciones que se van a recuperar. La fecha actual es el valor predeterminado. No
endDate date Fecha de finalización del intervalo de fechas de los datos de calificaciones que se van a recuperar. La fecha actual es el valor predeterminado. No
superior int Número de filas de datos que se van a devolver en la solicitud. Si no se especifica, el valor predeterminado y el valor máximo es 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo “Siguiente” que puedes usar para solicitar la siguiente página de datos. No
skip int Número de filas que se omiten en la consulta. Usa este parámetro para pasar de página en conjuntos de datos grandes. Por ejemplo, top=10000 y skip=0 recupera las primeras 10000 filas de datos, top=10000 y skip=10000 recupera las siguientes 10000 filas de datos, etc. No
filter string Una o varias instrucciones que filtran las filas de la respuesta. Para más información, consulte la sección campos de filtro a continuación. No
aggregationLevel string Especifica el intervalo de tiempo para el que se van a recuperar los datos agregados. Puede ser una de las siguientes cadenas: día, semana o mes. Si no se especifica nada, el valor predeterminado es día. No
orderby string Instrucción que ordena los valores de los datos en los resultados para cada calificación. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede estar formado por una de las siguientes cadenas:
  • date
  • osVersion
  • market
  • deviceType
  • isRevised

El parámetro order es opcional y puede ser asc o desc para especificar el orden ascendente o descendente de cada campo. El valor predeterminado es asc.

Este es un ejemplo de cadena orderby: orderby=date,market

No
groupby string Instrucción que aplica la agregación de datos solo a los campos especificados. Puedes especificar los siguientes campos:
  • date
  • applicationName
  • market
  • osVersion
  • deviceType
  • isRevised

Las filas de datos devueltas contendrán los campos especificados en el parámetro groupby, además de los siguientes:

  • date
  • applicationId
  • fiveStars
  • fourStars
  • threeStars
  • twoStars
  • oneStar

El parámetro groupby se puede usar con el parámetro aggregationLevel. Por ejemplo: &groupby=osVersion,market&aggregationLevel=week

No

 

Campos de filtro

El parámetro filter de la solicitud contiene una o varias instrucciones que filtran las filas de la respuesta. Cada instrucción contiene un campo y un valor asociados a los operadores eq o ne, y las instrucciones se pueden combinar mediante y u o.

Este es ejemplo de cadena de filtro: filter=market eq 'US' and deviceType eq 'phone' and isRevised eq true

Consulta la siguiente tabla para ver una lista de los campos admitidos. Los valores de cadena deben estar entre comillas simples en el parámetro de filtro.

Campos Descripción
market Cadena que contiene el código de país ISO 3166 del mercado desde el que se calificó la aplicación.
osVersion Una de las cadenas siguientes:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
deviceType Una de las cadenas siguientes:
  • PC
  • Teléfono
  • Consola-Xbox One
  • Consola-Xbox Series X
  • IoT
  • Holográfico
  • Unknown
isRevised Especifica verdadero para filtrar calificaciones que han sido revisadas; en caso contrario, especifica falso.

Ejemplo de solicitud

En los ejemplos siguientes se muestran varias solicitudes de obtención de datos de calificaciones. Reemplaza el valor applicationId por el Id. de Store de tu aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?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/ratings?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' HTTP/1.1
Authorization: Bearer <your access token>

Respuesta

Cuerpo de la respuesta

Valor Tipo Descripción
Valor array Matriz de objetos que contienen datos agregados de calificaciones. Para obtener más información sobre los datos de cada objeto, consulta la sección valores de calificación a continuación.
@nextLink string Si hay páginas adicionales de datos, esta cadena contiene un URI que se puede usar para solicitar la siguiente página de datos. Por ejemplo, este valor se devuelve si el parámetro top de la solicitud se establece en 10000, pero hay más de 10000 filas de datos de calificaciones para la consulta.
TotalCount int Número total de filas que figura en el resultado de datos de la consulta.

Valores de calificación

Los elementos de la matriz Value contienen los valores siguientes.

Valor Tipo Descripción
date string La primera fecha del intervalo de fechas de los datos de calificaciones. Si la solicitud especificaba un solo día, este valor es esa fecha. Si la solicitud especificaba una semana, un mes u otro intervalo de fechas, este valor es la primera fecha de ese intervalo de fechas.
applicationId string El Id. de Store de la aplicación para la que se recuperan los datos de calificaciones.
applicationName string Nombre para mostrar de la aplicación.
market string El código de país ISO 3166 del mercado desde el que se envió la calificación.
osVersion string Versión del sistema operativo desde el que se envió la calificación. Para obtener una lista de las cadenas admitidas, consulta la sección campos de filtro más arriba.
deviceType string Tipo de dispositivo desde el que se envió la calificación. Para obtener una lista de las cadenas admitidas, consulta la sección campos de filtro más arriba.
isRevised Booleano El valor verdadero indica que se ha revisado la calificación; de lo contrario, será falso.
oneStar number Número de calificaciones de una estrella.
twoStars number Número de calificaciones de dos estrellas.
threeStars number Número de calificaciones de tres estrellas.
fourStars number Número de calificaciones de cuatro estrellas.
fiveStars number Número de calificaciones de cinco estrellas.

Ejemplo de solicitud y respuesta

En los fragmentos de código siguientes se muestran algunos ejemplos de solicitud y del cuerpo de la respuesta en formato JSON de esa solicitud.

Solicitud de muestra

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo


{
    "Value": [
        {
            "date": "2012-09-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 3
        },
        {
            "date": "2012-09-02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 3,
            "twoStars": 0,
            "threeStars": 1,
            "fourStars": 2,
            "fiveStars": 17
        },
        {
            "date": "2012-09-03",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 1,
            "threeStars": 1,
            "fourStars": 5,
            "fiveStars": 17
        },
  ],
    "TotalCount": 3
}

Solicitud de muestra

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=date,applicationName,market,osVersion,deviceType,isRevised
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

{
    "Value": [
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "CL",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "TR",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-29",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "FR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        },
        {
            "date": "2022-07-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-04",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-07",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "AE",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 0
        },
        {
            "date": "2022-07-10",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "EG",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-14",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        }
    ],
    "TotalCount": 10
}