API de plataforma digital: métricas de ofertas de comprador
El informe Métricas de la oferta de comprador proporciona información clave sobre las métricas de las ofertas, el rendimiento y los motivos de rechazo que son relevantes para los compradores.
Para obtener instrucciones sobre cómo recuperar un informe, consulte Report Service o el ejemplo siguiente.
Período de tiempo
El report_interval campo de la solicitud JSON se puede establecer en uno de los siguientes:
- yesterday
- last_2_days
- last_7_days (sin incluir hoy)
- 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 30 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 | ¿Filtro? | Descripción |
|---|---|---|
ask_price |
Sí | El precio de la oferta. |
deal_alias |
No | Nombre asignado a una oferta por un comprador con convenciones de nomenclatura específicas del comprador que suele ser propiedad de un vendedor. |
deal_auction_type_name |
Sí | Tipo de subasta de la oferta. Una oferta puede tener los siguientes tipos de subasta: primer precio, segundo precio y precio fijo. |
deal_id |
Yes | Identificador de la transacción asociada a la transacción para la impresión. |
deal_name |
Yes | Trato asociado a la transacción para la impresión. |
deal_type_name |
Yes | Tipo de oferta para una oferta determinada. Las opciones de tipo de oferta son Subasta abierta, Subasta privada, Curado, Primer aspecto o Garantizado mediante programación. |
end_date |
Yes | El día y la hora en que la oferta deja de estar disponible para el comprador. |
line_item_id |
Yes | Identificador del elemento de línea. |
package_id |
Yes | El identificador del paquete, si la oferta está asociada a un paquete. Valor entero del paquete desde el que se creó la oferta. Este valor será 0 si la oferta no se creó a partir de un paquete. |
priority |
Yes | Solo para una subasta privada, la prioridad que el vendedor asignó a la oferta. |
seller_member_id |
Yes | El identificador del vendedor que vendió la oferta. |
seller_member_name |
Yes | El vendedor que vendió la oferta. |
start_date |
Yes | El día y la hora en que la oferta comienza a estar disponible para el comprador. |
Métricas
| Column | Tipo | ¿Filtro? | Descripción |
|---|---|---|---|
ask_price |
divisa | Yes | El precio de la oferta |
bid_rate |
Entero | Yes | La tasa de pujas en el trato. |
bid_requests |
Entero | Yes | Número de solicitudes de puja. |
bids |
Entero | Yes | Número de ofertas completadas. |
buyer_media_cost |
divisa | Yes | El costo total para el comprador. |
buyer_cost_ecpm |
Entero | Yes | El costo de la oferta al comprador en eCPM. |
buyer_member_id |
Entero | Yes | Identificador del miembro de compra. Si no se compró la impresión, este campo muestra uno de los siguientes valores: 229 = PSA, 0 = Blank o 319 = Default. |
buyer_member_name |
string | No | Nombre del miembro que compra. Nota: El nombre podría ser "Default" o "Default Error", lo que significa que no había ningún comprador para la impresión y se sirvió una creatividad predeterminada. |
day |
time | No | El día de la subasta. |
deal_type_name |
string | Sí | Tipo de oferta para una oferta determinada. Las opciones de tipo de oferta son Subasta abierta, Subasta privada, Curado, Primer aspecto o Garantizado mediante programación. |
gross_win_rate |
Entero | Yes | La tasa bruta de ganancias para el trato. |
hour |
time | No | La hora de la subasta. Nota: En el caso de las impresiones anteriores a 100 días, el día se devolverá en lugar de la hora. |
imps_matched |
Entero | Yes | El número total de impresiones que coinciden con la configuración del vendedor (no la del comprador) en la oferta. |
imps_won |
Entero | Yes | Número total de impresiones ganadas. |
ineligible_bid_rate |
Entero | Yes | La tasa de ofertas inelegibles en el acuerdo. |
month |
time | No | El mes de la subasta. |
net_win_rate |
Entero | Yes | La tasa neta de ganancias de la oferta. |
reject_below_floor_count |
Entero | Yes | El número de ofertas rechazadas porque están por debajo del precio de reserva establecido en la subasta. |
reject_below_floor_ym_count |
Entero | Yes | El número de ofertas rechazadas porque están por debajo del límite de rendimiento establecido para la oferta. |
reject_bidder_error_count |
Entero | Yes | Número de ofertas rechazadas debido a errores del licitador. |
reject_bidder_error_deal_not_available_count |
Entero | Yes | Número de ofertas rechazadas porque la oferta ya no estaba disponible. |
reject_blocked_by_ad_profile_adserver_count |
Entero | Sí | Número de pujas rechazadas porque se bloquea un servidor de anuncios asociado a la creatividad con la que puja el comprador. |
reject_blocked_by_ad_profile_audit_status_count |
Entero | Yes | Número de pujas bloqueadas por el perfil de anuncio debido a su estado de auditoría. Esto suele ocurrir cuando el comprador está pujando con una creatividad no auditada y el vendedor ha bloqueado las creatividades no auditadas en la calidad del anuncio. |
reject_blocked_by_ad_profile_brand_count |
Entero | Yes | Número de pujas bloqueadas por el perfil de anuncio debido a exclusiones de marca. |
reject_blocked_by_ad_profile_category_count |
Entero | Yes | Número de pujas rechazadas porque el perfil de anuncio no permite la categoría de la creatividad. |
reject_blocked_by_ad_profile_count |
Entero | Yes | La suma de todas las pujas rechazadas por el perfil de anuncio. |
reject_blocked_by_ad_profile_creative_count |
Entero | Yes | Número de pujas rechazadas porque el perfil de anuncio bloqueó el servidor de anuncios creativos. |
reject_blocked_by_ad_profile_language_count |
Entero | Yes | Número de pujas rechazadas porque el perfil del anuncio bloqueó el idioma del anuncio. |
reject_blocked_by_ad_profile_member_count |
Entero | Yes | Número de pujas rechazadas porque el perfil de anuncio bloqueó al miembro. |
reject_blocked_by_ad_profile_tech_attribute_count |
Entero | Yes | El número de pujas rechazadas porque el perfil del anuncio bloqueó un atributo técnico del anuncio. |
reject_blocked_by_deal_adserver_count |
Entero | Yes | Número de pujas bloqueadas debido a restricciones de adserver en la oferta. |
reject_blocked_by_deal_below_floor_count |
Entero | Yes | El número de ofertas rechazadas porque están por debajo del precio mínimo de la oferta. |
reject_blocked_by_deal_brand_count |
Entero | Yes | Número de ofertas rechazadas porque la oferta bloqueó su marca. |
reject_blocked_by_deal_category_count |
Entero | Yes | Número de ofertas rechazadas porque la oferta no permite la categoría de la creatividad. |
reject_blocked_by_deal_count |
Entero | Yes | La suma de todas las ofertas rechazadas debido a restricciones de la oferta. |
reject_blocked_by_deal_creative_count |
Entero | Yes | El número de ofertas bloqueadas por la oferta debido a su configuración de idioma. |
reject_blocked_by_deal_language_count |
Entero | Yes | El número de ofertas bloqueadas por la oferta debido a su configuración de idioma. |
reject_blocked_by_deal_media_subtype_count |
Entero | Yes | Número de ofertas rechazadas debido a sus subtipos multimedia. |
reject_blocked_by_deal_payment_type_count |
Entero | Yes | Número de pujas rechazadas porque la oferta no permitió su tipo de pago. |
reject_blocked_by_deal_size_count |
Entero | Yes | El número de ofertas rechazadas porque no coincidían con los requisitos de tamaño de la oferta. |
reject_blocked_by_deal_tech_attribute_count |
Entero | Yes | Número de ofertas rechazadas porque la oferta bloqueó un atributo técnico. |
reject_blocked_by_dynamic_adserver_count |
Entero | Yes | Número de ofertas rechazadas debido a restricciones de adserver que el vendedor ha pasado dinámicamente en el momento de la solicitud de impresión. |
reject_blocked_by_dynamic_brand_count |
Entero | Yes | Número de pujas rechazadas porque la solicitud de puja que ha pasado el vendedor bloquea dinámicamente la marca. |
reject_blocked_by_dynamic_category_count |
Entero | Yes | Número de ofertas rechazadas porque la solicitud de puja que ha pasado el vendedor bloquea dinámicamente la categoría creativa. |
reject_blocked_by_dynamic_language_count |
Entero | Yes | El número de ofertas rechazadas porque el idioma está bloqueado dinámicamente por la solicitud de puja pasada por el vendedor. |
reject_blocked_by_dynamic_tech_attribute_count |
Entero | Yes | El número de pujas rechazadas porque sus atributos techincal se bloquean dinámicamente mediante la solicitud de puja pasada por el vendedor. |
reject_count |
Entero | Yes | Número total de ofertas rechazadas. |
reject_invalid_creative_count |
Entero | Yes | Número de ofertas rechazadas debido a creatividades no válidas con las que el comprador puja. |
reject_invalid_creative_not_ssl_count |
Entero | Yes | El número de ofertas rechazadas debido a que la creatividad no está aprobada por SSL para una subasta segura. |
reject_other_advertiser_exclusion_count |
Entero | Yes | El número total de ofertas rechazadas debido a exclusiones de anunciantes que no se mencionan anteriormente. |
reject_other_count |
Entero | Yes | El número de ofertas rechazadas por razones que no se enumeran aquí. |
reject_other_data_protection_count |
Entero | Yes | Número total de ofertas rechazadas por motivos de seguridad de datos que no se enumeran aquí. |
submitted_bids |
Entero | Yes | Número de ofertas enviadas. |
Ejemplo
Creación de la solicitud de informe con formato JSON
El archivo JSON debe incluir , report_type"buyer_deal_metrics_report"así como las columnas (dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir granularidad (año, mes, día) 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_deal_metrics_report
{
"report":
{
"report_type":"buyer_deal_metrics_report",
"columns":[
"hour",
"seller_member_name",
"deal_name",
"start_date",
"end_date",
"bids",
"imps_won",
"reject_count",
"media_cost"
],
"report_interval":"last_7_days",
"format":"csv"
}
}
POST la solicitud al servicio de informes
$ curl -b cookies -X POST -d @buyer_deal_metrics_report 'https://api.appnexus.com/report'
{
"response":{
"status":"OK",
"report_id":"097f59fc3ab7d02c5d60db42081d9b69"
}
}
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=097f59fc3ab7d02c5d60db42081d9b69'
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2010-05-25 19:19:53",
"json_request":"{\"report\":{\"report_type\":\"buyer_deal_metrics_report\",\"columns\":[\"hour\",
\"buyer_member_name\",\"deal_name\",\"start_date\",\"end_date\",\"bids\",\"imps_won\",\"media_cost\"],
\"row_per\":[\"hour\",\"buyer_member_id\",\"deal_id\"],
\"report_interval\":\"last_7_days\"}}",
"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 servicio y el identificador de informe en el url campo 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.
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_deal_metrics_report.csv
Sugerencia
Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.