Obtención de datos de rendimiento de campañas publicitarias

2025-06-10

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 publicitarias 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ña publicitaria en el Centro de Partners. Para obtener más información sobre las campañas publicitarias, 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 Administrar campañas publicitarias en la API de promociones de Microsoft Store.

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

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

Para recuperar datos de rendimiento de campaña publicitaria para una aplicación específica, use el parámetro applicationId . Para recuperar los datos de rendimiento de los anuncios de todas las aplicaciones asociadas con la cuenta de desarrollador, omita el parámetro applicationId .

Parámetro	Tipo	Descripción	Obligatorio
applicationId	cuerda / cadena	La id. de la Tienda de la aplicación para la que quieres recuperar los datos de rendimiento de la campaña publicitaria.	No
Fecha de inicio	fecha	Fecha de inicio en el rango de fechas de los datos de rendimiento de la campaña publicitaria que se van a recuperar, con el formato AAAA/MM/DD. El valor predeterminado es la fecha actual menos 30 días.	No
fecha de finalización	fecha	Fecha de finalización del rango de fechas de los datos de rendimiento de la campaña publicitaria que se desea recuperar, con el formato AAAA/MM/DD. El valor predeterminado es la fecha actual menos un día.	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 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 o o. Este es un ejemplo de parámetro de filtro : `filter=campaignId eq '100023'`.	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 resultado para los datos de rendimiento de la campaña publicitaria. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede ser una de las siguientes cadenas: fecha idCampaña 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 cadena orderby: orderby=date,campaignId	No
groupby	cuerda / cadena	Instrucción que aplica la agregación de datos solo a los campos especificados. Puede especificar los siguientes campos: idCampaña Id de la aplicación fecha códigoDeMoneda 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

Cuerpo de respuesta

Importancia	Tipo	Descripción
Importancia	arreglo	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, consulte la sección del objeto de rendimiento de campaña a continuació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 el parámetro superior de la solicitud se establece en 5, pero hay más de 5 elementos de información para la consulta.
Conteo Total	Int	Número total de filas en el resultado de los datos de la consulta.

Objeto de rendimiento de campaña

Los elementos de la matriz Value contienen los valores siguientes.

Importancia	Tipo	Descripción
fecha	cuerda / cadena	La primera fecha del intervalo de fechas de los datos de rendimiento de la campaña publicitaria. 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.
applicationId	cuerda / cadena	El identificador de la Tienda de la aplicación para la que se recuperan los datos de rendimiento de la campaña publicitaria.
ID de campaña	cuerda / cadena	Identificador de la campaña publicitaria.
lineId	cuerda / cadena	El ID de la campaña publicitaria y de la línea de entrega que generó estos datos de rendimiento.
código de moneda	cuerda / cadena	El código de moneda del presupuesto de la campaña.
gastar	cuerda / cadena	Importe presupuestado que se ha invertido para la campaña publicitaria.
Impresiones	largo	Número de impresiones publicitarias para la campaña.
instala	largo	Número de instalaciones de aplicaciones relacionadas con la campaña.
Clics	largo	Número de clics en los anuncios para la campaña.
iapInstalls	largo	El número de instalaciones de complementos, también denominados compras desde la aplicación o IAP, relacionadas con la campaña.
usuarios activos	largo	Número de usuarios que han realizado clic en un anuncio que forma parte de la campaña y se han devuelto a la aplicación.

Ejemplo de respuesta

En el ejemplo siguiente se muestra un cuerpo de respuesta JSON de ejemplo 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
}

Compartir a través de