API de plataforma digital: informe de rendimiento del segmento de comprador
Este informe proporciona a los compradores rendimiento de segmentos entre campañas y varios anunciantes.
El time_granularity
valor de los datos es hourly
. Para obtener instrucciones sobre cómo recuperar un informe, consulte el Servicio de informes o los ejemplos.
Nota:
Impresiones entre segmentos de usuario: Dado que este informe agrega las impresiones que proporciona el segmento de usuario, las impresiones asociadas a los usuarios que están presentes en varios segmentos se contarán más de una vez. Como resultado, asegúrese de agrupar por segment_id
al ejecutar el informe.
Período de tiempo
El report_interval
campo de la solicitud JSON debe establecerse en uno de los siguientes:
- hoy
- yesterday
- last_7_days
- last_14_days
- last_30_days
Período de retención de datos
El período de retención de datos para este informe es de 45 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? | Ejemplos | Description |
---|---|---|---|---|
month |
time | no | "2010-02" |
El mes de la subasta. |
day |
date | sí | "2010-02-01" |
El día de la subasta. |
hour |
time | no | "2010-02-01 06:00:00" |
La hora de la subasta. |
insertion_order_id |
Entero | sí | 321 |
Identificador del orden de inserción. Si el valor es 0 , la impresión la compró un comprador de terceros. |
campaign_id |
Entero | sí | 222 |
Identificador de la campaña que compró la impresión. |
campaign_name |
string | no | "Fall Wares" |
Nombre de la campaña que compró la impresión. |
campaign |
string | no | "Fall Wares (222)" |
En desuso. |
advertiser_id |
Entero | sí | 789 |
El identificador del anunciante. Si el valor es 0 , la impresión la compró un comprador de terceros o se mostró un valor predeterminado o PSA. |
line_item_id |
Entero | sí | 111 |
Identificador del elemento de línea. Si el valor es 0 , la impresión la compró un comprador de terceros. |
advertiser_name |
string | no | "Amco" |
Nombre del anunciante. |
advertiser |
string | no | "Amco (789)" |
En desuso. |
line_item_name |
string | no | "Kitchen" |
Nombre del elemento de línea. |
line_item |
string | no | "Kitchen (111)" |
En desuso. |
split_id |
Entero | sí | 342 |
Identificador de la división que compró las impresiones en este conjunto de datos. Las divisiones solo se aplican a los elementos de línea aumentadas. Para cualquier informe que contenga campañas, ( split_id si se incluye) será null . |
split_name |
string | sí | "Mobile Split A" |
Nombre de la división que compró las impresiones en este conjunto de datos. Las divisiones solo se aplican a los elementos de línea aumentadas. Para cualquier informe que contenga campañas, ( split_name si se incluye) será null . |
campaign_code |
string | no | "Mobile Campaign Code" |
Código personalizado para la campaña. |
segment_id |
Entero | sí | 220 |
Identificador del píxel del segmento. |
segment_name |
string | no | "Submitted application" |
Nombre del segmento. |
segment |
string | no | "Submitted application (220)" |
En desuso. |
insertion_order_name |
string | no | "Mobile Insertion Order" |
Nombre del orden de inserción. |
insertion_order |
string | no | "Mobile Insertion Order (321)" |
En desuso. |
segment_code |
string | no | "Mobile Insertion Order Code" |
Código personalizado (opcional) asociado al segmento de usuario presente para esta impresión. |
pixel_id |
Entero | sí | 1942 |
Número de identificación único del píxel de conversión. Nota: Esta dimensión devolverá un máximo de 10 píxeles de conversión. Además, puede filtrar por no más de 10 píxeles de conversión. Aunque pixel_id es agrupable, no se recomienda agrupar por esta dimensión, ya que si lo hace, los eventos de conversión se mostrarán en filas independientes de los eventos de impresión y clic. Por lo general, se supone que desea ver todos estos eventos en una sola fila para poder recuperar valores precisos y agregados para los cálculos de tasa de conversión y costo por conversión. Como resultado, se recomienda filtrar por pixel_id para poder recuperar recuentos de conversiones y métricas relacionadas para los identificadores de píxeles más relevantes. |
gender |
string | sí | "m" , "f" , "u" |
El sexo del usuario. Nota: En el caso de las impresiones anteriores a 100 días, el género será "u" . |
age_bucket |
string | sí | "18-24 , "45-54" |
Cubo de antigüedad en el que está contenido el usuario. Para obtener más información, consulte Age Bucket a continuación. |
age_bucket_id |
Entero | sí | 1 , 3 , 0 |
Identificador del cubo de edad. Para obtener más información, consulte Age Bucket a continuación. |
Depósito de edad
Id. de bucket | Nombre del cubo |
---|---|
0 |
"unknown" |
1 |
"13-17" |
2 |
"18-24" |
3 |
"25-34" |
4 |
"35-44" |
5 |
"45-54" |
6 |
"55-64" |
7 |
"65+" |
Métricas
Column | Tipo | Ejemplo | Fórmula | Description |
---|---|---|---|---|
imps |
Entero | 34534 |
Duendes | Número total de impresiones (incluidos los valores predeterminados). |
clicks |
Entero | 345 |
Clics | Número total de clics en todas las impresiones. |
total_convs |
Entero | 5 |
total_convs | Número total de conversiones posteriores y posteriores al clic. |
convs_rate |
double | 0.000221877080097626 |
total_convs/imps | Tasa de conversiones a impresiones. |
ctr |
double | 0.002327 |
clics o imps | Tasa de clics en impresiones. |
booked_revenue |
Dinero | 450.00 |
post_view_revenue + post_click_revenue | Los ingresos totales reservados a través de anunciantes directos. |
booked_revenue_buying_currency |
Dinero | 145.00 |
(post_view_revenue + post_click_revenue) en moneda de compra | Los ingresos totales reservados a través de anunciantes directos expresados en moneda de compra. |
post_view_convs |
Entero | 15 |
post_view_convs | Número de conversiones posteriores a la vista. |
post_view_revenue |
Dinero | 150.00 |
post_view_revenue | Ingresos de anunciantes por conversiones posteriores a la vista. |
post_click_convs |
Entero | 10 |
post_click_convs | Número de conversiones posteriores al clic que se han producido. |
post_click_revenue |
Dinero | 300.00 |
post_click_revenue | Ingresos de anunciantes por conversiones posteriores al clic. |
post_view_convs_rate |
double | 0.00013 |
post_view_convs/imps | Tasa de conversiones posteriores a la vista en impresiones. |
post_click_convs_rate |
double | 0.0002 |
post_click_convs/imps | Tasa de conversiones posteriores al clic en impresiones. |
spend |
Dinero | 304.36 |
gastar | El gasto total del vendedor en medios directos y en tiempo real compra para este segmento. |
media_cost |
Dinero | 100.00 |
media_cost | Costo total del inventario comprado. |
cpm |
Dinero | 5.00 |
media_cost /imps * 1000 | El costo por cada mil impresiones. |
revenue_ecpm |
Dinero | 1.9221 |
(booked_revenue/impresiones) x 1000 | Ingresos totales por 1000 impresiones. |
profit |
Dinero | 4.14 |
booked_revenue: total_cost | Ingresos reservados menos costo total. |
profit_ecpm |
Dinero | 0.4949 |
(booked_revenue - total_cost)/imps * 1000 | Beneficio (definido como ingresos reservados menos costo total) por cada 1000 impresiones. |
revenue_ecpc |
Dinero | 0.8256 |
booked_revenue/clics | Ingresos totales por clic. |
revenue_ecpa |
Dinero | 5.00 |
booked_revenue/total_convs | Ingresos totales por conversión. |
cost_ecpc |
Dinero | 0.1834 |
media_cost/clics | Costo por clic. |
cost_ecpa |
Dinero | 1.1111 |
media_cost/total_convs | Costo por adquisición o conversión. |
commissions |
Dinero | 0 |
Comisiones para artículos de línea estándar, 0 USD para LASI. | Tarifas que provienen de los ingresos reservados. |
serving_fees |
Dinero | 0.025143 |
Tarifas de servicio para artículos de línea estándar, $0 para ALIs. | Tarifas que se agregan al costo de los medios. |
convs_per_mm |
double | 384.4 |
(total_convs/imps) * 1000 000 | Número de conversiones por millón de impresiones. |
partner_fees |
Dinero | 123.45 |
partner_fees | El importe total de los costos de terceros, presupuestados mediante el Servicio de tarifas de asociados, que se han acumulado en un artículo de línea aumentada durante el período de tiempo notificado. |
total_cost |
Dinero | 123.45 |
total_cost = media_cost + data_costs + partner_fees + comisiones + serving_fees + publisher_revenue | 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. Nota: Hemos agregado lógica para evitar el doble recuento de cuotas de terceros durante el período de cambio importante (6 de agosto después del período de cambio importante). |
total_cost_ecpm |
Dinero | 123.45 |
(total_cost/imps) * 1000 | Costo total por 1000 imps. |
total_cost_ecpc |
Dinero | 123.45 |
total_cost/clics | Costo total por clic. |
total_cost_ecpa |
Dinero | 123.45 |
total_cost/conversiones | Costo total por conversión. |
profit_ecpc |
Dinero | 123.45 |
(booked_revenue - total_cost)/clicks | Beneficio por clic. |
profit_ecpa |
Dinero | 123.45 |
(booked_revenue - total_cost)/conversiones | Beneficio por conversión. |
profit_margin |
Dinero | 123.45 |
(booked_revenue - total_cost)/booked_revenue | Margen de ganancia del comprador. |
video_skips |
Entero | 10 |
video_skips | Número total de veces que un usuario omitió el vídeo. Use esta métrica para informar al comprar inventario omitible. |
video_starts |
Entero | 11 |
video_starts | El número total de veces que se descargó e inició el primer segmento de la creatividad de vídeo. |
video_25_pcts |
Entero | 10 |
video_25_pcts | El número total de veces que las creatividades de vídeo completaron el 25 % de toda la duración. |
video_50_pcts |
Entero | 10 |
video_50_pcts | El número total de veces que las creatividades de vídeo completaron el 50 % de toda la duración. |
video_75_pcts |
Entero | 10 |
video_75_pcts | El número total de veces que las creatividades de vídeo completaron el 75 % de toda la duración. |
video_completions |
Entero | 12 |
video_completions | El número total de veces que las creatividades de vídeo se reproducen durante todo el tiempo. |
video_served |
Entero | 10 |
video_served | El número total de respuestas de vídeo que se han servido al reproductor. Una respuesta de anuncio se produce cuando se proporciona el documento VAST (XML) en respuesta a una solicitud. Una respuesta de anuncio no indica necesariamente una impresión correcta. Para una impresión, el primer fotograma del vídeo debe ser servido. |
video_errors |
Entero | 2 |
video_errors | Número total de veces que se produjo un error de vídeo. |
revenue_per_video_complete |
Dinero | 25.76 |
revenue_per_video_complete | Ingresos por finalización de vídeo. |
cost_per_video_complete |
Dinero | 22.76 |
cost_per_video_complete | Costo por finalización de vídeo. |
video_completion_rate |
double | 1.12359550561797% |
(finalizaciones de vídeo/total de impresiones) x 100 | Relación entre las finalizaciones de vídeo y las impresiones, expresada como un porcentaje. |
video_start_rate |
double | 1.12359550561797% |
video_start_rate | Porcentaje de veces que se descargó e inició el primer segmento de la creatividad de vídeo. |
video_skip_rate |
double | 1.12359550561797% |
video_skip_rate | Porcentaje de veces que el usuario optó por omitir el vídeo. |
Ejemplos
Create la solicitud de informe JSON
El archivo JSON debe incluir el report_type
de "buyer_segment_performance"
, 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
, excel
o html
). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.
$ cat buyer_segment_performance
{"report":
{
"format": "csv",
"report_interval": "yesterday",
"row_per": ["campaign_id"],
"columns": ["campaign_id", "segment_id", "advertiser_id", "advertiser_name","line_item_id"],
"report_type": "buyer_segment_performance"
}
}
POST
la solicitud al servicio de informes
POST
la solicitud JSON para recuperar un identificador de informe.
$ curl -b cookies -c cookies -X POST -d @buyer_segment_performance "https://api.appnexus.com/report"
{
"response":{
"status":"OK",
"report_id":"71816ec6d09b32a5140730afe5cf6af5"
}
}
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 -c cookies 'https://api.appnexus.com/report?id=71816ec6d09b32a5140730afe5cf6af5'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2014-11-19 21:15:10",
"json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"yesterday\",\"row_per\":[\"campaign_id\"],\"columns\":[\"campaign_id\",\"segment_id\",\"advertiser_id\",\"advertiser_name\",\"line_item_id\"],\"report_type\":\"buyer_segment_performance\",\"filters\":[{\"member_id\":\"1234\"}]}}",
"url": "report-download?id=71816ec6d09b32a5140730afe5cf6af5"
},
"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 -c cookies 'https://api.appnexus.com/report-download?id=71816ec6d09b32a5140730afe5cf6af5' > /tmp/buyer_segment_performance.csv
Nota:
Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.