Obtener los datos de rendimiento de los anuncios

  • Artículo

Usa este método en la API de análisis de Microsoft Store para obtener datos agregados del rendimiento de los anuncios para tus aplicaciones durante un intervalo de fechas determinado y otros filtros opcionales. Este método devuelve los datos en formato JSON.

Este método devuelve los mismos datos proporcionados por el informe de rendimiento de los anuncios en el 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.

Para obtener más información, consulta Acceso a datos analíticos mediante los servicios de Microsoft Store.

Solicitar

Sintaxis de la solicitud

Método URI de solicitud
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance

Encabezado de solicitud

Encabezado Tipo Descripción
Autorización cadena Necesario. Token de acceso de Azure AD con el formato Token<de portador>.

Parámetros de solicitud

Para recuperar datos de rendimiento de los anuncios para una aplicación específica, usa el parámetro applicationId. Para recuperar datos de rendimiento de anuncios para todas las aplicaciones asociadas a la cuenta de desarrollador, omite el parámetro applicationId.

Parámetro Tipo Descripción Obligatorio
applicationId string El Id. de Store de la aplicación para la que quieres recuperar los datos de rendimiento de los anuncios. No
startDate date Fecha de inicio del intervalo de fechas de los datos de rendimiento de los anuncios que se van a recuperar, con el formato AAAA/MM/DD. El valor predeterminado es la fecha actual menos 30 días. No
endDate date Fecha de finalización del intervalo de fechas de los datos de rendimiento de los anuncios que se van a recuperar, con el formato AAAA/MM/DD. El valor predeterminado es la fecha actual menos un día. No
top 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 las filas de la respuesta. Para más información, consulte la sección campos de filtro a continuación. 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. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede estar formado por una de las siguientes cadenas:
  • date
  • market
  • deviceType
  • adUnitId

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:

  • applicationId
  • applicationName
  • date
  • accountCurrencyCode
  • market
  • deviceType
  • adUnitName
  • adUnitId
  • pubCenterAppName
  • adProvider

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

 No

Campos de filtro

El parámetro filter del cuerpo de la solicitud contiene una o varias instrucciones 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 y u o. Este es un ejemplo de parámetro de filtro:

  • filter=market eq 'US' and deviceType eq 'phone'

Consulta la siguiente tabla para ver una lista de los campos admitidos. Los valores de cadena deben estar entre comillas simples en el parámetro de filtro.

Campo Descripción
market Cadena que contiene el código de país ISO 3166 del mercado desde el que se sirvieron los anuncios.
deviceType Una de las siguientes cadenas: PC/Tableta o Teléfono.
adUnitId Cadena que especifica un identificador de unidad de anuncios que se va a aplicar al filtro.
pubCenterAppName Cadena que especifica el nombre del pubCenter de la aplicación actual que se va a aplicar al filtro.
adProvider Cadena que especifica el nombre de un proveedor de anuncios que se va a aplicar al filtro.
date Cadena que especifica una fecha en formato AAAA/MM/DD que se va a aplicar al filtro.

Ejemplo de solicitud

En el ejemplo siguiente se muestran varias solicitudes de obtención de datos de rendimiento de anuncios. Reemplaza el valor applicationId por el Id. de Store de tu aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&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/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Respuesta

Response body

Valor Tipo Descripción
Value array Matriz de objetos que contienen datos agregados de rendimiento de anuncios. Para obtener más información sobre los datos de cada objeto, consulta la sección valores de rendimiento de anuncios 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 5, pero hay más de 5 elementos de datos para la consulta.
TotalCount int Número total de filas que figura en el resultado de datos de la consulta.

Valores de rendimiento de anuncios

Los elementos de la matriz Value contienen los valores siguientes.

Valor Tipo Descripción
date string La primera fecha del intervalo de fechas de los datos de rendimiento de anuncios. 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 para la que se recuperan los datos de rendimiento de anuncios.
applicationName string Nombre para mostrar de la aplicación.
adUnitId string Identificador de la unidad de anuncios.
adUnitName string Nombre de la unidad de anuncios, tal como especifica el desarrollador en el Centro de partners.
adProvider string Nombre del proveedor de anuncios
deviceType string Tipo de dispositivo en el que se han servido los anuncios. Para obtener una lista de las cadenas admitidas, consulta la sección campos de filtro más arriba.
market string El código de país ISO 3166 del mercado desde el que se sirvieron los anuncios.
accountCurrencyCode string Código de divisa de la cuenta.
pubCenterAppName string Nombre de la aplicación del pubCenter asociada a la aplicación en el Centro de partners.
adProviderRequests int Número de solicitudes de anuncios para el proveedor de anuncios especificado.
impressions int Número de impresiones de anuncios.
clicks int Número de clics en un anuncio.
revenueInAccountCurrency number Los ingresos, en la moneda del país o región de la cuenta.
requests int Número de solicitudes de anuncios.

Ejemplo de respuesta

En el ejemplo siguiente se muestra un ejemplo de cuerpo de respuesta en formato JSON para esta solicitud.

{
  "Value": [
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10765920",
      "adUnitName":"TestAdUnit",
      "revenueInAccountCurrency": 10.0,
      "impressions": 1000,
      "requests": 10000,
      "clicks": 1,
      "accountCurrencyCode":"USD"
    },
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10795110",
      "adUnitName":"TestAdUnit2",
      "revenueInAccountCurrency": 20.0,
      "impressions": 2000,
      "requests": 20000,
      "clicks": 3,
      "accountCurrencyCode":"USD"
    },
  ],
  "@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
  "TotalCount": 191753
}