Compartir a través de


Adquisiciones de complementos

Usa este método en la API de análisis de Microsoft Store para obtener datos de adquisición agregados para complementos para tu aplicación en formato JSON durante un intervalo de fechas determinado y otros filtros opcionales. Esta información también está disponible en el informe de adquisiciones de complementos en el Centro de socios.

Prerrequisitos

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

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

Solicitud

Sintaxis de la solicitud

Método Solicitud de URI
OBTENER https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions

Cabecera de solicitud

Cabecera Tipo Descripción
Autorización cuerda / cadena Obligatorio. Token de acceso de Azure AD en el formato Bearer<token>.

Parámetros de solicitud

Se requiere el parámetro applicationId o inAppProductId . Para recuperar los datos de adquisición de todos los complementos registrados en la aplicación, especifique el parámetro applicationId . Para recuperar los datos de adquisición de un único complemento, especifique el parámetro inAppProductId . Si especifica ambos, se omite el parámetro applicationId .

Parámetro Tipo Descripción Obligatorio
applicationId cuerda / cadena El ID de la Tienda de la aplicación para la cual deseas recuperar los datos de adquisición de complementos.
inAppProductId (ID de producto en la aplicación) cuerda / cadena El ID de tienda del complemento para el que deseas recuperar los datos de adquisición.
Fecha de inicio fecha Fecha de inicio del intervalo de fechas de los datos de adquisición de complementos que se deben recuperar. El valor predeterminado es la fecha actual. No
fecha de finalización fecha Fecha de finalización en el rango de fechas de los datos de adquisición de complementos a recuperar. El valor predeterminado es la fecha actual. No
Parte superior Int Número de filas de datos que se van a devolver en la solicitud. El valor máximo y el valor predeterminado si no se especifica es 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo siguiente que puede usar para solicitar la siguiente página de datos. No
saltarse Int Número de filas que se van a omitir en la consulta. Use este parámetro para paginar 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
filtro cuerda / cadena Una o varias instrucciones que filtran las filas de la respuesta. Para obtener más información, consulte la siguiente sección de los campos de filtro . No
nivel de agregación cuerda / cadena 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, el valor predeterminado es day. No
Ordenar por cuerda / cadena Instrucción que ordena los valores de los datos de resultado para cada adquisición adicional. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede ser una de las siguientes cadenas:
  • fecha
  • tipo de adquisición
  • Grupo de edad
  • storeClient
  • género
  • mercado
  • versión del sistema operativo
  • tipoDeDispositivo
  • nombre del pedido

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 cuerda / cadena Instrucción que aplica la agregación de datos solo a los campos especificados. Puede especificar los siguientes campos:
  • fecha
  • Nombre de la aplicación
  • inAppProductName
  • tipo de adquisición
  • Grupo de edad
  • storeClient
  • género
  • mercado
  • versión del sistema operativo
  • tipoDeDispositivo
  • nombre del pedido

Las filas de datos devueltas contendrán los campos especificados en el parámetro groupby , así como los siguientes:

  • fecha
  • Id de la aplicación
  • inAppProductId
  • cantidadDeAdquisición

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

No

Filtrar campos

El parámetro de filtro de la solicitud contiene una o varias declaraciones 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 yo . Estos son algunos parámetros de filtro de ejemplo:

  • filtro=equación de mercado 'EE.UU.' y equación de género 'm'
  • filtro=(mercado ne 'EE. UU.') y (género ne 'Desconocido') y (género ne 'm') y (mercado ne 'NO') y (grupo de edad ne 'mayor de 55' o grupo de edad ne 'menor de 13')

Para obtener una lista de los campos admitidos, consulte la tabla siguiente. Los valores de cadena deben estar delimitados por comillas simples en el parámetro del filtro .

Campos Descripción
tipo de adquisición Una de las siguientes cadenas:
  • gratis
  • juicio
  • pagado
  • código promocional
  • IAP
grupo de edad Una de las siguientes cadenas:
  • menor que 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • mayor que 55
  • Desconocido
StoreClient Una de las siguientes cadenas:
  • Tienda de Windows Phone (cliente)
  • Microsoft Store (cliente)
  • Microsoft Store (web)
  • Compra por volumen por parte de organizaciones
  • Otro
género Una de las siguientes cadenas:
  • m
  • f
  • Desconocido
mercado Cadena que contiene el código de país ISO 3166 del mercado donde se produjo la adquisición.
osVersion Una de las siguientes cadenas:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Desconocido
tipo de dispositivo Una de las siguientes cadenas:
  • PC
  • Teléfono
  • Console-Xbox Uno
  • Console-Xbox Serie X
  • Internet de las Cosas
  • Holográfico
  • Desconocido
