Obtén datos sobre el rendimiento de las campañas publicitarias

  • Artículo

Usa este método en la API de análisis de Microsoft Store para obtener un resumen agregado de los datos de rendimiento de las campañas de anuncios promocionales 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 campañas de anuncios en el Centro de partners. Para obtener más información sobre las campañas de anuncios, consulta Crear una campaña publicitaria para tu aplicación.

Para crear, actualizar o recuperar detalles de las campañas publicitarias, puedes usar los métodos para Administrar campañas publicitarias en la API de promociones de Microsoft Store.

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

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 campañas publicitarias 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 campañas publicitarias. No
startDate date Fecha de inicio del intervalo de fechas de los datos de rendimiento de campañas publicitarias 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 campañas publicitarias 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. El único filtro admitido es campaignId. Cada instrucción puede usar los operadores eq o ne, y las instrucciones se pueden combinar mediante y u o. Este es un ejemplo de parámetro filter: filter=campaignId eq '100023'. 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 de los resultados correspondientes a los datos de rendimiento de campañas publicitarias. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede estar formado por una de las siguientes cadenas:

  • date
  • campaignId

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,campaignId

 No
groupby string

Instrucción que aplica la agregación de datos solo a los campos especificados. Puedes especificar los siguientes campos:

  • campaignId
  • applicationId
  • date
  • currencyCode

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

 No

Ejemplo de solicitud

En el ejemplo siguiente se muestran varias solicitudes para obtener datos de rendimiento de campañas publicitarias.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' 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 campañas publicitarias. Para obtener más información sobre los datos de cada objeto, consulta la sección objeto de rendimiento de la campaña 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.

Objeto de rendimiento de la campaña

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 campañas publicitarias. 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 campañas publicitarias.
campaignId string Identificador de la campaña publicitaria.
lineId string Identificador de la línea de entrega de campaña publicitaria que generó estos datos de rendimiento.
currencyCode string El código de divisa del presupuesto de la campaña.
spend string Importe presupuestado que se ha invertido en la campaña publicitaria.
impressions long Número de impresiones publicitarias para la campaña.
instalaciones long Número de instalaciones de aplicaciones relacionadas con la campaña.
clicks long Número de clics en anuncios de la campaña.
iapInstalls long El número de instalaciones de complementos (también denominados compras desde la aplicación o IAP) relacionadas con la campaña.
activeUsers long Número de usuarios que han hecho clic en un anuncio que forma parte de la campaña y han vuelto a la aplicación.

Ejemplo de respuesta

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

{
  "Value": [
    {
      "date": "2015-04-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "4568",
      "lineId": "0001",
      "currencyCode": "USD",
      "spend": 700.6,
      "impressions": 200,
      "installs": 30,
      "clicks": 8,
      "iapInstalls": 0,
      "activeUsers": 0
    },
    {
      "date": "2015-05-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "1234",
      "lineId": "0002",
      "currencyCode": "USD",
      "spend": 325.3,
      "impressions": 20,
      "installs": 2,
      "clicks": 5,
      "iapInstalls": 0,
      "activeUsers": 0
    }
  ],
  "@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
  "TotalCount": 1917
}