Obtener el uso mensual de la aplicación

Artículo
01/18/2024

Usa este método en la API de análisis de Microsoft Store para obtener los datos de uso agregados (excluyendo el multijugador de Xbox) de una aplicación en formato JSON correspondientes a un intervalo de fechas determinado (solo los últimos 90 días) y otros filtros opcionales. Esta información también está disponible en el informe Uso del Centro de partners.

La telemetría de las aplicaciones PWA basadas en Anaheim se recopila a nivel de dispositivo. Por lo tanto, las métricas relacionadas con los usuarios no estarán disponibles para estos productos. Consulta la sección Valores de uso a continuación para obtener más detalles sobre la validez de los campos.

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/usagemonthly`

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 revisión.	Sí
startDate	date	Fecha de inicio del intervalo de fechas de los datos de revisión 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 revisión 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. Cada instrucción contiene un nombre de campo del cuerpo de la respuesta y el valor que están asociados a los operadores eq o ne, y las instrucciones se pueden combinar mediante y u o. Los valores de cadena deben estar entre comillas simples en el parámetro de filtro. Puedes especificar los campos siguientes desde el cuerpo de la respuesta: market deviceType packageVersion	No
orderby	string	Instrucción que ordena los valores de los datos en los resultados. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede estar formado por una de las siguientes cadenas: date applicationId applicationName market packageVersion deviceType subscriptionName monthlySessionCount engagementDurationMinutes monthlyActiveUsers monthlyActiveDevices monthlyNewUsers averageDailyActiveUsers averageDailyActiveDevices monthlyNewDevices 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 campos siguientes desde el cuerpo de la respuesta: applicationName subscriptionName deviceType packageVersion market date Las filas de datos devueltas contendrán los campos especificados en el parámetro groupby, además de los siguientes: applicationId subscriptionName monthlySessionCount engagementDurationMinutes monthlyActiveUsers monthlyActiveDevices monthlyNewUsers averageDailyActiveUsers averageDailyActiveDevices monthlyNewDevices El parámetro groupby se puede usar con el parámetro aggregationLevel. Por ejemplo: &groupby=ageGroup,market&aggregationLevel=week	No

Ejemplo de solicitud

En el ejemplo siguiente se muestra una solicitud de obtención de datos de uso mensual de la aplicación. Reemplaza el valor applicationId por el Id. de Store de tu aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=XXXXXXXXXXXX&startDate=2018-06-01&endDate=2018-07-01 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 de uso agregados. Para obtener más información sobre los datos de cada objeto, consulta la siguiente tabla.
@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 revisiones para la consulta.
TotalCount	int	Número total de filas que figura en el resultado de datos de la consulta.

Valores de uso

Los elementos de la matriz Value contienen los valores siguientes.

Valor	Tipo	Descripción	Disponibilidad de UWP	Disponibilidad de PWA basada en Anaheim	Disponibilidad de Xbox
date	string	La primera fecha del intervalo de fechas de los datos de uso. 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.	Sí	Sí	Sí
applicationId	string	El Id. de Store de la aplicación para la que se recuperan los datos de uso.	Sí	Sí	Sí
applicationName	string	Nombre para mostrar de la aplicación.	Sí	Sí	Sí
market	string	El código de país ISO 3166 del mercado en el que el cliente usó la aplicación.	Sí	Sí	Sí
packageVersion	string	Versión del paquete donde se produjo el uso.	Sí	Sí	No
deviceType	string	Una de las siguientes cadenas que especifica el tipo de dispositivo en el que se produjo el uso: PC Teléfono Consola-Xbox One Consola-Xbox Series X Tablet IoT Server Holográfico Unknown	Sí	Sí	Sí
subscriptionName	string	Indica si el uso se realizó a través del Xbox Game Pass.	Sí	No	No
monthlySessionCount	long	Número de sesiones de usuario durante ese mes.	Sí	Sí	Sí
engagementDurationMinutes	doble	Minutos en los que los usuarios usan activamente la aplicación medida durante un período específico de tiempo, comenzando cuando la aplicación se inicia (inicio del proceso) y terminanzo cuando se finaliza (finalización del proceso) o después de un período de inactividad.	Sí	Sí	Sí
monthlyActiveUsers	long	Número de clientes que usan la aplicación ese mes.	Sí	No	Sí
monthlyActiveDevices	long	Número de dispositivos en los que se ejecuta la aplicación durante un período específico de tiempo, comenzando cuando la aplicación se inicia (inicio del proceso) y terminanzo cuando se finaliza (finalización del proceso) o después de un período de inactividad.	Sí	Sí	Sí
monthlyNewUsers	long	Número de clientes que usaron la aplicación por primera vez ese mes.	Sí	No	Sí
averageDailyActiveUsers	doble	Número medio de clientes que usan la aplicación diariamente.	Sí	No	Sí
averageDailyActiveDevices	doble	Número medio de dispositivos usados para interaccionar con la aplicación por parte de todos los usuarios diariamente.	Sí	Sí	Sí
monthlyNewDevices	long	Número de dispositivos que usaron la aplicación por primera vez durante ese mes.	No	Sí	No

Nota:

Si un campo no es válido para un producto específico, el valor correspondiente a esos campos se enviará como 0 o null en la respuesta. El cálculo de nuevos usuarios y dispositivos nuevos se realiza con la ventana gradual de 3 años, es decir, si un usuario o dispositivo no usa la aplicación durante 3 años y versiones posteriores, se tratará como nuevo usuario o dispositivo después de 3 años.

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/usagemonthly?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "deviceType": "All",
            "packageVersion": "All",
            "market": "All",
            "engagementDurationMinutes": 2828568.3,
            "monthlyActiveUsers": 165249,
            "monthlyActiveDevices": 165753,
            "monthlyNewUsers": 95787,
            "monthlySessionCount": 314263,
            "averageDailyActiveUsers": 192.506111111111,
            "averageDailyActiveDevices": 191.199722222222,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 1
}

Solicitud de muestra

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

Respuesta de ejemplo

{
    "Value": [
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "JP",
            "engagementDurationMinutes": 0.3,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "MX",
            "engagementDurationMinutes": 2.7,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "Unknown",
            "engagementDurationMinutes": 0.1,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "US",
            "engagementDurationMinutes": 0.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AE",
            "engagementDurationMinutes": 3.2,
            "monthlyActiveUsers": 2,
            "monthlyActiveDevices": 2,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 3,
            "averageDailyActiveUsers": 0.07,
            "averageDailyActiveDevices": 0.07,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AO",
            "engagementDurationMinutes": 1.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "engagementDurationMinutes": 574.7,
            "monthlyActiveUsers": 39,
            "monthlyActiveDevices": 39,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 53,
            "averageDailyActiveUsers": 1.43,
            "averageDailyActiveDevices": 1.43,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AT",
            "engagementDurationMinutes": 5.3,
            "monthlyActiveUsers": 4,
            "monthlyActiveDevices": 4,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 9,
            "averageDailyActiveUsers": 0.17,
            "averageDailyActiveDevices": 0.17,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AU",
            "engagementDurationMinutes": 434.7,
            "monthlyActiveUsers": 22,
            "monthlyActiveDevices": 22,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 36,
            "averageDailyActiveUsers": 0.9,
            "averageDailyActiveDevices": 0.9,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AZ",
            "engagementDurationMinutes": 13.5,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 10
}

Compartir a través de

Obtener el uso mensual de la aplicación

Requisitos previos

Solicitar

Sintaxis de la solicitud

Encabezado de solicitud

Parámetros de solicitud

Ejemplo de solicitud

Respuesta

Cuerpo de la respuesta

Valores de uso

Ejemplo de solicitud y respuesta

Solicitud de muestra

Respuesta de ejemplo

Solicitud de muestra

Respuesta de ejemplo

Comentarios

Recursos adicionales

Compartir a través de

Obtener el uso mensual de la aplicación

Requisitos previos

Solicitar

Sintaxis de la solicitud

Encabezado de solicitud

Parámetros de solicitud

Ejemplo de solicitud

Respuesta

Cuerpo de la respuesta

Valores de uso

Ejemplo de solicitud y respuesta

Solicitud de muestra

Respuesta de ejemplo

Solicitud de muestra

Respuesta de ejemplo

Temas relacionados

Comentarios

Recursos adicionales