Api de plataforma digital: informe de Análisis del conservador
Nota:
Este informe solo está disponible para los conservadores.
El informe de análisis de conservadores proporciona a los conservadores información sobre cómo fluye el dinero de la demanda a la oferta dentro de su marketplace mantenido.
Para obtener instrucciones sobre cómo recuperar un informe, vea 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:
- last_hour
- hoy
- yesterday
- month_to_date
- last_month
- Vida
Período de retención de datos
Los datos de este informe se conservan durante 1100 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.
Intervalos de tiempo, incluidas las fechas que se producen hace más de 45 días
Si crea informes de Curator Analytics con el report_interval conjunto en "lifetime", el informe (independientemente de las métricas incluidas) se agregará a una cola especial para los informes que consumen muchos recursos. Como resultado, el informe puede tardar más de lo habitual en completarse. Además, estos informes que consumen muchos recursos pueden producir un error, debido a la cantidad de datos que se solicitan, antes de completarse. Si el informe no se completa, recibirá una notificación. Si se produce un error en la solicitud de informe o se elimina, puede hacer lo siguiente:
- vuelva a ejecutar el informe más adelante.
- use un tipo de informe distinto de
curator_analytics. - modifique la forma de estructurar los informes (si es posible) para que no incluyan fechas mayores que hace 45 días.
Dimensions
| Column | Tipo | ¿Filtro? | Ejemplo | Descripción |
|---|---|---|---|---|
bidder_id |
Entero | Yes | 456 |
Id. del pujador que compró en la transacción |
bidder_name |
string | No | "That Bidder" |
Nombre del postor que compró en la transacción |
billing_currency |
string | Sí | "USD" |
La moneda Xandr factura al conservador en |
brand_id |
Entero | Yes | 1234 |
Id. de marca asociado a la creatividad que sirvió en la oferta seleccionada |
brand_name |
string | No | "That Brand" |
Nombre de marca asociado a la creatividad que sirvió en la oferta seleccionada |
buyer_member |
string | No | "That Buyer (789)" |
Nombre del miembro del comprador que compró en la transacción con su id. de miembro entre corchetes |
buyer_member_id |
Entero | Yes | 789 |
Id. de miembro del comprador que compró en la transacción |
buyer_member_name |
string | No | "That Buyer" |
Nombre del miembro del comprador que compró en la transacción |
curated_deal |
string | No | "My Deal Name (123)" |
Nombre de la oferta curada con su identificador de transacción entre corchetes |
curated_deal_advertiser_id |
Entero | Yes | 123 |
Id. de anunciante del objeto de miembro del conservador que posee el elemento de línea de oferta asociado a la oferta seleccionada |
curated_deal_advertiser_name |
string | No | "That Advertiser" |
Nombre del anunciante del objeto de miembro del conservador que posee el elemento de línea de oferta asociado a la oferta seleccionada |
curated_deal_id |
Entero | Yes | 123 |
Identificador de la oferta curada |
curated_deal_insertion_order_id |
Entero | Yes | 123 |
Identificador de pedido de inserción del objeto miembro del conservador que posee el elemento de línea de transacción asociado a la oferta seleccionada |
curated_deal_line_item_id |
Entero | Yes | 123 |
Id. de elemento de línea del objeto miembro del conservador que posee el elemento de línea de transacción asociado a la oferta seleccionada |
curated_deal_insertion_order_name |
string | No | "IO Name" |
Nombre de pedido de inserción del objeto miembro del conservador que posee el elemento de línea de transacción asociado a la oferta seleccionada |
curated_deal_line_item_name |
string | No | "My Curated LI" |
Nombre del elemento de línea del objeto miembro del conservador que posee el elemento de línea de transacción asociado a la oferta seleccionada |
curated_deal_name |
string | No | "My Deal Name" |
Nombre de la oferta curada |
curator_margin_type |
Entero | No | "Percent" |
Tipo de margen (si un conservador tiene un margen asociado al elemento de línea). Posibles valores: - "Unknown"- "Percent"- "CPM" |
curator_margin_type_filterable |
Entero | Yes | 1 |
Tipo de margen filtrable (si un conservador tiene un margen asociado al elemento de línea). Posibles valores:0 (Desconocido)1 (Porcentaje)2 (CPM) |
curator_member |
string | No | "My Account (123)" |
Nombre de miembro de la cuenta del conservador con su identificador de miembro entre corchetes |
curator_member_id |
Entero | Yes | 123 |
Id. de miembro de la cuenta del conservador |
curator_member_name |
string | No | "My Account" |
Nombre de miembro de la cuenta del conservador |
day |
date | Yes | "2020-02-01" |
El día de la subasta |
device_type |
string | Sí | "desktops & laptops" |
Tipo de dispositivo en el que se ha servido la impresión. Los posibles valores son: - "desktops & laptops"- "tablets"- "mobile phones"- "tv"- "game consoles"- "set top box"- "media players"- "other devices" |
geo_country |
string | Sí | "US" |
El país en el que se produjo la impresión. En el caso de las solicitudes de impresión para las que Xandr no recibió ninguna indicación de que el anuncio se representó (es decir, sin transacciones), no se proporciona información del país. |
hour |
date | Yes | "2020-02-01 06:00:00" |
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. |
media_type |
string | No | "banner" |
Tipo de medio asociado a la creatividad que sirvió en esta impresión. Los posibles valores son: - "banner"- "pop"- "interstitial"- "video"- "text"- "expandable"- "skin"- "facebook"- "image and text"- "high impact"- "native"- "audio"- "Unknown" |
member_currency |
string | Sí | "USD" |
Moneda asociada al asiento del miembro del conservador |
member_id |
Entero | Yes | 789 |
Id. de miembro de la cuenta del conservador |
mobile_application_id |
string | Sí | "343200656" (iOS) o"com.rovio.angrybirds"(Android) |
El identificador de aplicación móvil asociado a la creatividad que sirvió en esta impresión |
mobile_application_name |
string | No | "Angry Birds" |
El nombre de la aplicación móvil asociada a la creatividad que sirvió en esta impresión |
month |
date | Yes | "2020-02" |
El mes de la subasta |
placement |
string | No | "Ivillage 160x600 (456)" |
Nombre de ubicación del vendedor donde se ha servido la transacción seleccionada con el identificador de ubicación entre corchetes |
placement_group_id |
Entero | Yes | 4321 |
Identificador de grupo de selección de ubicación del vendedor donde se atendió la transacción seleccionada |
placement_group_name |
string | No | "Placement Group Name" |
Nombre del grupo de selección de ubicación del vendedor en el que se ha servido la transacción seleccionada |
placement_id |
Entero | Yes | 456 |
Id. de selección de ubicación del vendedor donde se atendió la transacción seleccionada |
placement_name |
string | No | "Ivillage 160x600" |
Nombre de ubicación del vendedor donde se ha servido la transacción seleccionada |
publisher_id |
Entero | Yes | 321 |
Id. del publicador del vendedor donde se atendió la transacción seleccionada |
publisher_name |
string | Sí | "Newscorp" |
Nombre del publicador del vendedor donde se atendió la transacción seleccionada |
seller_deal |
string | No | "That Seller Deal (6543)" |
El nombre de la oferta de vendedor que se incluye en una oferta seleccionada con el identificador de la oferta de vendedor entre corchetes Nota: Si procede, ya que no todas las ofertas seleccionadas incluirán una oferta de vendedor |
seller_deal_id |
Entero | Yes | 6543 |
El identificador de la oferta de vendedor que se incluye en una oferta seleccionada Nota: Si procede, ya que no todas las ofertas seleccionadas incluirán una oferta de vendedor |
seller_deal_name |
string | No | "That Seller Deal" |
El nombre de la oferta de vendedor que se incluye en una oferta seleccionada Nota: Si procede, ya que no todas las ofertas seleccionadas incluirán una oferta de vendedor |
seller_deal_type_id |
Entero | No | 2 |
El identificador del tipo de oferta de vendedor que se incluye en una oferta seleccionada, si procede. Los posibles valores son:1 (Subasta abierta)2 (Subasta privada) |
seller_deal_type_name |
string | Sí | "Private Marketplace" |
El nombre del tipo de oferta de vendedor que se incluye en una oferta seleccionada, si procede. Los posibles valores son: - "---" (Subasta abierta)- "Private Marketplace" (Subasta privada) |
seller_member_id |
Entero | Yes | 4567 |
Id. de miembro del vendedor donde se atendió la transacción seleccionada |
seller_member_name |
string | No | "That Seller" |
Nombre del miembro del vendedor donde se ha servido la transacción seleccionada |
site_domain |
string | No | "bestsiteever.com" |
Dominio o aplicación del sitio donde se atendió la transacción seleccionada |
size |
string | Sí | "320x50" |
Tamaño de la creatividad |
video_context |
string | Sí | "pre-roll" |
El tipo de formato de vídeo en el que se sirve la transacción seleccionada. Los posibles valores son: - "unknown"- "pre-roll"- "mid-roll"- "post-roll"- "outstream" |
video_content_duration |
string | Sí | "Short-Form" |
Longitud del contenido en segundos (dos opciones: corta (menos de 480 s), larga (más de 480s)). |
content_delivery_type |
string | Sí | "VOD" |
Tipo de entrega de contenido de streaming. |
video_content_genre |
string | Sí | "Action" |
El género principal del programa en el que se reproducirá el anuncio. |
video_program_type |
string | Sí | "Movie" |
Categorización de nivel superior del programa en el que se reproducirá el anuncio. |
video_content_rating |
string | Sí | "Children(7+)" |
Tipo de clasificación del contenido. |
Métricas
Nota:
Las métricas de clics están disponibles para las impresiones compradas a través de Microsoft Invest. Las métricas de vídeo están disponibles para las impresiones compradas a través de cualquier DSP.
| Column | Tipo | Ejemplo | Fórmula | Description |
|---|---|---|---|---|
curator_margin |
Dinero | 2.57676 |
curator_margin | El beneficio que obtiene un conservador en una transacción Nota: Cuando se toma como porcentaje, el margen del conservador se calcula en función de los ingresos del conservador. |
curator_net_media_cost |
Dinero | 20.6138056 |
curator_revenue - curator_margin - curator_tech_fees | La cantidad de gasto que un conservador envía a los vendedores de intercambios, neta de cuotas y márgenes del conservador, si procede. Esto es lo mismo que los ingresos brutos del vendedor, incluidos los honorarios del vendedor. |
curator_revenue |
Dinero | 25.767257 |
curator_revenue | La cantidad de gasto que un comprador envía al conservador, neta de los honorarios del comprador, si procede. Esto es lo mismo que el costo de medios del comprador, exclusivo de los honorarios del comprador. |
curator_tech_fees |
Dinero | 2.5767257 |
curator_tech_fees | Las tarifas que Xandr cobra a un conservador en una transacción |
curator_total_cost |
Dinero | 23.1905313 |
curator_revenue: curator_margin | La cantidad de gasto que un conservador envía a los vendedores de intercambio y de intercambio, neta de margen de conservador, pero bruto de las tasas del conservador |
imps |
Entero | 2340 |
Duendes | Número de impresiones entregadas |
viewdef_viewed_imps |
Entero | 1638 |
viewdef_viewed_imps | El número de impresiones medidas que eran visibles, según la definición de visibilidad del comprador |
viewdef_view_rate |
double | 0.70 |
viewdef_view_rate | El número de impresiones medidas que eran visibles, según la definición de visibilidad del comprador, divididas por el número de impresiones medidas |
viewed_imps |
Entero | 1872 |
viewed_imps | El número de impresiones medidas que se pudieron ver, según la definición de visualización de IAB, que indica que una impresión es visible si el 50 % de los píxeles están en vista durante 1 segundo consecutivo |
view_measurable_imps |
Entero | 172 |
view_measurable_imps | Número total de impresiones que se midieron para la visibilidad. |
clicks |
Entero | 7 |
Clics | Número total de clics en todas las impresiones. Para Microsoft Invest, se admiten los clics de todos los tipos de medios. En el caso de los DSP externos, solo se admiten los clics de tipos multimedia nativos y de vídeo. |
ctr |
double | 0.3 |
clics o imps | Proporción de clics frente a imps. |
buyer_cpc |
Dinero | 3.68 |
curator_revenue/clics | Ingresos del conservador divididos por clics. |
video_errors |
Entero | 45 |
video_errors | Número total de veces que se produjo un error. |
video_starts |
Entero | 2335 |
video_starts | El número total de veces que se descargó e inició el primer segmento de la creatividad de vídeo. |
video_start_rate |
double | 0.99786 |
video_starts/imps | Proporción de inicios de vídeo frente a imps. |
video_skips |
Entero | 12 |
video_skips | Número total de veces que un usuario omitió el vídeo. |
video_skip_rate |
double | 0.0051282 |
video_skips/imps | Proporción de saltos de vídeo frente a imps. |
video_25_pcts |
Entero | 2100 |
video_25_pcts | El número total de veces que el vídeo completó el 25 % de toda la duración. |
video_50_pcts |
Entero | 2000 |
video_50_pcts | El número total de veces que el vídeo completó el 50 % de toda la duración. |
video_75_pcts |
Entero | 1900 |
video_75_pcts | El número total de veces que el vídeo completó el 75 % de toda la duración. |
video_completions |
Entero | 1800 |
video_completions | El número total de veces que se reproduce el vídeo durante toda la duración. |
video_completion_rate |
double | 0.76923 |
video_completions/imps | Proporción de finalizaciones de vídeo frente a imps. |
buyer_cost_per_video_complete |
Dinero | 0.014315 |
curator_revenue/video_completions | Ingresos del conservador divididos por finalizaciones de vídeo. |
buyer_cpm |
Dinero | 11.01164 |
curator_revenue/imps * 1000 | Ingresos del conservador divididos por imps expresados como un CPM. |
Ejemplo
Create una solicitud de informe con formato JSON
El archivo JSON debe incluir el report_type de "curator_analytics", así como ( columns 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 curator_analytics
{
"report": {
"columns": [
"hour",
"buyer_member_name",
"curated_deal",
"imps",
"curator_revenue",
"curator_margin"
],
"format": "csv",
"report_interval": "today",
"report_type": "curator_analytics"
}
}
POST la solicitud al servicio de informes
$ curl -b cookies -X POST -d @curator_analytics 'https://api.appnexus.com/report'
{
"response":{
"status":"OK",
"report_id":"6b177543a9411ffa67b09bdf5e76cac1"
}
}
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=6b177543a9411ffa67b09bdf5e76cac1'
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2020-08-25 13:03:37",
"json_request":"{\"report\":{\"report_type\":\"curator_analytics\",\"columns\":[\"hour\",\"buyer_member_name\",\"curated_deal\",\"imps\",\"curator_revenue\",\"curator_margin\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"member_id\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
"url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
},
"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=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/curator_analytics.csv
Nota:
Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.