Api de plataforma digital: informe de atribución sin conexión
El informe de atribución sin conexión se usa para analizar el rendimiento del artículo de línea al influir en las compras en la tienda entre las audiencias objetivo. El informe de atribución sin conexión solo es accesible para los clientes que tienen habilitada la atribución de ventas sin conexión para sus elementos de línea.
Para obtener instrucciones sobre cómo recuperar un informe, consulte Report Service o el ejemplo siguiente. Este informe requiere especificar el identificador de anunciante como parte de la dirección URL, por ejemplo:
https://api.appnexus.com/report?advertiser_id=ADVERTISER_ID
Período de tiempo
El report_interval
campo de la solicitud JSON se puede establecer en uno de los siguientes:
- Personalizado
- last_7_available_days
- last_14_available_days
- last_30_available_days
- last_365_days
Período de retención de datos
Este informe tiene una granularidad de tiempo diario y puede recuperar datos de los últimos 120 días.
Nota:
- Para ejecutar un informe para un período de tiempo personalizado, establezca los campos y
end_date
en lastart_date
solicitud de informe. Para obtener más información sobre estos campos, vea Report Service. - No se puede realizar una selección de zona horaria específica porque los datos NCS usan las zonas horarias desde donde tienen lugar las ventas.
Dimensions
Column | Tipo | ¿Filtro? | Ejemplo | Descripción |
---|---|---|---|---|
day |
date | "2021-10-10" |
El día en que NCS generó el informe. La fecha mostrada para esta dimensión coincidirá con la fecha mostrada para .analysis_start_date |
|
insertion_order_id |
string | Sí | "5533431" |
Identificador del orden de inserción. |
insertion_order_name |
string | Sí | "My IO" |
Nombre del orden de inserción. |
line_item_id |
string | Sí | "14545960" |
Identificador del elemento de línea. |
line_item_name |
string | Sí | "NCS Line Item" |
Nombre del elemento de línea. |
flight_id |
string | "12396335" |
Identificador del vuelo. | |
flight.start_date |
date | "2021-04-16 00:00:00 UTC" |
Fecha de inicio del vuelo. | |
flight.end_date |
date | "2021-04-30 23:59:59 UTC" |
Fecha de finalización del vuelo. | |
split_id |
string | Sí | "1234" |
Identificador de una división. |
split_name |
string | Sí | "my split" |
Nombre de una división. |
analysis_end_date |
date | "2021-10-10" |
Último día del intervalo de compra que se notifica para cada cohorte. | |
analysis_rejection_reason |
string | "DMA minimum not met, Retailer minimum not met" |
Error que identifica cuál de los requisitos de medición no se cumplió. | |
analysis_start_date |
date | "2021-10-03" |
El primer día del intervalo de compra que se notifica para cada cohorte. | |
frequency_type |
string | "weekly" |
Frecuencia de informes seleccionada para este elemento de línea o división. | |
lookback_hours |
string | "flight_lifetime" |
Ventana de devolución seleccionada para este elemento de línea o división. | |
product_id |
string | "10096" |
Id. de selección de producto utilizado para describir el producto o productos que se notifican. | |
product |
string | "BAKING SUPPLIES \| MARS INCORPORATED \| M&M MARS" |
Nombre de selección de producto que se usa para describir el producto o productos que se notifican. |
Métricas
Column | Tipo | Description |
---|---|---|
imps |
Entero | Número total de impresiones servidas. |
clicks |
Entero | Número total de clics registrados. |
booked_revenue |
Entero | Los ingresos recibidos del anunciante. |
media_cost |
Entero | El costo para el miembro de compra de este inventario. |
total_cost |
Entero | Importe total de los costos acumulados durante el período de tiempo notificado. Por lo general, esto incluye dos tipos de costos: costos presupuestados (costo de medios, costo de datos, cuotas de asociados, cuotas de servicio, comisiones) e ingresos del publicador si realiza un seguimiento de los pagos del publicador en la plataforma. |
imps_viewed |
Entero | Impresiones que se consideran visibles según lo definido por interactive Advertising Bureau (IAB): durante al menos un segundo, el 50 % de los píxeles de un creativo (o el 30 % para un creativo con al menos 242 500 píxeles) deben representarse en una pantalla. |
all_outlet_adjusted_number_of_trips |
Entero | El número de viajes a la tienda por hogares que han sido durante las fechas de inicio y finalización del análisis. NCS solo tiene datos para algunas tiendas (puntos de venta) dentro de ee. UU., por lo que ajusta las métricas de ventas para tener en cuenta las ventas que se produjeron en todos los puntos de venta en ee. UU. |
all_outlet_adjusted_penetration% |
Entero | Porcentaje de penetración del producto, categoría o marca durante las fechas de inicio y finalización del análisis. NCS solo tiene datos para algunas tiendas (puntos de venta) dentro de ee. UU., por lo que ajusta las métricas de ventas para tener en cuenta las ventas que se produjeron en todos los puntos de venta en ee. UU. Nota: La penetración mide la popularidad de la marca o la categoría. Se calcula dividiendo el número de personas que han comprado una marca o categoría específica de bienes al menos una vez en un período de tiempo determinado por el tamaño de la población total del mercado correspondiente. |
all_outlet_adjusted_total_spend |
Entero | El número de dólares invertidos por los hogares en el producto, categoría o marca durante las fechas de inicio y finalización del análisis. NCS solo tiene datos para algunas tiendas (puntos de venta) dentro de ee. UU., por lo que ajusta las métricas de ventas para tener en cuenta las ventas que se produjeron en todos los puntos de venta en ee. UU. |
video_completions |
Entero | En el caso de una creatividad de vídeo, el número de veces que se ha visto la creatividad de vídeo hasta su finalización. |
Ejemplo
Create una solicitud de informe con formato JSON
El archivo JSON debe incluir el report_type
de "offline_attribution"
, así como las columnas (dimensiones y métricas) y las report_interval
que desea recuperar. También puede filtrar por dimensiones específicas, definir granularidad (, , ) y especificar en el "format"
que se deben devolver los datos ("csv"
, "excel"
o "html"
). day
month
year
Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.
$ cat report-request.json
{
"report": {
"report_type": "offline_attribution",
"format": "csv",
"report_interval": "last_365_days",
"columns": [
"month",
"member_id",
"line_item_id",
"split_id",
"all_outlet_adjusted_total_spend",
"imps",
"analysis_rejection_reason"
],
"orders": [
"member_id",
"line_item_id",
"split_id"
],
"filters": [{
"line_item_id": [14545960, 14545978]
}]
}
}
POST
la solicitud al servicio de informes
En este ejemplo, solicitamos la ejecución del informe para el anunciante 660.
$ curl -b cookies -c cookies -X POST -d @offline_attribution 'https://api.appnexus.com/report?advertiser_id=660'
{
"response":{
"status":"OK",
"report_id":"07af1282c9485adcef49c95fa5d7496b"
}
}
Uso del identificador de informe para recuperar los datos del informe
La respuesta estándar incluye los datos del informe y una dirección URL de descarga que puede usar para guardar los datos en un archivo. Si desea obtener solo la dirección URL de descarga sin los datos del informe, pase "without_data"
la cadena de consulta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=07af1282c9485adcef49c95fa5d7496b'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2011-11-16 23:51:14",
"cache_hit": false,
"fact_cache_hit": false,
"json_request": "{\"report\":{\"report_type\":\"offline_attribution\",\"format\":\"csv\",\"report_interval\":\"last_365_days\",\"columns\":[\"month\",\"member_id\",\"line_item_id\",\"split_id\",\"all_outlet_adjusted_total_spend\",\"imps\",\"analysis_rejection_reason\"],\"orders\":[{\"order_by\":\"member_id\",\"direction\":\"ASC\"},{\"order_by\":\"line_item_id\",\"direction\":\"ASC\"},{\"order_by\":\"split_id\",\"direction\":\"ASC\"}],\"filters\":[{\"line_item_id\":[14545960,14545978]},{\"member_id\":\"958\"}],\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1622678400,\"start_date\":1591142400,\"user_id\":\"46052\"}",
"header_info": "Report type: offline_attributions\nReport ID: 5dd162b83a0417e13859e5e243844329\n",
"data": "day,campaign,booked_revenue,imps,clicks,click_thru_pct,site_domain\u000d\u000a2011-11-12,ExampleCampaign - 1
(123456),.000000,24,0,.000000000000000000%,aaaa.com\u000d\u000a2011-11-13,ExampleCampaign - 2 (789012),.000000,9,0,
.000000000000000000%,bbbb.net\u000d\u000a2011-11-12,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,
ccc.com\u000d\u000a2011-11-13,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,cccc.de\u000du000a
2011-11-14,ExampleCampaign - 3 (345678),.000000,10,0,.000000000000000000%,dddd.com\u000d\u000a2011-11-13,
ExampleCampaign - 4 (901234), 2.574900,22,3,13.636363636363636364%,aaaa.com\u000d\u000a2011-11-15,ExampleCampaign - 3
(345678),8.583000,2431,10,.411353352529823118%,abab.com\
...
"url": "report-download?id=495d03a7667bac467bb488043ae336e9"
},
"execution_status": "ready"
}
}
Use la dirección URL de descarga para guardar los datos del informe en un archivo.
Use el "url"
campo en la respuesta para guardar los datos del informe en un archivo. Simplemente realice otra GET
llamada e identifique la ubicación y el archivo en los que desea guardar. Asegúrese de usar el archivo de la extensión de "format"
que especificó en la solicitud inicial POST
.
$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=495d03a7667bac467bb488043ae336e9' > /tmp/site_domain.csv