Compartir a través de

Obtener los datos de las adquisiciones de la aplicación

  • Artículo

Usa este método en la API de análisis de Microsoft Store para obtener los datos de adquisición agregados en formato JSON de una aplicación correspondientes a un intervalo de fechas determinado y otros filtros opcionales. Esta información también está disponible en el informe Adquisiciones 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/appacquisitions

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 adquisición. Sí
startDate date Fecha de inicio del intervalo de fechas de los datos de adquisició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 adquisició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. Por ejemplo, filter=market eq 'US' and gender eq 'm'.

Puedes especificar los campos siguientes desde el cuerpo de la respuesta:

  • acquisitionType
  • ageGroup
  • storeClient
  • sexo
  • market
  • osVersion
  • deviceType
  • orderName
 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 adquisición. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede estar formado por una de las siguientes cadenas:
  • date
  • acquisitionType
  • ageGroup
  • storeClient
  • sexo
  • market
  • osVersion
  • deviceType
  • orderName

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
  • acquisitionType
  • ageGroup
  • storeClient
  • sexo
  • market
  • osVersion
  • deviceType
  • orderName

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

  • date
  • applicationId
  • acquisitionQuantity

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 muestran varias solicitudes de obtención de datos de adquisición. Reemplaza el valor applicationId por el Id. de Store de tu aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?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/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm'  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 adquisición agregados para la aplicación. Para obtener más información sobre los datos de cada objeto, consulta la sección valores de adquisició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 adquisición para la consulta.
TotalCount int Número total de filas que figura en el resultado de datos de la consulta.

Valores de adquisició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 adquisición. 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 de la que se recuperarán los datos de adquisición.
applicationName string Nombre para mostrar de la aplicación.
deviceType string Una de las siguientes cadenas que especifica el tipo de dispositivo en el que se produjo la adquisición:
  • PC
  • Teléfono
  • Consola-Xbox One
  • Consola-Xbox Series X
  • IoT
  • Holográfico
  • Unknown
orderName string Nombre del orden.
storeClient string Una de las siguientes cadenas que indica la versión de Store desde la que se produjo la adquisición:
  • Tienda de Windows Phone (cliente)
  • Microsoft Store (cliente) (o Tienda Windows (cliente) si se consultan datos de antes del 23 de marzo de 2018)
  • Microsoft Store (web) (o Tienda Windows (web) si se consultan datos de antes del 23 de marzo de 2018)
  • Compra por volumen por parte de organizaciones
  • Otros
osVersion string Una de las siguientes cadenas que especifica la versión del sistema operativo desde la que se produjo la adquisición:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
market string El código de país ISO 3166 del mercado en el que se produjo la adquisición.
gender string Una de las siguientes cadenas que especifica el género del usuario que realizó la adquisición:
  • m
  • f
  • Unknown
ageGroup string Una de las siguientes cadenas que especifica el grupo de edad del usuario que realizó la adquisición:
  • menor de 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • mayor de 55
  • Unknown
acquisitionType string Una de las siguientes cadenas que indica el tipo de adquisición:
  • Gratis
  • Prueba
  • Pagada
  • Código promocional
  • Iap
  • Iap de suscripción
  • Audiencia privada
  • Solicitud previa
  • Xbox Game Pass (o Game Pass si se consultan datos de antes del 23 de marzo de 2018)
  • Disco
  • Código de prepago
acquisitionQuantity number Número de adquisiciones que se produjeron durante el nivel de agregación especificado.

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

Respuesta de ejemplo

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "date": "2022-07-29",
            "acquisitionQuantity": 7,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
  ],
  "TotalCount": 1,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
}

Solicitud de muestra

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType  HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

	{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "f",
            "market": "TW",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "Unknown",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
      ],  
  "TotalCount": 2,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
 }