Compartir a través de

Obtener conversiones de aplicaciones por canal

  • Artículo

Usa este método en la API de análisis de Microsoft Store para obtener los conversiones por canal agregadas de una aplicación correspondientes a un intervalo de fechas determinado y otros filtros opcionales.

  • Una conversión significa que un cliente (que ha iniciado sesión con una cuenta Microsoft) ha obtenido recientemente una licencia para la aplicación (ya sea que se le haya cobrado dinero o se le haya ofrecido de forma gratuita).
  • El canal es el método por el que un cliente llegó a la página de descripción de la aplicación (por ejemplo, a través de la Tienda o de una campaña de promoción de la aplicación personalizada).

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

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 conversión. Un ejemplo de Id. de Store es 9WZDNCRFJ3Q8. Sí
startDate date Fecha de inicio del intervalo de fechas de los datos de conversión que se van a recuperar. El valor predeterminado es 1/1/2016. No
endDate date Fecha de finalización del intervalo de fechas de los datos de conversió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 el cuerpo de la respuesta. Cada instrucción puede usar los operadores eq o ne, y las instrucciones se pueden combinar mediante y u o. Puedes especificar las siguientes cadenas en las instrucciones de filtro. Para obtener descripciones, consulta la sección valores de conversión de este artículo.
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

Este es un ejemplo de parámetro de filtro: filter=deviceType eq 'PC'.

 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 conversión. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede estar formado por una de las siguientes cadenas:
  • date
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

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
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

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

  • date
  • applicationId
  • conversionCount
  • clickCount

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 para obtener datos de conversión de aplicaciones. Reemplaza el valor applicationId por el Id. de Store de tu aplicación.

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

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

Valores de conversión

Los objetos de la matriz Value contienen los siguientes valores.

Valor Tipo Descripción
date string La primera fecha del intervalo de fechas de los datos de conversió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 recuperan los datos de conversión.
applicationName string El nombre para mostrar de la aplicación de la que se recuperan los datos de conversión.
appType string El tipo de producto del que se recuperan los datos de conversión. Para este método, el único valor admitido es App.
customCampaignId string Cadena de identificador de una campaña de promoción de aplicaciones personalizada asociada a la aplicación.
referrerUriDomain string Especifica el dominio en el que se activó la descripción de la aplicación con el identificador de la campaña de promoción de aplicaciones personalizada.
channelType string Una de las siguientes cadenas que especifica el canal de conversión:
  • CustomCampaignId
  • Tráfico del Store
  • Otros
storeClient string Versión del Store donde se produjo la conversión. Actualmente, el único valor admitido es SFC.
deviceType string Una de las cadenas siguientes:
  • PC
  • Teléfono
  • Consola-Xbox One
  • Consola-Xbox Series X
  • IoT
  • Holográfico
  • Unknown
market string El código de país ISO 3166 del mercado en el que se produjo la conversión.
clickCount number El número de clics de clientes en el vínculo de descripción de la aplicación.
conversionCount number Número de conversiones de clientes.

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/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/23/2022&endDate=07/21/2022&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 3089,
            "conversionCount": 14
        }
    ],
    "@nextLink": "",
    "TotalCount": 1
}

Solicitud de muestra

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/21/2022&skip=0&groupby=date,applicationName,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market&filter=market eq 'US'
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

{
    "Value": [
        {
            "date": "2022-06-19",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 13,
            "conversionCount": 0
        },
        {
            "date": "2022-06-20",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 6,
            "conversionCount": 0
        },
        {
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
    ],
    "@nextLink": "",
    "TotalCount": 4
}