Adquisiciones de complementos adicionales de suscripción

2025-06-10

Usa este método en la API de análisis de Microsoft Store para obtener datos de adquisición agregados para suscripciones de complemento para tu aplicación durante un intervalo de fechas determinado y otros filtros opcionales.

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

Cabecera de solicitud

Cabecera	Tipo	Descripción
Autorización	cuerda / cadena	Obligatorio. El token de acceso de Azure AD en la forma Bearer<token>.

Parámetros de solicitud

Parámetro	Tipo	Descripción	Obligatorio
applicationId	cuerda / cadena	La id. de la Tienda de la aplicación para la que quieres recuperar los datos de adquisición del complemento de suscripción.	Sí
IdProductoSuscripción	cuerda / cadena	El ID de la Tienda de la extensión de suscripción para la que quiere recuperar los datos de adquisición. Si no especifica este valor, este método devuelve los datos de adquisición de todos los complementos de suscripción para la aplicación especificada.	No
Fecha de inicio	fecha	Fecha de inicio del intervalo de fechas de los datos de adquisición del complemento de suscripción que se van a recuperar. El valor predeterminado es la fecha actual.	No
fecha de finalización	fecha	Fecha final del rango de fechas de los datos de adquisición de complementos de suscripción que se deben 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 100. 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=100 y skip=0 recupera las primeras 100 filas de datos, top=100 y skip=100 recupera las siguientes 100 filas de datos, etc.	No
filtro	cuerda / cadena	Una o varias sentencias que filtran el cuerpo de la respuesta. Cada instrucción puede usar los operadores eq o ne, y las instrucciones se pueden combinar mediante y o o. Puede especificar las siguientes cadenas en las declaraciones de filtro (estas corresponden a los valores en el cuerpo de la respuesta): fecha subscriptionProductName Nombre de la aplicación ID de SKU mercado tipoDeDispositivo Este es un ejemplo de parámetro de filtro : filter=date eq '2017-07-08'.	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
orderby	cuerda / cadena	Instrucción que ordena los valores de datos de resultados para cada adquisición del complemento de suscripción. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede ser una de las siguientes cadenas: fecha subscriptionProductName Nombre de la aplicación ID de SKU mercado tipoDeDispositivo 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 subscriptionProductName Nombre de la aplicación ID de SKU mercado tipoDeDispositivo El parámetro groupby se puede usar con el parámetro aggregationLevel . Por ejemplo: groupby=market&aggregationLevel=week	No

Ejemplo de solicitud

En los ejemplos siguientes se muestra cómo obtener datos de adquisición de complementos de suscripción. Reemplace el valor applicationId por el identificador de la Tienda adecuado para la aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=2017-07-07&endDate=2017-07-08 HTTP/1.1
Authorization: Bearer <your access token>

Respuesta

Cuerpo de respuesta