nombre de pedido Cadena que especifica el nombre del pedido del código promocional que se usó para adquirir el complemento (esto solo se aplica si el usuario adquirió el complemento canjeando un código promocional).

Ejemplo de solicitud

En los ejemplos siguientes se demuestra cómo realizar varias solicitudes para obtener datos de adquisición de complementos. Reemplace los valores inAppProductId y applicationId por el identificador de la Tienda adecuado para el complemento o la aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=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/inappacquisitions?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/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>

Respuesta

Cuerpo de respuesta

Importancia Tipo Descripción
Importancia matriz Una matriz de objetos que contiene datos agregados de adquisición de complementos. Para obtener más información sobre los datos de cada objeto, consulte la sección valores de adquisición del complemento a continuación.
@nextLink cuerda / cadena Si hay páginas adicionales de datos, esta cadena contiene un URI que 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 de complementos para la consulta.
Conteo Total Int Número total de filas en el resultado de los datos de la consulta.

Valores de adquisición de complementos

Los elementos de la matriz Value contienen los valores siguientes.

Importancia Tipo Descripción
fecha cuerda / cadena La primera fecha en el rango de fechas para los datos de adquisición. Si la solicitud especificó un solo día, este valor es esa fecha. Si la solicitud especificó una semana, mes u otro intervalo de fechas, este valor es la primera fecha de ese intervalo de fechas.
inAppProductId (ID de producto en la aplicación) cuerda / cadena El ID de la tienda del complemento para el cual estás recuperando los datos de adquisición.
NombreDeProductoEnLaAplicación cuerda / cadena Nombre visible del complemento. Este valor solo aparece en los datos de respuesta si el parámetro aggregationLevel se establece en día, a menos que especifique el campo inAppProductName en el parámetro groupby .
applicationId cuerda / cadena El identificador de la tienda de aplicaciones de la aplicación para la cual quieres recuperar los datos de adquisición de complementos.
Nombre de la aplicación cuerda / cadena Nombre visible de la aplicación.
tipo de dispositivo cuerda / cadena Tipo de dispositivo que completó la adquisición. Para obtener una lista de las cadenas admitidas, consulte la sección campos de filtro anteriores.
nombre de pedido cuerda / cadena Nombre del pedido.
StoreClient cuerda / cadena Versión de la tienda donde se produjo la adquisición. Para obtener una lista de las cadenas admitidas, consulte la sección campos de filtro anteriores.
osVersion cuerda / cadena Versión del sistema operativo en la que se produjo la adquisición. Para obtener una lista de las cadenas admitidas, consulte la sección campos de filtro anteriores.
mercado cuerda / cadena El código de país ISO 3166 del mercado donde se produjo la adquisición.
género cuerda / cadena El sexo del usuario que realizó la adquisición. Para obtener una lista de las cadenas admitidas, consulte la sección campos de filtro anteriores.
grupo de edad cuerda / cadena Grupo de edad del usuario que realizó la adquisición. Para obtener una lista de las cadenas admitidas, consulte la sección campos de filtro anteriores.
tipo de adquisición cuerda / cadena Tipo de adquisición (gratis, pagado, etc.). Para obtener una lista de las cadenas admitidas, consulte la sección campos de filtro anteriores.
cantidadDeAdquisición entero Número de adquisiciones que se produjeron.

Ejemplo de solicitud y respuesta

En el fragmento de código siguiente se muestra un ejemplo de solicitud y un cuerpo de respuesta JSON para esa solicitud.

Solicitud de ejemplo

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

Respuesta de ejemplo

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NBLGGAAGZDQ",
            "date": "2022-07-29",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 18.12,
            "purchasePriceLocalAmount": 18.12,
            "purchaseTaxUSDAmount": 1.13,
            "purchaseTaxLocalAmount": 1.13
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Episode 4",
            "addonProductId": "9NAAAAAAAAAQ",
            "date": "2017-01-07",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 4.147206,
            "purchasePriceLocalAmount": 3.99,
            "purchaseTaxUSDAmount": 0.686004,
            "purchaseTaxLocalAmount": 0.66
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NALGGGZ5QDQ",
            "date": "2018-04-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.99,
            "purchasePriceLocalAmount": 1.99,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Strategy Guide Episode 4",
            "addonProductId": "9NBLGGGZ5QDQ",
            "date": "2021-11-25",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.31902922876179,
            "purchasePriceLocalAmount": 150.0,
            "purchaseTaxUSDAmount": 0.114315866492689,
            "purchaseTaxLocalAmount": 13.0
        },
    ],
    "TotalCount": 4,
    "DataFreshnessTimestamp": "2022-07-29T05:54:00"
}