Compartir a través de


API de plataforma digital: informe de alcance y frecuencia del comprador

El informe De alcance y frecuencia del comprador muestra la información asociada a dos parámetros: "reach" y "frequency". "alcance" es el número de dispositivos únicos o personas expuestas a anuncios. "frecuencia" es el número promedio de veces que cada dispositivo o persona único fue expuesto a anuncios. Ayuda a extraer conclusiones significativas sobre el impacto de los dispositivos cruzados en los casos de uso de conversión. En resumen, los compradores pueden tener una visión sobre cómo el dispositivo cruzado impactó el número de veces que una sola persona vio sus anuncios en todos sus dispositivos usando este informe, ya que este informe muestra el alcance histórico y la frecuencia media en la compra.

El Informe de alcance y frecuencia del comprador ofrece filtrado flexible para analizar dispositivos únicos facilitando el procedimiento siguiente:

  • Extraiga un total básico en ejecución de dispositivos únicos para sus elementos de línea o pedidos de inserción activos.
  • Extraiga dispositivos únicos para estos objetos durante un período de tiempo definido (por ejemplo, la semana pasada).
  • Puede filtrar y agrupar en criterios específicos, lo que proporcionará un recuento preciso de dispositivos únicos en los criterios especificados. Por ejemplo, el recuento de dispositivos únicos en los elementos de línea A, B y D, en EE. UU. y Canadá, durante el mes pasado.

Período de tiempo

El report_interval campo de la solicitud JSON se puede establecer en uno de los siguientes:

  • costumbre
  • hoy
  • last_hour
  • last_24_hours
  • yesterday
  • last_48_hours
  • last_2_days
  • last_7_days
  • last_14_days
  • last_30_days
  • last_month
  • month_to_date
  • quarter_to_date
  • vida

Período de retención de datos

Los datos de este informe se conservan durante 90 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 Report Service.

Dimensions

Column Tipo ¿Filtro? Ejemplo Descripción
month date Yes "2010-02" El mes de la subasta.
day date Yes "2010-02-01" El día de la subasta.
hour date Yes "2010-02-01 06:00:00" La hora de la subasta.
buyer_member_id Entero Yes 123 Identificador del miembro de compra.
geo_country string "US" País o región objetivo del anuncio.
media_type string No "Banner" El estilo de visualización general de la creatividad.
media_type_id Entero Yes 1 Identificador del tipo de medio.
supply_type string "Mobile App" Método de representación de la creatividad en un dispositivo.
billing_period_id Entero Yes 453 Identificador del período de facturación del pedido de inserción.
billing_period.start_date string No "2010-02-01" Fecha de inicio del período de facturación del pedido de inserción.
billing_period.end_date string No "2010-02-08" Fecha de finalización del período de facturación del pedido de inserción.
split_id Entero Yes 111 Identificador de la división que compró las impresiones en este conjunto de datos.
split_name string No "FirstSplit" Nombre de la división que compró las impresiones en este conjunto de datos.
flight Entero No 32 Identificador del vuelo en un período de facturación en un pedido de inserción.
flight.start_dt string No "2010-02-01" Fecha de inicio del vuelo en un período de facturación en un pedido de inserción.
flight.end_dt string No "2010-02-03" Fecha de finalización del vuelo en un período de facturación en un pedido de inserción.
advertiser_id Entero Yes 789 El identificador del anunciante para el que se compró la impresión.
advertiser_name string No "AdvertiserA" Nombre del anunciante para el que se compró la impresión.
line_item_id Entero Yes 1122 Identificador del artículo de línea con el que se compró la impresión.
line_item_name string No "Line Item 1" Nombre del artículo de línea con el que se compró la impresión.
creative_id Entero Yes 444 Identificador de la creatividad de la que informamos sobre la frecuencia o la recencia de .
creative_name string No "Q1 2017 728x90" Nombre de la creatividad de la que informamos sobre la frecuencia o la recencia de .
insertion_order_id Entero Yes 321 Identificador del pedido de inserción con el que se compró la impresión.
device_type string "Desktops and Laptops" Tipo del dispositivo donde se ha producido la impresión.
frequency_cap_type string No "Classical", "Advanced" o "None" Tipo de límite de frecuencia que se usa para limitar la entrega excesiva a usuarios individuales. Cuando un identificador estaba disponible en la solicitud, "Classical" es el tipo de límite de frecuencia predeterminado. "Advanced" hace referencia a la característica "Administración avanzada de frecuencias".

Métricas

