Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Usa este método en la API de análisis de Microsoft Store para obtener datos de rendimiento de anuncios agregados 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 que proporciona el informe de rendimiento de la publicidad en el Centro de Partners.
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.
Para obtener más información, consulte Acceda a los datos de análisis utilizando los servicios de Microsoft Store.
Solicitud
Sintaxis de la solicitud
| Método | Solicitud de URI |
|---|---|
| OBTENER | https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance |
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 anuncios 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 | El id. de la Tienda de la aplicación para la que quieres recuperar los datos de rendimiento de anuncios. | No |
| Fecha de inicio | fecha | Fecha de inicio en el rango de fechas para recuperar los datos de rendimiento de anuncios, en 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 intervalo de fechas de los datos de rendimiento de anuncios que se van a 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. Para obtener más información, consulte la siguiente sección de los campos de filtro . | 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 |
| Ordenar por | cuerda / cadena | Instrucción que ordena los valores de los datos de resultados. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede ser una de las siguientes cadenas:
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:
El parámetro groupby se puede usar con el parámetro aggregationLevel . Por ejemplo: &groupby=applicationId&aggregationLevel=week |
No |
Filtrar campos
El parámetro de filtro 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 yo . Aquí tienes un ejemplo de filtro , parámetro:
- filter=market eq 'US' y deviceType eq 'phone'
Para obtener una lista de los campos admitidos, consulte la tabla siguiente. Los valores de cadena deben estar delimitados por comillas simples en el parámetro del filtro
| Campo | Descripción |
|---|---|
| mercado | Cadena que contiene el código de país ISO 3166 del mercado donde se sirven los anuncios. |
| tipo de dispositivo | Una de las siguientes cadenas: PC/Tableta o Teléfono. |
| adUnitId | Cadena que especifica un identificador de unidad de anuncio que se va a aplicar al filtro. |
| pubCenterAppName | Una cadena que especifica el nombre pubCenter de la aplicación actual para aplicar al filtro. |
| adProvider | Cadena que especifica un nombre de proveedor de anuncios que se va a aplicar al filtro. |
| fecha | 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 para obtener datos de rendimiento de anuncios. Sustituya el valor de applicationId por el identificador de tienda para su 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
Cuerpo de respuesta
| Importancia | Tipo | Descripción |
|---|---|---|
| Importancia | arreglo | Matriz de objetos que contienen datos de rendimiento de anuncios agregados. Para obtener más información sobre los datos de cada objeto, consulte la siguiente sección sobre los valores de rendimiento de los anuncios. |
| @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. |
Valores de rendimiento de anuncios
Los elementos de la matriz Value contienen los valores siguientes.
| Importancia | Tipo | Descripción |
|---|---|---|
| fecha | cuerda / cadena | La primera fecha del intervalo de fechas para los datos de rendimiento de anuncios. 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 cual se recuperan los datos de rendimiento de anuncios. |
| Nombre de la aplicación | cuerda / cadena | Nombre visible de la aplicación. |
| adUnitId | cuerda / cadena | Identificador de la unidad de anuncio. |
| Nombre de la unidad de anuncio | cuerda / cadena | Nombre de la unidad de anuncios, tal como especifica el desarrollador en el Centro de Socios. |
| adProvider | cuerda / cadena | Nombre del proveedor de anuncios |
| tipo de dispositivo | cuerda / cadena | Tipo de dispositivo en el que se han servido los anuncios. Para obtener una lista de las cadenas admitidas, consulte la sección campos de filtro anteriores. |
| mercado | cuerda / cadena | El código de país ISO 3166 del mercado donde se sirven los anuncios. |
| Código de moneda de la cuenta | cuerda / cadena | El código de moneda de la cuenta. |
| pubCenterAppName | cuerda / cadena | Nombre de la aplicación pubCenter asociada a la aplicación en el Centro de partners. |
| solicitudes del proveedor de anuncios | Int | Número de solicitudes de anuncios para el proveedor de anuncios especificado. |
| Impresiones | Int | El número de impresiones de anuncios. |
| Clics | Int | Número de clics de anuncios. |
| ingresosEnLaMonedaDeLaCuenta | número | Los ingresos, en la moneda del país o región de la cuenta. |
| solicitudes | Int | Número de solicitudes de anuncios. |
Ejemplo de respuesta
En el ejemplo siguiente se muestra un cuerpo de respuesta JSON de ejemplo 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
}