Obtener conversiones de aplicaciones por canalGet app conversions by channel

Use este método en la API de Microsoft Store Analytics para obtener conversiones de agregado por canal para una aplicación durante un intervalo de fechas determinado y otros filtros opcionales.Use this method in the Microsoft Store analytics API to get aggregate conversions by channel for an application during a given date range and other optional filters.

  • Una conversión significa que un cliente (que inicia sesión con una cuenta de Microsoft) ha obtenido recientemente una licencia para la aplicación (independientemente de que se le cobre o que la haya ofrecido gratis).A conversion means that a customer (signed in with a Microsoft account) has newly obtained a license to your app (whether you charged money or you've offered it for free).
  • El canal es el método en el que un cliente llegó a la página de lista de la aplicación (por ejemplo, a través de la tienda o de una campaña de promoción de aplicaciones personalizada).The channel is the method in which a customer arrived at your app's listing page (for example, via the Store or a custom app promotion campaign).

Esta información también está disponible en el Informe de adquisiciones del centro de Partners.This information is also available in the Acquisitions report in Partner Center.

Requisitos previosPrerequisites

Para usar este método, primero debes hacer lo siguiente:To use this method, you need to first do the following:

  • Si aún no lo ha hecho, complete todos los requisitos previos de la API de Microsoft Store Analytics.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método.Obtain an Azure AD access token to use in the request header for this method. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire.After you obtain an access token, you have 60 minutes to use it before it expires. Si el token expira, puedes obtener uno nuevo.After the token expires, you can obtain a new one.

SolicitudRequest

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de solicitudRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions

Encabezado de solicitudRequest header

EncabezadoHeader TipoType DescripciónDescription
AuthorizationAuthorization stringstring Necesario.Required. El token de acceso de Azure AD del formulario Bearer <token>.The Azure AD access token in the form Bearer <token>.

Parámetros de solicitudRequest parameters

ParámetroParameter TipoType DescripciónDescription RequeridoRequired
applicationIdapplicationId stringstring El identificador de almacén de la aplicación para la que desea recuperar los datos de conversión.The Store ID of the app for which you want to retrieve conversion data. Un ejemplo de un id. de la Tienda sería 9WZDNCRFJ3Q8.An example Store ID is 9WZDNCRFJ3Q8. Yes
startDatestartDate datedate Fecha de inicio del intervalo de fechas de datos de conversión que se va a recuperar.The start date in the date range of conversion data to retrieve. El valor predeterminado es 1/1/2016.The default is 1/1/2016. NoNo
endDateendDate datedate Fecha de finalización del intervalo de fechas de datos de conversión que se va a recuperar.The end date in the date range of conversion data to retrieve. La fecha predeterminada es la actual.The default is the current date. NoNo
toptop intint Número de filas de datos que se devuelven en la solicitud.The number of rows of data to return in the request. El valor máximo y el valor predeterminado, si no se especifican, es 10 000.The maximum value and the default value if not specified is 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo que puedes usar para solicitar la siguiente página de datos.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NoNo
skipskip intint Número de filas que se omiten en la consulta.The number of rows to skip in the query. Usa este parámetro para consultar grandes conjuntos de datos.Use this parameter to page through large data sets. Por ejemplo, los valores top=10000 y skip=0 recuperan las primeras 10 000 filas de datos, los valores top=10000 y skip=10000 recuperan las siguientes 10 000 filas de datos, y así sucesivamente.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. NoNo
filterfilter stringstring Una o más instrucciones que filtran el cuerpo de la respuesta.One or more statements that filter the response body. Cada instrucción puede utilizar los operadores eq o ne, y las instrucciones se pueden combinar mediante and u or.Each statement can use the eq or ne operators, and statements can be combined using and or or. Puede especificar las siguientes cadenas en las instrucciones de filtro.You can specify the following strings in the filter statements. Para obtener descripciones, consulte la sección valores de conversión de este artículo.For descriptions, see the conversion values section in this article.
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • TipoDeDispositivodeviceType
  • datamarketmarket

Este es un parámetro de filtro de ejemplo: Filter = DEVICETYPE EQ ' PC '.Here is an example filter parameter: filter=deviceType eq 'PC'.

NoNo
aggregationLevelaggregationLevel stringstring Especifica el intervalo de tiempo necesario para el que quieres recuperar datos agregados.Specifies the time range for which to retrieve aggregate data. Puede ser una de las siguientes cadenas: día, semana o mes.Can be one of the following strings: day, week, or month. Si no se especifica, el valor predeterminado es día.If unspecified, the default is day. NoNo
orderbyorderby stringstring Instrucción que ordena los valores de los datos de resultado de cada conversión.A statement that orders the result data values for each conversion. La sintaxis es OrderBy = Field [order], Field [order],.... El parámetro de campo puede ser una de las cadenas siguientes:The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • TipoDeDispositivodeviceType
  • datamarketmarket

El parámetro order, en cambio, es opcional y puede ser asc o desc para especificar el orden ascendente o descendente de cada campo.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. El valor predeterminado es ASC.The default is asc.

Este es un ejemplo de cadena OrderBy : OrderBy = Date, MarketHere is an example orderby string: orderby=date,market

NoNo
groupbygroupby stringstring Una instrucción que aplica la agregación de datos únicamente a los campos especificados.A statement that applies data aggregation only to the specified fields. Puedes especificar los siguientes campos:You can specify the following fields:
  • datedate
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • TipoDeDispositivodeviceType
  • datamarketmarket

Las filas de datos que se devuelvan contendrán los campos especificados en el parámetro groupby y en los siguientes:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • conversionCountconversionCount
  • clickCountclickCount

Puedes usar el parámetro groupby con aggregationLevel.The groupby parameter can be used with the aggregationLevel parameter. Por ejemplo: GroupBy = edad, Market & aggregationLevel = WeekFor example: groupby=ageGroup,market&aggregationLevel=week

NoNo

Ejemplo de solicitudRequest example

En el ejemplo siguiente se muestran varias solicitudes para obtener datos de conversión de aplicaciones.The following example demonstrates several requests for getting app conversion data. Sustituye el valor applicationId por el id. de la Tienda de la aplicación.Replace the applicationId value with the Store ID for your app.

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>

ResponseResponse

Cuerpo de la respuestaResponse body

ValueValue TipoType DescripciónDescription
ValueValue arrayarray Matriz de objetos que contienen datos de conversión agregados para la aplicación.An array of objects that contain aggregate conversion data for the app. Para obtener más información acerca de los datos de cada objeto, consulte la sección valores de conversión a continuación.For more information about the data in each object, see the conversion values section below.
@nextLink stringstring Si hay páginas adicionales de datos, esta cadena contiene un URI que puedes usar para solicitar la siguiente página de datos.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. 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.For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of conversion data for the query.
TotalCountTotalCount intint El número total de filas del resultado de datos de la consulta.The total number of rows in the data result for the query.

Valores de conversiónConversion values

Los objetos de la matriz de valores contienen los valores siguientes.Objects in the Value array contain the following values.

ValueValue TipoType DescripciónDescription
datedate stringstring Primera fecha del intervalo de fechas de los datos de conversión.The first date in the date range for the conversion data. Si la solicitud especifica un solo día, este valor será esa fecha.If the request specified a single day, this value is that date. Si, por el contrario, la solicitud especifica una semana, un mes u otro intervalo de fechas, este valor será la primera fecha de ese intervalo de fechas.If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId stringstring El identificador de la tienda de la aplicación para la que se recuperan los datos de conversión.The Store ID of the app for which you are retrieving conversion data.
applicationNameapplicationName stringstring Nombre para mostrar de la aplicación para la que se recuperan los datos de conversión.The display name of the app for which you are retrieving conversion data.
appTypeappType stringstring Tipo del producto para el que se recuperan los datos de conversión.The type of the product for which you are retrieving conversion data. Para este método, el único valor admitido es App.For this method, the only supported value is App.
customCampaignIdcustomCampaignId stringstring La cadena de identificador de una campaña de promoción de aplicaciones personalizada que está asociada a la aplicación.The ID string for a custom app promotion campaign that is associated with the app.
referrerUriDomainreferrerUriDomain stringstring Especifica el dominio en el que se ha activado la lista de aplicaciones con el identificador de campaña de promoción de aplicación personalizado.Specifies the domain where the app listing with the custom app promotion campaign ID was activated.
channelTypechannelType stringstring Una de las siguientes cadenas que especifica el canal para la conversión:One of the following strings that specifies the channel for the conversion:
  • CustomCampaignIdCustomCampaignId
  • Almacenar tráficoStore Traffic
  • OtrosOther
storeClientstoreClient stringstring Versión del almacén donde se produjo la conversión.The version of the Store where the conversion occurred. Actualmente, el único valor admitido es SFC.Currently, the only supported value is SFC.
deviceTypedeviceType stringstring Una de las cadenas siguientes:One of the following strings:
  • PCPC
  • NúmeroPhone
  • Consola: Xbox OneConsole-Xbox One
  • Consola: serie Xbox XConsole-Xbox Series X
  • IoTIoT
  • HolographicHolographic
  • UnknownUnknown
marketmarket stringstring El código de país ISO 3166 del mercado en el que se produjo la conversión.The ISO 3166 country code of the market where the conversion occurred.
clickCountclickCount numbernumber El número de clics del cliente en el vínculo de la lista de aplicaciones.The number of customer clicks on your app listing link.
conversionCountconversionCount numbernumber El número de conversiones de clientes.The number of customer conversions.

Ejemplo de respuestaResponse example

En el ejemplo siguiente se muestra el cuerpo de una respuesta JSON de ejemplo realizada para esta solicitud.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2016-01-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "App",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "US",
      "clickCount": 7,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}