Column Tipo Ejemplo Fórmula Descripción
imps Entero 234123 Duendes Número total de impresiones.
identified_imps Entero 234123 identified_imps El número total de impresiones identificadas (es decir, esas impresiones que incluían una cookie, un identificador de dispositivo, etc. como parte de la solicitud de anuncio).
unidentified_imps Entero 234212 unidentified_imps El número total de impresiones no identificadas (es decir, aquellas que no incluyeron una cookie, un identificador de dispositivo, etc. como parte de la solicitud de anuncio).
approx_users_count Entero 5654 approx_users_count Los usuarios únicos aproximados cuentan quién ha visto la impresión.
average_impression_frequency double 8898 imps/approx_users_count Número de impresiones vistas por cada usuario único.
approximate_consumer_count Entero 8888 approximate_consumer_count Recuento aproximado de consumidores que han visto la impresión debido a la extensión de audiencia entre dispositivos.
average_consumer_impression_frequency double 7999 imps/approximate_consumer_count Número de impresiones vistas por cada consumidor único debido a la extensión de audiencia entre dispositivos.
approximate_incremental_devices Entero 899 approximate_incremental_devices Número total de cookies únicas, dispositivos móviles u otros dispositivos alcanzados por las impresiones.
cross_device_incremental_imps Entero 6888 cross_device_incremental_imps Número de impresiones que se realizan transacciones debido a la extensión de audiencia entre dispositivos. Esto representa el número de impresiones que se entregaron en dispositivos fuera de los segmentos de destino, debido a que se aplica un gráfico entre dispositivos para ampliar el alcance a más dispositivos propiedad de un consumidor.
average_identified_impression_frequency double 1.23 identified_imps/approx_users_count Número de impresiones identificadas vistas por usuarios únicos.
estimated_people_reach (actualmente solo está disponible en EE. UU.) Entero 269,266 dispositivos únicos o factor de densidad de dispositivos Número estimado de personas alcanzadas, desduplicadas en las dimensiones especificadas por el usuario.

Nota:

La métrica estimated_people_reach solo está disponible actualmente en EE. UU. Este modelo tiene en cuenta los dispositivos únicos alcanzados en el nivel de código postal y utiliza los datos del censo de EE. UU. disponibles públicamente para la población total de cada código postal, con el fin de calcular el número de personas alcanzadas para ese código postal. A continuación, estos datos de nivel de código postal se agregan cuando la API extrae un informe para que el comprador pueda verlo en cualquier nivel de granularidad proporcionado por las dimensiones existentes en el informe.

Advanced Frequency Management (AFM), que se encuentra actualmente en versión beta, no tiene en cuenta el identificador universal (id. universal). Esto está sujeto a cambios, ya que la característica se movería a disponibilidad general. Los elementos de línea que usan la selección de destino de id. universal deben evitar el uso de AFM hasta que esto esté completamente adaptado.

Ejemplos

Creación de la solicitud de informe JSON

El archivo JSON debe incluir el report_type de "buyer_approximate_unique_users_hourly", así como las columnas (dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir granularidad (year, month, day) y especificar el formato en el que se deben devolver los datos (csv, excelo html). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.

$ cat buyer_approximate_unique_users_hourly

{"report":
    {
        "report_type":"buyer_approximate_unique_users_hourly",
        "columns":[
            "hour",
            "buyer_member_id",
            "media_type",
            "supply_type",
            "creative",
            "line_item_id",
            "imps",
            "average_impression_frequency",
            "cross_device_incremental_imps"
        ],
        "report_interval":"last_48_hours",
        "format":"csv"
    }
}

POST la solicitud al servicio de informes

POST la solicitud JSON para recuperar un identificador de informe.

$ curl -b cookies -X post -d @buyer_approximate_unique_users_hourly "https://api.appnexus.com/report?advertiser_id=789"

{
   "response":{
      "status":"OK",
      "report_id":"09b6979a6a4c3805bdac8921378d3622"
   }
}

GET estado del informe del servicio de informes

Realice una GET llamada con el identificador de informe para recuperar el estado del informe. Continúe realizando esta GET llamada hasta que execution_status sea "ready". A continuación, use el servicio de descarga de informes para guardar los datos del informe en un archivo, como se describe en el paso siguiente.

$ curl -b cookies 'https://api.appnexus.com/report?id=09b6979a6a4c3805bdac8921378d3622'

{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2016-12-11 19:15:48",
         "json_request": "{\"report\":{\"report_type\":\"buyer_approximate_unique_users_hourly\",
             \"columns\":[\"hour\",\"buyer_member_id\",
             \"media_type\",\"supply_type\",\"creative\",\"line_item_id\",
             \"imps\",\"average_impression_frequency\",\"cross_device_incremental_imps\"],
             \"report_interval\":\"last_48_hours\",\"format\":\"csv\",\"filters\":[{\"advertiser_id\":\"789\"}]}}",
             "url":"report-download?id=b97897a7864dd8f34e7457226c7af592"
      },
      "execution_status":"ready"
   }
}

GET los datos del informe del servicio de descarga de informes

Para descargar los datos del informe en un archivo, realice otra GET llamada con el identificador de informe, pero esta vez al servicio de descarga de informes . Puede encontrar el identificador de servicio e informe en el url campo de la respuesta a la llamada anterior GET . Al identificar el archivo en el que desea guardar, asegúrese de usar la extensión de archivo del formato de archivo que especificó en la inicial POST.

Nota:

Si se produce un error durante la descarga, el encabezado de respuesta incluirá un código de error HTTP y un mensaje. Use -i o -v en la llamada para exponer el encabezado de respuesta.

curl -b cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/buyer_approximate_unique_users_hourly.csv

Nota:

Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.