Compartir a través de

Obtener datos de adquisiciones para sus aplicaciones y juegos

  • Artículo

Usa este método en la API de análisis de Microsoft Store para obtener datos de adquisición agregados en formato JSON para aplicaciones para UWP y juegos de Xbox One que se ingieren a través del Portal para desarrolladores de Xbox (XDP) y están disponibles en el panel de Análisis XDP.

Nota:

Esta API no proporciona datos agregados diarios de antes del 1 de octubre de 2016.

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/acquisitions

Encabezado de solicitud

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

Parámetros de solicitud

Parámetro Tipo Descripción Obligatorio
applicationId string El Id. de producto del juego de Xbox One del que se recuperarán los datos de adquisición. Para obtener el id. de producto del juego, ves al juego en el programa Análisis de XDP y recupera el id. del producto de la dirección URL. Como alternativa, si descargas los datos de adquisiciones del informe de análisis del Centro de partners, el id. del producto se incluye en el archivo .tsv. 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
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
  • edad
  • storeClient
  • sexo
  • market
  • osVersion
  • deviceType
  • sandboxId
 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
  • edad
  • storeClient
  • sexo
  • market
  • osVersion
  • deviceType
  • paymentInstrumentType
  • sandboxId
  • xboxTitleId
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
  • edad
  • storeClient
  • sexo
  • market
  • osVersion
  • deviceType
  • paymentInstrumentType
  • sandboxId
  • xboxTitleId
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=age,market&aggregationLevel=week		 No

Ejemplo de solicitud

En el ejemplo siguiente se muestran varias solicitudes de obtención de datos de adquisición del juego de Xbox One. Reemplaza el valor applicationId por el Id. de producto del juego.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions?applicationId=9WZDNCRFHXHT&startDate=1/1/2017&endDate=2/1/2019&top=10&skip=0 HTTP/1.1 
Authorization: Bearer <your access token> 

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions?applicationId=9WZDNCRFHXHT&startDate=1/1/2017&endDate=2/1/2019&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 del juego. Para obtener más información sobre los datos de cada objeto, consulta la sección valores de adquisición a continuación.
TotalCount integer 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 producto del juego de Xbox One del que se recuperarán los datos de adquisición.
applicationName string Nombre para mostrar del juego.
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
  • Pedido por adelantado cobrado
  • Pedido por adelantado cancelado
  • Pedido por adelantado con error
age string Una de las siguientes cadenas que indica 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
deviceType string Una de las siguientes cadenas que especifica el tipo de dispositivo que completó la adquisición:
  • PC
  • Teléfono
  • Consola-Xbox One
  • Consola-Xbox Series X
  • IoT
  • Server
  • Tablet
  • Holográfico
  • Unknown
gender string Una de las siguientes cadenas que especifica el género del usuario que realizó la adquisición:
  • m
  • f
  • Unknown
market string El código de país ISO 3166 del mercado en el que se produjo la adquisición.
osVersion string Versión del sistema operativo en la que se produjo la adquisición. Para este método, este valor siempre es Windows 10 o Windows 11.
paymentInstrumentType string Una de las siguientes cadenas que indica la instrucción de pago utilizada para la adquisición:
  • Tarjeta de crédito
  • Tarjeta de débito directo
  • Compra deducida
  • Saldo de MS
  • Operador de telefonía móvil
  • Transferencia bancaria en línea
  • PayPal
  • Dividir transacción
  • Canje de token
  • Importe cero pagado
  • eWallet
  • Unknown
sandboxId string Identificador del espacio aislado creado para el juego. Puede ser el valor RETAIL o un identificador de espacio aislado privado.
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
xboxTitleId string Id. de título de Xbox Live (representado en valor hexadecimal) asignado por el Portal para desarrolladores de Xbox (XDP) para juegos habilitados para Xbox Live.
acquisitionQuantity number Número de adquisiciones que se produjeron durante el nivel de agregación especificado.
purchasePriceUSDAmount number El importe pagado por el cliente para la adquisición, convertido a USD, utilizando el tipo de cambio mensual.
purchaseTaxUSDAmount number Impuestos aplicados a la adquisición, convertidos a USD.
localCurrencyCode string Código de moneda local según el país de la cuenta del Centro de partners.
xboxProductId string Id. de producto de Xbox del producto de XDP, si procede.
availabilityId string Identificador de disponibilidad del producto de XDP, si procede.
skuId string Identificador de SKU del producto de XDP, si procede.
skuDisplayName string Nombre para mostrar del SKU del producto de XDP, si procede.
xboxParentProductId string Id. de producto primario de Xbox del producto de XDP, si procede.
parentProductName string Nombre del producto primario del producto de XDP, si procede.
productTypeName string Nombre del tipo de producto del producto de XDP, si procede.
purchaseTaxType string Tipo de impuesto sobre las ventas del producto de XDP, si procede.
purchasePriceLocalAmount number Importe local del precio de compra del producto de XDP, si procede.
purchaseTaxLocalAmount number Importe local del impuesto sobre las ventas del producto de XDP, si procede.

Ejemplo de respuesta

En el ejemplo siguiente se muestra un ejemplo de cuerpo de respuesta en formato JSON para esta solicitud.

{ 
    "Value": [ 
        { 
            "date": "2019-01-15T01:00:00.0000000Z", 
            "applicationId": "9WZDNCRFHXHT", 
            "applicationName": null, 
            "acquisitionType": "Paid", 
            "age": null, 
            "deviceType": "Phone", 
            "gender": null, 
            "market": "US", 
            "osVersion": "Windows 11", 
            "paymentInstrumentType": null, 
            "sandboxId": "RETAIL", 
            "storeClient": "Microsoft Store (client)", 
            "xboxTitleId": null, 
            "localCurrencyCode": "USD", 
            "xboxProductId": null, 
            "availabilityId": "B42LRTSZ2MCJ", 
            "skuId": "0010", 
            "skuDisplayName": null, 
            "xboxParentProductId": null, 
            "parentProductName": null, 
            "productTypeName": "Game", 
            "purchaseTaxType": "TaxesNotIncluded", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 3.08, 
            "purchasePriceLocalAmount": 3.08, 
            "purchaseTaxUSDAmount": 0.09, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

    "@nextLink": null,
    
    "TotalCount": 12221 
}