Importancia	Tipo	Descripción
Importancia	arreglo	Matriz de objetos que contienen datos de adquisición de complementos de suscripción agregados. Para obtener más información sobre los datos de cada objeto, consulte la sección valores de adquisición de suscripciones 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 de superior de la solicitud se establece en 100, pero hay más de 100 filas de datos de adquisición de complementos de suscripción 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 suscripciones

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.
IdProductoSuscripción	cuerda / cadena	La ID de la tienda del complemento de suscripción para el cual se recuperan los datos de adquisición.
nombreDelProductoDeSuscripción	cuerda / cadena	Nombre mostrado del complemento de suscripción.
applicationId	cuerda / cadena	ID de la Tienda de la aplicación para la cual estás recuperando los datos de adquisición del añadido de suscripción.
Nombre de la aplicación	cuerda / cadena	Nombre visible de la aplicación.
skuId	cuerda / cadena	El identificador del SKU del complemento de suscripción para el cual está recuperando los datos de adquisición.
tipo de dispositivo	cuerda / cadena	Una de las siguientes cadenas que especifica el tipo de dispositivo que completó la adquisición: PC Teléfono Console-Xbox One Console-Xbox Serie X Internet de las Cosas Holográfico Desconocido
mercado	cuerda / cadena	El código de país ISO 3166 del mercado donde se produjo la adquisición.
código de moneda	cuerda / cadena	El código de moneda en formato ISO 4217 para las ventas brutas antes de los impuestos.
ventas brutas antes de impuestos	entero	Ventas brutas en la moneda local especificada por el valor currencyCode.
totalActiveCount	entero	Número de suscripciones activas totales durante el período de tiempo especificado. Esto equivale a la suma de los valores goodStandingActiveCount, pendingGraceActiveCount, graceActiveCounty lockedActiveCount.
totalChurnCount	entero	Recuento total de suscripciones desactivadas durante el período de tiempo especificado. Esto equivale a la suma de los valores de churn de facturación , churn por no renovación , churn por reembolso , churn por contracargo , churn anticipado y otros churn .
newCount	entero	Número de adquisiciones de suscripciones nuevas durante el período de tiempo especificado, incluidas las pruebas.
recuento de renovaciones	entero	Número de renovaciones de suscripciones durante el período de tiempo especificado, incluidas las renovaciones iniciadas por el usuario y las renovaciones automáticas.
conteoActivoEnBuenaPosición	entero	Número de suscripciones que estaban activas durante el período de tiempo especificado y donde la fecha de caducidad es >= el valor de fecha de finalización de la consulta.
pendingGraceActiveCount	entero	El número de suscripciones que estaban activas durante el período de tiempo especificado, pero que tuvieron un error de facturación, y donde la fecha de expiración de la suscripción es tal que >es igual al valor de endDate para la consulta.
graceActiveCount	entero	Número de suscripciones que estaban activas durante el período de tiempo especificado, pero que tenían un error de facturación y dónde: La fecha de expiración de la suscripción es el valor de < para la consulta . El final del período de gracia es = el valor endDate de .
lockedActiveCount	entero	El número de suscripciones que estaban en (es decir, la suscripción está a punto de expirar y Microsoft está intentando adquirir fondos para renovar automáticamente la suscripción) durante el período de tiempo especificado y dónde: La fecha de expiración de la suscripción es el valor de < para la consulta . El final del período de gracia es = el valor endDate de .
billingChurnCount	entero	El número de suscripciones que se desactivaron durante el período de tiempo especificado debido a un error al procesar un cargo de facturación y donde las suscripciones estaban anteriormente en el procedimiento de cobro.
conteo de bajas por no renovación	entero	Número de suscripciones que se desactivaron durante el período de tiempo especificado porque no se renovaron.
refundChurnCount	entero	Número de suscripciones que se desactivaron durante el período de tiempo especificado porque se devolvieron.
chargebackChurnCount	entero	Número de suscripciones que se desactivaron durante el período de tiempo especificado debido a una devolución de cargo.
earlyChurnCount	entero	Número de suscripciones que se desactivaron durante el período de tiempo especificado mientras estaban en buen estado.
otherChurnCount	entero	Número de suscripciones que se desactivaron durante el período de tiempo especificado por otros motivos.

Ejemplo de solicitud y respuesta

En los fragmentos de código siguientes se muestran algunos ejemplos de solicitud y cuerpo de respuesta JSON para esa solicitud.

Solicitud de ejemplo

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

Respuesta de ejemplo

{
    "Value": [
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "grossSalesBeforeTax": 3460656.260391250,
            "totalActiveCount": 20211321,
            "totalChurnCount": 5605,
            "newCount": 3810366,
            "renewCount": 12102044,
            "goodStandingActiveCount": 17893664,
            "pendingGraceActiveCount": 2255792,
            "graceActiveCount": 61833,
            "lockedActiveCount": 32,
            "billingChurnCount": 4,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 2717,
            "otherChurnCount": 2884
        },
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Unknown",
            "grossSalesBeforeTax": 2342.580615228,
            "totalActiveCount": 50550,
            "totalChurnCount": 7,
            "newCount": 8312,
            "renewCount": 31446,
            "goodStandingActiveCount": 44047,
            "pendingGraceActiveCount": 6503,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 5,
            "otherChurnCount": 2
        }
    ],
    "TotalCount": 2
}

Solicitud de ejemplo

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=04/20/2022&top=10&skip=0&orderby=date&groupby=date,subscriptionProductName,applicationName,skuId,market,deviceType&aggregationLevel=week
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

{
    "Value": [
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "IT",
            "deviceType": "Console-Xbox One",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 2,
            "renewCount": 0,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "NO",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 13,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "CA",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 152,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 270,
            "goodStandingActiveCount": 133,
            "pendingGraceActiveCount": 19,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        }
    ],
    "TotalCount": 3
}

Compartir a través de

Adquisiciones de complementos adicionales de suscripción

Prerrequisitos

Solicitud

Sintaxis de la solicitud

Cabecera de solicitud

Parámetros de solicitud

Ejemplo de solicitud

Respuesta

Cuerpo de respuesta

Valores de adquisición de suscripciones

Ejemplo de solicitud y respuesta

Solicitud de ejemplo

Respuesta de ejemplo

Solicitud de ejemplo

Respuesta de ejemplo

Temas relacionados

Comentarios

Recursos adicionales