API de plataforma digital: informe de atribución sin conexión

El informe Atribución sin conexión se utiliza para analizar el rendimiento de su línea de pedido para influir en las compras en la tienda entre sus públicos 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 líneas de pedido.

Para obtener instrucciones sobre cómo recuperar un informe, consulte Servicio de informes o el ejemplo siguiente. Este informe requiere especificar el id. 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:

  • personalizada
  • last_7_available_days
  • last_14_available_days
  • last_30_available_days
  • last_365_days

Período de retención de datos

Los datos de este informe tienen el siguiente período de retención:

  • Retención por hora: 100 días
  • Retención diaria: 500 días

Nota:

  • Para ejecutar un informe para un período de tiempo personalizado, establezca los campos y end_date en la start_date solicitud de informe. Para obtener más información sobre estos campos, vea Servicio de informes.
  • No puede realizar una selección de zona horaria específica porque los datos de NCS utilizan las zonas horarias desde donde se realizan 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 el analysis_start_datearchivo
insertion_order_id string "5533431" El identificador de la orden de inserción.
insertion_order_name string "My IO" El nombre de la orden de inserción.
line_item_id string "14545960" El identificador del elemento de línea.
line_item_name string "NCS Line Item" El nombre de la línea de pedido.
flight_id string "12396335" El Id. del piloto.
flight.start_date date "2021-04-16 00:00:00 UTC" La fecha de inicio del vuelo.
flight.end_date date "2021-04-30 23:59:59 UTC" La fecha de finalización del vuelo.
split_id string "1234" El identificador de una división.
split_name string "my split" El nombre de una división.
analysis_end_date date "2021-10-10" El último día del intervalo de compra notificado para cada cohorte.
analysis_rejection_reason string "DMA minimum not met, Retailer minimum not met" El error que identifica cuáles de los requisitos de medición no se cumplieron.
analysis_start_date date "2021-10-03" El primer día del intervalo de compra notificado para cada cohorte.
frequency_type string "weekly" La frecuencia de informes seleccionada para esta línea de pedido o división.
lookback_hours string "flight_lifetime" La ventana de lookback seleccionada para esta línea de pedido o división.
product_id string "10096" El identificador de selección de productos utilizado para describir el producto o productos que se van a notificar.
product string "BAKING SUPPLIES \| MARS INCORPORATED \| M&M MARS" El nombre de la selección de productos utilizada para describir el producto o productos que se informan.

Métricas

Column Tipo Descripción
imps Entero El número total de impresiones servidas.
clicks Entero El número total de clics registrados.
booked_revenue Entero Los ingresos recibidos del anunciante.
media_cost Entero El costo para el miembro comprador de este inventario.
total_cost Entero La cantidad total de costos acumulados durante el período de tiempo informado. Esto generalmente incluye dos tipos de costos: costos presupuestados (costo de medios, costo de datos, tarifas de socios, tarifas de servicio, comisiones) e ingresos del editor si realiza un seguimiento de los pagos del editor 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 una creatividad (o el 30 % de una creatividad 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 parte de los hogares que han estado durante las fechas de inicio y finalización del análisis. NCS solo tiene datos para algunas tiendas (puntos de venta) dentro de los EE. UU., por lo que ajusta las métricas de ventas para tener en cuenta las ventas que ocurrieron en todos los puntos de venta en los EE. UU.
all_outlet_adjusted_penetration% Entero El porcentaje de penetración del producto, la categoría o la marca durante las fechas de inicio y finalización del análisis. NCS solo tiene datos para algunas tiendas (puntos de venta) dentro de los EE. UU., por lo que ajusta las métricas de ventas para tener en cuenta las ventas que ocurrieron en todos los puntos de venta en los EE. UU.

Nota: La penetración mide la popularidad de la marca o categoría. Se calcula dividiendo el número de personas que han comprado una marca o categoría específica de productos 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 gastados por los hogares en el producto, la categoría o la marca durante las fechas de inicio y finalización del análisis. NCS solo tiene datos para algunas tiendas (puntos de venta) dentro de los EE. UU., por lo que ajusta las métricas de ventas para tener en cuenta las ventas que ocurrieron en todos los puntos de venta en los EE. UU.
video_completions Entero En el caso de un creativo de vídeo, el número de veces que se ha visto el creativo de vídeo hasta su finalización.

Ejemplo

Crear una solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type of , "offline_attribution"así como las columnas (dimensiones y métricas) y el report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir la granularidad (year, month, day) y especificar la forma en que "format" se deben devolver los datos ("csv", "excel", o "html"). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, vea el servicio de informes.

$ 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"
    }
}

Usar el 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 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 de la respuesta para guardar los datos del informe en un archivo. Simplemente haga otra GET llamada e identifique la ubicación y el archivo en el que desea guardar. Asegúrese de usar el archivo con la extensión de la "format" extensión que especificó en la solicitud inicial POST .

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=495d03a7667bac467bb488043ae336e9' > /tmp/site_domain.csv