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? | Ejemplo | Descripción |
|---|---|---|---|---|
advertiser_id |
Entero | Yes | 3 |
El identificador del anunciante cuya creatividad se ha servido |
advertiser_name |
string | No | "Advertiser" |
El nombre del anunciante cuyo creativo fue servido |
buyer_member_id |
Entero | Sí | 210 |
El identificador de miembro del comprador |
campaign_id |
Entero | Sí | 728 |
El identificador de la campaña (no se aplica a todos los anunciantes) |
campaign_name |
string | No | "Test" |
El nombre de la creatividad (no se aplica a todos los anunciantes) |
creative_id |
Entero | Sí | 554 | Identificador de la creatividad que sirvió. - 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á "External Clicks" o "External Imps". |
creative_name |
string | No | "Q1 2010 728x90" |
El nombre de la creatividad que sirvió - Para impresiones anteriores a 14 meses, las creatividades se agregarán en una fila con "Todos los datos creativos anteriores a 14 meses" como nombre creativo. Nota: Para los rastreadores de clics o impresiones externos, creative_name será "External Clicks" o "External Imps". |
day |
date | Yes | "2012-08-23" |
El día en que se produjo la impresión |
deal_id |
Entero | Sí | 2345 |
Identificador de la oferta a la que está asociada la impresión que se ha servido. - Para obtener más información sobre las ofertas que ha negociado con los vendedores, consulte Deal Buyer Access Service. |
deal_name |
string | No | "Private deal for buyer 1085 with floor of $2.50" |
El nombre de la oferta a la que está asociada la impresión servida |
device_type |
string | Sí | "Mobile Phones" |
Tipo de dispositivo donde se produjo la impresión: - Desktops & Laptops - Tablets - Mobile Phones - TV - Game Consoles - Set Top Box - Media Players - Other Devices |
domain |
string | No | "bestsiteever.com (1536)" |
Dirección URL e identificador del dominio en el que se produjo la impresión |
domain_id |
Entero | No | 1536 |
Identificador del dominio en el que se produjo la impresión |
domain_name |
string | No | "bestsiteever.com" |
Dirección URL del dominio en el que se produjo la impresión |
imp_type |
string | Sí | "External Impression" |
El tipo de impresión que sirvió. Para obtener los valores posibles, vea imp_type_id. |
imp_type_id |
Entero | Yes | 3 |
Identificador del tipo de impresión que se ha proporcionado (tipos asociados entre paréntesis): - 1 ("Blank"): no se sirve creatividad- 2 ("PSA"): se sirvió un anuncio de servicio público porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible.- 3 ("Default Error"): una creatividad predeterminada que se sirve debido a un problema de tiempo de espera- 4 ("Default"): un creativo predeterminado servido porque no había ofertas válidas- 5 ("Kept"): la creatividad de su anunciante se ha servido en el sitio del publicador.- 6 ("Resold"): la impresión del publicador se vendió a un comprador de terceros- 7 ("RTB"): la creatividad de su anunciante se sirve en el inventario de terceros- 8 ("PSA Error"): un anuncio de servicio público servido debido a un problema de tiempo de espera o a la falta de una creatividad predeterminada- 9 ("External Impression"): una impresión de un rastreador de impresiones- 10 ("External Click"): un clic de un seguimiento de clics- 11 ("Insertion"): su creatividad se sirve en el inventario de terceros, donde se conserva entre las cargas de página y las sesiones. Este tipo de impresión es actualmente solo para creativos de Facebook News Feed. |
insertion_order_id |
Entero | No | 648359 |
Identificador del orden de inserción |
insertion_order_name |
string | No | "InsertionOrderABC" |
Nombre del orden de inserción |
line_item_id |
Entero | Yes | 947764 |
Identificador del elemento de línea que sirvió la impresión |
line_item_name |
string | No | "LineItemDEF" |
Nombre del elemento de línea que sirvió la impresión |
media_type |
string | No | "Banner" |
El estilo de visualización general de la creatividad que sirvió: - Banner - Interstitial - Video - Text - Expandable - Skin - Facebook |
mediatype_id |
Entero | Yes | 2 |
Identificador del tipo de medio que se ha proporcionado |
placement_id |
Entero | Yes | 546 |
Identificador de la ubicación en la que se ha servido la creatividad |
placement_name |
string | No | "300x250 Business" |
Nombre de la ubicación en la que se ha servido la creatividad |
publisher_id |
Entero | Yes | 374967 |
Identificador del publicador propietario del inventario |
publisher_name |
string | No | "Publisher XYZ" |
Nombre del publicador propietario del inventario |
seller_member_id |
Entero | Yes | 765 |
El identificador de miembro del vendedor que vendió la impresión |
seller_member_name |
string | No | "AdMeld" |
Nombre del vendedor que vendió la impresión. |
size |
string | Sí | "728x90" |
Tamaño de la creatividad que se sirvió |
split_id |
Entero | Yes | 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 | No | "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 . |
supply_type |
string | Sí | "mobile_web" |
Tipo de suministro (inventario) en el que se produjo la impresión: - Web - Mobile Web - Mobile App |
Métricas
| Column | Tipo | Ejemplo | Fórmula | Descripción |
|---|---|---|---|---|
average_viewable_duration |
sobras | 132297 |
Duración media visible = Duración total visible/Imps visible | El promedio de segundos para los que la creatividad estaba en vista según los criterios de visualización de IAB |
clicks |
Entero | 132297 |
N/D | Número total de clics del elemento de línea |
ctr |
double | 0.00067472306143 |
N/D | Tasa de clics: la proporción de clics con impresiones, expresada como un porcentaje |
imps |
Entero | 11080000 |
N/D | Número total de impresiones del elemento de línea |
total_viewable_duration |
sobras | 152.4298 |
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 | 0.0084979838709677 |
Tasa de finalización de vídeo = Finalización de vídeo / Total de impresiones | La relación entre las finalizaciones de vídeo y el total de impresiones, expresada como un porcentaje |
video_completions |
Entero | 10 |
N/D | El número total de creativos de vídeo reproducidos durante toda su duración |
view_measurable_imps |
Entero | 11080000 |
N/D | Número total de impresiones medidas para la visibilidad |
view_measurable_rate |
double | 0.00067472306143 |
Velocidad de medición de visualización = Visualización de imps o imps medibles | Porcentaje de impresiones medidas para la visualización del número total de impresiones |
view_rate |
double | 0.00067472306143 |
Tasa de visualización = Imps vistos/Visualización de imps medibles | El porcentaje de impresiones que se pudieron ver del número total de impresiones medidas para la visibilidad |
viewable_completion_rate |
double | 0.0084979838709677 |
Tasa de finalización visible = Impresiones de vídeo visibles y completadas/ Impresiones de vídeo medibles | La relación entre las finalizaciones de vídeo en vista y el total de impresiones, expresada como un porcentaje |
viewdef_view_rate |
double | 0.00067472306143 |
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 | 5.678014273984716 |
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 | 51.47677411571988 |
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