API de plataforma digital: informe de interacción del comprador
El informe de interacción del comprador le proporciona información sobre la duración visible de las creatividades de pantalla y vídeo.
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:
- costumbre
- yesterday
- last_7_days
- last_14_days
- month_to_yesterday
- last_30_days
Período de retención de datos
Los datos de este informe tienen una granularidad de tiempo diario y se conservan durante cinco semanas. Este informe también muestra los datos en la zona horaria UTC/GMT.
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? | Descripción |
|---|---|---|---|
buyer_member_id |
Entero | Yes | Identificador del miembro de compra de las impresiones. |
seller_member_id |
Entero | Yes | Identificador del miembro vendedor. |
size |
string | Sí | El tamaño de la creatividad que se sirvió. |
seller_member_name |
string | No | Nombre del miembro vendedor. |
advertiser_id |
Entero | Yes | Identificador del objeto de anunciante asociado a las impresiones que se han notificado. |
advertiser_name |
string | No | Nombre del objeto de anunciante asociado a las impresiones que se han servido. |
line_item_id |
Entero | Yes | Identificador del artículo de línea con el que se compraron las impresiones. La jerarquía del lado de compra es Campaña de artículo de> línea. |
line_item_name |
string | No | Nombre del artículo de línea con el que se compraron las impresiones. La jerarquía del lado de compra es Campaña de artículo de> línea. |
campaign_id |
Entero | Yes | El identificador de la campaña que compró las impresiones. |
campaign_name |
string | No | Nombre de la campaña que compró las impresiones. |
imp_type |
Entero | Yes | Nombre del tipo de impresión que se produjo. |
imp_type_id |
Entero | Yes | El identificador para el tipo de impresión que se ha proporcionado (tipos asociados entre paréntesis): - 1 ("En blanco"): no se sirve creatividad - 2 ("PSA"): un anuncio de servicio público servido porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible - 3 ("Error predeterminado"): una creatividad predeterminada que se sirve debido a un problema de tiempo de espera - 4 ("Predeterminado"): una creatividad predeterminada que se sirve porque no había pujas válidas - 5 ("Kept"): la creatividad de su anunciante se ha servido en el sitio del editor. - 6 ("Reventa"): La impresión del editor se vendió a un comprador de terceros - 7 ("RTB"): La creatividad de su anunciante se ha servido en el inventario de terceros - 8 ("Error de PSA"): un anuncio de servicio público servido debido a un problema de tiempo de espera o a la falta de una creatividad predeterminada - 9 ("Impresión externa"): una impresión de un rastreador de impresiones - 10 ("Clic externo"): un clic de un rastreador de clics - 11 ("Inserción"): su creatividad se sirvió en el inventario de terceros, donde persiste en las cargas de página y las sesiones. Este tipo de impresión es actualmente solo para Facebook creativos de la fuente de noticias. |
insertion_order_id |
Entero | Yes | Identificador del pedido de inserción con el que se compraron las impresiones. La jerarquía del lado de compra es Campaña deartículos> de línea de pedido>de inserción. |
insertion_order_name |
string | No | Nombre del pedido de inserción con el que se compraron las impresiones. La jerarquía del lado de compra es Campaña deartículos> de línea de pedido>de inserción. |
publisher_id |
Entero | Yes | Identificador del objeto de publicador en el que se produjeron las impresiones en el inventario. |
publisher_name |
string | No | Nombre del objeto de publicador en el que se produjeron las impresiones en el inventario. |
placement_id |
Entero | Yes | El identificador de la colocación o la ranura abierta en el sitio web del anunciante donde se atendió la creatividad del anunciante con especificaciones coincidentes. |
placement_name |
string | No | El nombre de la ubicación o la ranura abierta en el sitio web del anunciante donde se atendió la creatividad del anunciante con especificaciones coincidentes. |
member_id |
Entero | Yes | Identificador del miembro para el que se genera el informe. |
creative_id |
Entero | No | El identificador del creativo servido para la impresión. En el caso de las impresiones anteriores a 14 meses, las creatividades se agregarán en una fila con 0 como identificador creativo. Nota: Para los rastreadores de clics o impresiones externos, creative_id serán "Clics externos" o "Imps externos". |
creative_name |
string | No | Nombre de la creatividad que sirve para la impresión. |
mediatype |
string | No | Nombre del tipo de medio asociado a la creatividad que sirvió en la impresión. |
mediatype_id |
Entero | Yes | Identificador del tipo de medio asociado a la creatividad que sirvió en la impresión. |
device_type |
string | Sí | Tipo de dispositivo en el que se ha servido la impresión. Posibles valores: - Equipos de escritorio & portátiles -Tabletas - Teléfonos móviles -TELEVISIÓN -Videojuegos - Establecer el cuadro superior - Reproductores multimedia - Otros dispositivos |
day |
date | Yes | El día de la subasta. |
operating_system_family_id |
Entero | Yes | Identificador de la familia de sistemas operativos asociada al dispositivo en el que se sirvió la impresión. |
operating_system_family_name |
string | No | Nombre de la familia del sistema operativo asociada al dispositivo en el que se sirvió la impresión. |
split_id |
Entero | Yes | 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. En el caso de los informes que contengan campañas, el split_id (si se incluye) será null. |
split_name |
string | No | 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. En el caso de los informes que contengan campañas, el split_id (si se incluye) será null. |
domain_id |
Identificador del dominio en el que se produjo la impresión. | ||
deal_id |
Identificador de la transacción con la que se asocia la impresión servida. Para obtener más información sobre las ofertas que ha negociado con los vendedores, consulte Deal Buyer Access Service. | ||
deal_name |
Nombre de la transacción con la que se asocia la impresión servida. | ||
supply_type |
Tipo de suministro (inventario) en el que se produjo la impresión: -Telaraña - Mobile Web - Aplicación móvil |
||
media_type_id |
Entero | Yes | Identificador de .media_type |
media_type |
string | No | El estilo de visualización general de la creatividad que sirvió: -Estandarte -Intersticial -Vídeo -Mensaje de texto -Ampliable -Piel |
Métricas
| Column | Tipo | Fórmula | Descripción |
|---|---|---|---|
imps |
Entero | N/D | Número total de impresiones. |
clicks |
Entero | N/D | Número total de clics. |
ctr |
double | clics o imps | Tasa de clics: la proporción de clics con impresiones, expresada como un porcentaje |
average_viewable_duration |
double | Duración total visible/Imps visibles | El promedio de segundos para los que la creatividad estaba en vista según los criterios de visualización de IAB. |
total_viewable_duration |
Entero | N/D | Número total de segundos para los que la creatividad estaba en vista según los criterios de visualización de IAB. |
video_completion_rate |
double | Tasa de finalización de vídeo = Finalización de vídeo/Total de impresiones | Relación entre las finalizaciones de vídeo y el total de impresiones, expresada como un porcentaje. |
video_completions |
Entero | N/D | El número total de creativos de vídeo reproducidos durante toda su duración |
view_measurable_imps |
Entero | N/D | Número total de impresiones medidas para la visibilidad |
view_measurable_rate |
double | Ver imps o imps medibles | Porcentaje de impresiones medidas para la visibilidad del número total de impresiones. |
view_rate |
double | Imps/View Measurable Imps | Porcentaje de impresiones que se pudieron ver del número total de impresiones medidas para la visibilidad. |
viewable_completion_rate |
double | Impresiones de vídeo visibles y completadas/impresiones de vídeo medibles | Relación entre las finalizaciones de vídeo a la vista y el total de impresiones, expresada como un porcentaje. |
viewdef_view_rate |
double | N/D | Porcentaje de impresiones que se pueden ver, según la configuración de definición personalizada de nivel de miembro, del número total de impresiones medidas para la visualización |
viewdef_viewed_imps |
Entero | N/D | Número de impresiones medidas que se pueden ver, según la configuración de definición personalizada de nivel de miembro (para obtener más información, póngase en contacto con el representante de la cuenta de Xandr) |
viewed_imps |
Entero | N/D | El número total de impresiones que se consideraron 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) debe ser visible para un espectador en su pantalla. |
Ejemplo
Creación de la solicitud de informe con formato JSON
El archivo JSON debe incluir , report_type"engagement_report_for_buyers"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 engagement_report_for_buyers
{
"report":
{
"report_type":"engagement_report_for_buyers",
"columns":[
"line_item_id",
"line_item_name",
"creative_name",
"viewable_completion_rate",
"average_viewable_duration",
"ctr",
"clicks",
"imps"
],
"report_interval":"last_7_days",
"format":"csv"
}
}
POST la solicitud al servicio de informes
$ curl -b cookies -c cookies -X POST -d @engagement_report_for_buyers '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 -c cookies 'https://api.appnexus.com/report?id=097f59fc3ab7d02c5d60db42081d9b69'
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2021-05-25 19:19:53",
"json_request":"{\"report\":{\"report_type\":\"engagement_report_for_buyerss\",\"columns\":[\"line_item_id\",
\"line_item_name\",\"creative_name\",\"viewable_completion_rate\",\"average_viewable_duration\",\"ctr\",\"clicks\",\"imps\"],
\"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 -c cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/engagement_report_for_buyers.csv