Compartir a través de


Obtener conversiones adicionales por canal

Usa este método en la API de análisis de Microsoft Store para obtener conversiones agregadas por canal para un complemento durante 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 el complemento (ya sea que se le haya cargado dinero o que lo haya ofrecido de forma gratuita).
  • El canal es el método en 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 una campaña de promoción de aplicaciones personalizada ).

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

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 El ID de tienda Store de la aplicación para la que deseas recuperar los datos de conversión del complemento. Un ID de tienda como ejemplo es 9WZDNCRFJ3Q8.
inAppProductId (ID de producto en la aplicación) cuerda / cadena El ID de la Tienda de la extensión para la que desea recuperar datos de conversión.
Fecha de inicio fecha Fecha de inicio en el intervalo de fechas de los datos de conversión que se van a recuperar. El valor predeterminado es 1 de enero de 2016. No
fecha de finalización fecha Fecha de finalización del intervalo de fechas de los datos de conversión que se van 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 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 instrucciones de filtro. Para obtener descripciones, consulte la sección de valores de conversión de este artículo.
  • Nombre de la aplicación
  • tipo de aplicación
  • campañaPersonalizadaId
  • dominioUriReferrer
  • tipo de canal
  • storeClient
  • tipoDeDispositivo
  • mercado

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

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 los datos resultantes para cada conversión. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede ser una de las siguientes cadenas:
  • fecha
  • Nombre de la aplicación
  • inAppProductName
  • tipo de aplicación
  • campañaPersonalizadaId
  • dominioUriReferrer
  • tipo de canal
  • storeClient
  • tipoDeDispositivo
  • mercado

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 aplicación
  • campañaPersonalizadaId
  • dominioUriReferrer
  • tipo de canal
  • storeClient
  • tipoDeDispositivo
  • mercado

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
  • inAppProductName
  • número de conversiones de
  • haga clic en contador de clics

El parámetro groupby se puede usar con el parámetro aggregationLevel . Por ejemplo: groupby=grupoEdad,mercado&nivelAgregación=semana

No

Ejemplo de solicitud

En el ejemplo siguiente se muestran varias solicitudes para obtener datos de conversión de aplicaciones. Sustituya el valor de applicationId por el identificador de tienda para su aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?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/inappchannelconversions?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 respuesta

Importancia Tipo Descripción
Importancia arreglo Matriz de objetos que contienen datos de conversión agregados para el complemento. Para obtener más información sobre los datos de cada objeto, consulte la siguiente sección de valores de conversió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 se establece en 10 el parámetro top de la solicitud, pero hay más de 10 filas de datos de conversión para la consulta.
Conteo Total Int Número total de filas en el resultado de los datos de la consulta.

Valores de conversión

Los objetos en la matriz Value contienen los siguientes valores.

Importancia Tipo Descripción
fecha cuerda / cadena La primera fecha del intervalo de fechas para los datos de conversió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 Tienda del complemento para el cual estás recuperando los datos de conversión.
NombreDeProductoEnLaAplicación cuerda / cadena Nombre de visualización del complemento del cual está recuperando los datos de conversión.
applicationId cuerda / cadena El ID de Store de la aplicación para la que estás recuperando datos de conversión.
Nombre de la aplicación cuerda / cadena Nombre para mostrar de la aplicación para la que se recuperan los datos de conversión.
tipo de aplicación cuerda / cadena Tipo del producto para el que va a recuperar los datos de conversión. Para este método, el único valor admitido es complemento.
customCampaignId cuerda / cadena La cadena de identificador de una campaña de promoción de aplicaciones personalizada asociada a la aplicación.
referrerUriDomain cuerda / cadena Especifica el dominio en el que se activó el listado de la aplicación con el ID de campaña de promoción personalizada de la aplicación.
tipoDeCanal cuerda / cadena Una de las siguientes cadenas que especifica el canal para la conversión:
  • customCampaignId
  • Tráfico en la Tienda
  • Otros
storeClient cuerda / cadena La versión de la tienda donde se produjo la conversión. Actualmente, el único valor admitido es SFC.
tipo de dispositivo cuerda / cadena Una de las siguientes cadenas:
  • 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 conversión.
conteo de clics número El número de clics del cliente en el vínculo de descripción de la aplicación.
conteo de conversiones número Número de conversiones de cliente.

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/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

{
    "Value": [
        {
            "inAppProductId": "9NN2HW33ZB2G",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 220636,
            "conversionCount": 154
        },
        {
            "inAppProductId": "9PN07J0WC18B",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 277061,
            "conversionCount": 187
        }
    ],
    "@nextLink": "",
    "TotalCount": 2
}

Solicitud de ejemplo

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>

Respuesta de ejemplo

{
    "Value": [
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_mahjong_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "BR",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_solitaire_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "AT",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5Z",
            "inAppProductName": "Episode1Combo",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4Z",
            "inAppProductName": "Episode1Grandfathered",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "|autosuggest",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "ES",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5W",
            "inAppProductName": "Episode2Combo",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4P",
            "inAppProductName": "SeasonPass24",
            "appType": "Add-On",
            "date": "2022-07-12",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "9wzdncrfjbd8",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CA",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-07-17",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "scom-web-store",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "US",
            "clickCount": 1,
            "conversionCount": 1
        }
    ],
    "@nextLink": "",
    "TotalCount": 9
}