Licitantes: servicio de informes
Report Service ofrece datos de informes de interés tanto a compradores como a vendedores. Se usa para responder preguntas como:
- ¿Cuánto dinero se gastó?
- ¿Cuántas impresiones se han visto?
- ¿Cuántas impresiones se vendieron?
- ¿Cuánto ingresos se han obtenido?
Se trata de un servicio de solo lectura . Aunque se realizará POST
una solicitud de informe con formato JSON, esto no modificará ningún dato en la caché de Imp Bus. Debe autenticarse como tipo de "bidder"
usuario para ejecutar informes. Cada tipo de informe proporciona sus propias opciones de métricas, filtrado y agrupación.
Sugerencia
¿Necesita más de 90 días de datos?
Los platform_buyer
tipos de informe y platform_seller
se extraen de tablas que almacenan los últimos datos de 90 días. Para datos anteriores, use los bidder_pricing_report
tipos de informe y seller_invoice_report
.
El servicio de informes ejecuta informes de forma asincrónica, lo que significa que puede ejecutar varios procesos en paralelo. Al realizar una solicitud de informe, recibirá el informe, un mensaje de error o un mensaje pendiente. Para obtener más información, vea Cómo recuperar un informe a continuación.
También hay una interfaz gráfica de usuario (UI) para ver estos datos de informes en Bidder. Si no tiene acceso a esta interfaz de usuario, póngase en contacto con su representante de Xandr.
Nota
La interfaz de usuario del licitador no expone todas las funciones que están disponibles a través de la API. Solo expone el informe de platform_buyer
análisis. Si necesita un informe diferente, debe usar la API.
Los tipos de informe principales son:
- Informe del comprador de la plataforma de licitadores
- Informe de vendedores de plataforma
- API del informe de facturación del licitador
- Informe de facturación de la plataforma de vendedores
- Informe de auditorías creativas completado
- API de informe de errores de puja del licitador
Hay dos capas de datos en el servicio de informes: metadatos y datos reales. Los metadatos son una lista de parámetros de informes disponibles.
Para ejecutar un informe personalizado, necesitará una solicitud con formato JSON. Puede solicitar datos mediante un filtro, grupo o columna. Un filtro filtrará los resultados. Una solicitud que tenga un filtro como day
, se filtrará en función de los datos agregados. También puede buscar por parámetros individuales, como imps_sold
.
Http (método) | Endpoint | Description |
---|---|---|
GET | https://api.adnxs.com/report?meta=buyer_platform_billing |
Devolver metadatos para el bidder_pricing_report tipo. |
GET | https://api.adnxs.com/report/meta/platform_buyer |
Devolver metadatos para el platform_buyer tipo. |
GET | https://api.adnxs.com/report/meta/platform_seller |
Devolver metadatos para el platform_seller tipo. |
GET | https://api.adnxs.com/report/meta/seller_platform_billing |
Devolver metadatos para el seller_invoice_report tipo. |
Nota
También puede usar un formato de consulta más estándar para devolver metadatos:
report?meta=report_type
Por ejemplo:
GET https://api.adnxs.com/report?meta=platform_buyer
Los metadatos tienen el siguiente formato:
{"column":"day","type":"time"}
{"column":"month","type":"time"}
{"column":"geo_country","type":"string"}
$ curl "https://api.adnxs.com/report/meta/platform_buyer"
"response": {
"status": "OK",
"meta": {
"columns": [
{
"column": "month",
"type": "time"
},
{
"column": "day",
"type": "date"
},
{
"column": "hour",
"type": "date"
},
...
],
"filters": [
{
"column": "hour",
"type": "date"
},
{
"column": "day",
"type": "date"
},
{
"column": "year",
"type": "date"
},
...
],
"havings": [
{
"column": "clicks"
},
{
"column": "buyer_spend"
},
{
"column": "imps_bought"
},
{
"column": "buyer_ecpm"
},
{
"column": "click_rate_sold"
}
],
"time_intervals": [
"current_hour",
"last_hour",
"last_48_hours",
"today",
"yesterday",
"last_7_days",
"month_to_date",
"quarter_to_date",
"last_month",
"lifetime",
"mtd"
]
}
}
Http (método) | Endpoint | Description |
---|---|---|
GET | https://api.adnxs.com/report/REPORT_ID |
Solicitar el estado de un informe. |
GET | https://api.adnxs.com/report-download/REPORT_ID |
Recuperar datos de informe. |
POST | https://api.adnxs.com/report?member_id=MEMBER_ID (JSON de informe) |
Solicitar un informe. |
Campo | Obligatorio | Tipo | Description |
---|---|---|---|
columns |
Sí (al menos uno) | matriz | Lista de columnas que se van a incluir en el informe. Consulte la documentación de cada informe individual para saber qué columnas están disponibles. Para obtener un ejemplo sencillo, vea Cómo recuperar un informe a continuación. |
end_date |
no | string | Fecha de finalización del informe. - Para los tipos de informe que ofrecen datos por hora, debe tener el formato "YYYY-MM-DD HH:MM:SS" . Sin embargo, MM:SS debe ser 00:00 , ya que los datos no están disponibles durante minutos y segundos. - Para los tipos de informe que no ofrecen datos por hora, debe tener el formato "YYYY-MM-DD" . Nota: No end_date es inclusivo. Por ejemplo, si inicia un informe mensual sobre "2012-07-01" y finaliza el informe en "2012-07-31" , el informe no incluirá datos del último día del mes. La manera correcta de recuperar estos datos sería finalizar el informe en "2012-08-01" . |
escape_fields |
no | booleano | Cuando true es , agrega comillas alrededor de cada campo de la salida del informe para permitir una importación más segura en Excel. Esto solo se aplica a los informes delimitados por tabulaciones y CSV. |
filters |
no | matriz | Lista de filtros que se aplicarán al informe. Consulte la documentación de cada informe individual para ver en qué campos se puede filtrar. Para obtener un ejemplo sencillo, vea Cómo recuperar un informe a continuación. Nota: El valor del is_delivered filtro es solo true si la impresión se ha servido correctamente. De lo contrario, es false . |
report_interval |
no | enumeración | Intervalo de tiempo para el informe. No todos los informes aceptan todos los intervalos; consulte la documentación y los metadatos de cada informe para obtener más información. Posibles valores: - current_hour - last_hour - today - yesterday - last_48_hours - last_7_days - lifetime - month_to_date - mtd - last_month |
report_type |
sí | enumeración | Debe ser una de las siguientes: - " platform_buyer "- " platform_seller "- " bidder_pricing_report "- " seller_invoice_report "- " completed_creative_audits "- " bidder_bid_error_report "Esto determina qué información se devolverá. |
row_per |
no | matriz | Lista de agrupaciones que se van a incluir en el informe. Consulte la documentación de cada informe individual para obtener información sobre las columnas por las que se pueden agrupar. Para obtener un ejemplo sencillo, vea Cómo recuperar un informe a continuación. |
start_date |
no | string | Fecha de finalización del informe. - Para los tipos de informe que ofrecen datos por hora, debe tener el formato "YYYY-MM-DD HH:MM:SS" . Sin embargo, MM:SS debe ser 00:00 , ya que los datos no están disponibles durante minutos y segundos. - Para los tipos de informe que no ofrecen datos por hora, debe tener el formato "YYYY-MM-DD" . |
timezone |
no | string | Zona horaria en la que se notificarán los datos. Para obtener una lista de los posibles valores de zona horaria, consulte Reporting Timezones (Informes de zonas horarias). |
- Paso 1. Create una solicitud de informe con formato JSON
- Paso 2. POST the request to the Report Service
- Paso 3. OBTENER el estado del informe del servicio de informes
- Paso 4. OBTENER los datos del informe del servicio de descarga de informes
El archivo JSON debe incluir el específico report_type
que desea ejecutar, así como las columns
(dimensiones y métricas) y report_interval
("today"
, "yesterday"
, "month_to_date"
, etc.) que desea recuperar. También puede incluir filters
para las dimensiones y definir la granularidad (año, mes, día) y especificar en qué format
se deben devolver los datos. Las format
opciones son:
"csv"
- Archivo separado por comas"xls"
- Archivo M.S. Excel separado por tabulaciones"xlsx"
- Formato nativo de M.S. Excel
Nota
Para filtrar una dimensión por más de un valor, use una matriz. Por ejemplo:
Correcto:
"filters": [{"bid_type": ["learn","optimized"]}, {"geo_country":"US"}]
Incorrecto:
"filters": [{"bid_type":"learn"}, {"bid_type":"optimized"}, {"geo_country":"US"}]
Consulte campos JSON anteriores para obtener más detalles sobre los campos que se pueden incluir en la solicitud. Para obtener una lista completa de las dimensiones y métricas disponibles, consulte la documentación del tipo de informe específico que desea ejecutar o extraiga los metadatos del informe, como se describe en API REST para ver metadatos.
$ cat report_request
{
"report": {
"report_type": "platform_buyer",
"report_interval": "last_48_hours",
"columns": ["day","imps_bought"],
"filters": [{"geo_country":"US"}],
"orders": [{"order_by":"day", "direction":"ASC"}],
"format": "csv"
}
}
La POST
solicitud JSON y obtener un identificador de informe.
$ curl -b cookies -c cookies -X POST -d @report_request 'https://api.adnxs.com/report?member_id=255'
{
"response": {
"status": "OK",
"report_id": "ca9955709eade9a0e89f5cda5345c12r",
"dbg_info": {
...
}
}
}
Realice una GET
llamada con el identificador de informe para recuperar el estado del informe. Continúe realizando esta llamada hasta que "execution_status"
sea "ready"
. A continuación, use el report-download
servicio para guardar los datos de informes en un archivo. (Esto se describe en el paso siguiente).
$ curl -b cookies -c cookies 'https://api.adnxs.com/report/ca9955709eade9a0e89f5cda5345c12r'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2012-03-13 18:15:48",
"cache_hit": false,
"fact_cache_hit": false,
"json_request": "{\"report\":{\"report_type\":\"network_analytics\",\"report_interval\":
\"last_48_hours\",\"columns\":[\"day\",\"imps\",\"clicks\"],\"filters\":[{\"geo_country\":
\"US\"},{\"entity_member_id\":\"514\"},{\"entity_member_id\":null}],\"orders\":
[{\"order_by\":\"day\",\"direction\":\"ASC\"},{\"order_by\":\"imps\",\"direction\":
\"DESC\"}]}}",
"header_info": "Report type:,network_analytics\r\n,\r\nRun at:,2012-03-13 18:15:48\r\nStart date:,
\r\nEnd date:,\r\nTimezone:,\r\nUser:,John Smith (9385)\r\n",
"report_size": "10",
"row_count": "35",
"url": "report-download?id=ca9955709eade9a0e89f5cda5345c12r"
},
"execution_status": "ready",
"dbg_info": {
...
}
}
}
Para descargar los datos del informe en un archivo, realice otra GET
llamada con el identificador de informe, pero esta vez al report-download
servicio. Puede encontrar el servicio y el identificador de informe en el campo url de la respuesta anterior GET
. Al identificar el archivo en el que desea guardar, asegúrese de usar la extensión de archivo de "format"
que especificó en su inicial POST
.
Sugerencia
Si se produce un error durante la descarga, el encabezado de respuesta incluirá un código de error HTTPS y un mensaje. Use -i
o -v
en la solicitud para exponer el encabezado de respuesta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=<download_id>
A continuación, puede abrir el archivo.
Puede automatizar el proceso de generación de informes creando versiones guardadas de los informes que le interesan y haciendo que nuestro sistema le envíe por correo electrónico los datos a intervalos especificados. Para obtener más información sobre cómo configurar estos informes automatizados, consulte El servicio de informes guardados.
- Servicio de informes guardado
- Informe de auditorías creativas completado
- Informe del comprador de la plataforma de licitadores
- API del informe de facturación del licitador
- Informe de vendedores de plataforma
- Informe de facturación de la plataforma de vendedores
- API de informe de errores de puja del licitador
- Informes de disponibilidad de inventario
- Zonas horarias de informes